Class CommandGetPrimaryKeys
Represents a request to retrieve the primary keys of a table on a Flight SQL enabled backend. 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, table_name: utf8 not null, column_name: utf8 not null, key_name: utf8, key_sequence: int32 not null
The returned data should be ordered by catalog_name, db_schema_name, table_name, key_name, then key_sequence.
public sealed class CommandGetPrimaryKeys : IMessage<CommandGetPrimaryKeys>, IEquatable<CommandGetPrimaryKeys>, IDeepCloneable<CommandGetPrimaryKeys>, IBufferMessage, IMessage
- Inheritance
-
CommandGetPrimaryKeys
- Implements
-
IMessage<CommandGetPrimaryKeys>IDeepCloneable<CommandGetPrimaryKeys>IBufferMessageIMessage
- Inherited Members
- Extension Methods
Constructors
CommandGetPrimaryKeys()
public CommandGetPrimaryKeys()
CommandGetPrimaryKeys(CommandGetPrimaryKeys)
public CommandGetPrimaryKeys(CommandGetPrimaryKeys other)
Parameters
other
CommandGetPrimaryKeys
Fields
CatalogFieldNumber
Field number for the "catalog" field.
public const int CatalogFieldNumber = 1
Field Value
DbSchemaFieldNumber
Field number for the "db_schema" field.
public const int DbSchemaFieldNumber = 2
Field Value
TableFieldNumber
Field number for the "table" field.
public const int TableFieldNumber = 3
Field Value
Properties
Catalog
Specifies the catalog to search for the table. 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
DbSchema
Specifies the schema to search for the table. An empty string retrieves those without a schema. If omitted the schema name should not be used to narrow the search.
public string DbSchema { get; set; }
Property Value
Descriptor
public static MessageDescriptor Descriptor { get; }
Property Value
- MessageDescriptor
HasCatalog
Gets whether the "catalog" field is set
public bool HasCatalog { get; }
Property Value
HasDbSchema
Gets whether the "db_schema" field is set
public bool HasDbSchema { get; }
Property Value
Parser
public static MessageParser<CommandGetPrimaryKeys> Parser { get; }
Property Value
- MessageParser<CommandGetPrimaryKeys>
Table
Specifies the table to get the primary keys for.
public string Table { get; set; }
Property Value
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()
ClearDbSchema()
Clears the value of the "db_schema" field
public void ClearDbSchema()
Clone()
Creates a deep clone of this object.
public CommandGetPrimaryKeys Clone()
Returns
- CommandGetPrimaryKeys
A deep clone of this object.
Equals(CommandGetPrimaryKeys)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(CommandGetPrimaryKeys other)
Parameters
other
CommandGetPrimaryKeysAn object to compare with this object.
Returns
Equals(object)
Determines whether the specified object is equal to the current object.
public override bool Equals(object other)
Parameters
other
object
Returns
GetHashCode()
Serves as the default hash function.
public override int GetHashCode()
Returns
- int
A hash code for the current object.
MergeFrom(CommandGetPrimaryKeys)
Merges the given message into this one.
public void MergeFrom(CommandGetPrimaryKeys other)
Parameters
other
CommandGetPrimaryKeys
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
CodedOutputStreamCoded output stream to write the data to. Must not be null.