Class CommandGetDbSchemas

Namespace

Arrow.Flight.Protocol.Sql

Assembly

Apache.Arrow.Flight.Sql.dll

Represents a request to retrieve the list of database schemas on a Flight SQL enabled backend. The definition of a database schema depends on vendor/implementation. It is usually a collection of tables. Used in the command member of FlightDescriptor for the following RPC calls:

• GetSchema: return the Arrow schema of the query.
• GetFlightInfo: execute the catalog metadata request.

The returned Arrow schema will be: < catalog_name: utf8, db_schema_name: utf8 not null

The returned data should be ordered by catalog_name, then db_schema_name.

public sealed class CommandGetDbSchemas : IMessage<CommandGetDbSchemas>, IEquatable<CommandGetDbSchemas>, IDeepCloneable<CommandGetDbSchemas>, IBufferMessage, IMessage

Inheritance

object

CommandGetDbSchemas

Implements

IMessage<CommandGetDbSchemas>

IEquatable<CommandGetDbSchemas>

IDeepCloneable<CommandGetDbSchemas>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

FlightSqlExtensions.Serialize(IBufferMessage)

Constructors

CommandGetDbSchemas()

public CommandGetDbSchemas()

CommandGetDbSchemas(CommandGetDbSchemas)

public CommandGetDbSchemas(CommandGetDbSchemas other)

Parameters

other CommandGetDbSchemas

Fields

CatalogFieldNumber

Field number for the "catalog" field.

public const int CatalogFieldNumber = 1

Field Value

int

DbSchemaFilterPatternFieldNumber

Field number for the "db_schema_filter_pattern" field.

public const int DbSchemaFilterPatternFieldNumber = 2

Field Value

int

Properties

Catalog

Specifies the Catalog to search for the tables. An empty string retrieves those without a catalog. If omitted the catalog name should not be used to narrow the search.

public string Catalog { get; set; }

Property Value

string

DbSchemaFilterPattern

Specifies a filter pattern for schemas to search for. When no db_schema_filter_pattern is provided, the pattern will not be used to narrow the search. In the pattern string, two special characters can be used to denote matching rules:

• "%" means to match any substring with 0 or more characters.
• "_" means to match any one character.

public string DbSchemaFilterPattern { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

HasCatalog

Gets whether the "catalog" field is set

public bool HasCatalog { get; }

Property Value

bool

HasDbSchemaFilterPattern

Gets whether the "db_schema_filter_pattern" field is set

public bool HasDbSchemaFilterPattern { get; }

Property Value

bool

Parser

public static MessageParser<CommandGetDbSchemas> Parser { get; }

Property Value

MessageParser<CommandGetDbSchemas>

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

ClearCatalog()

Clears the value of the "catalog" field

public void ClearCatalog()

ClearDbSchemaFilterPattern()

Clears the value of the "db_schema_filter_pattern" field

public void ClearDbSchemaFilterPattern()

Clone()

Creates a deep clone of this object.

public CommandGetDbSchemas Clone()

Returns

CommandGetDbSchemas

A deep clone of this object.

Equals(CommandGetDbSchemas)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(CommandGetDbSchemas other)

Parameters

other CommandGetDbSchemas

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CommandGetDbSchemas)

Merges the given message into this one.

public void MergeFrom(CommandGetDbSchemas other)

Parameters

other CommandGetDbSchemas

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.