Class CommandGetExportedKeys

Namespace

Arrow.Flight.Protocol.Sql

Assembly

Apache.Arrow.Flight.Sql.dll

Represents a request to retrieve a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table) 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: < pk_catalog_name: utf8, pk_db_schema_name: utf8, pk_table_name: utf8 not null, pk_column_name: utf8 not null, fk_catalog_name: utf8, fk_db_schema_name: utf8, fk_table_name: utf8 not null, fk_column_name: utf8 not null, key_sequence: int32 not null, fk_key_name: utf8, pk_key_name: utf8, update_rule: uint8 not null, delete_rule: uint8 not null

The returned data should be ordered by fk_catalog_name, fk_db_schema_name, fk_table_name, fk_key_name, then key_sequence. update_rule and delete_rule returns a byte that is equivalent to actions declared on UpdateDeleteRules enum.

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

Inheritance

object

CommandGetExportedKeys

Implements

IMessage<CommandGetExportedKeys>

IEquatable<CommandGetExportedKeys>

IDeepCloneable<CommandGetExportedKeys>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

FlightSqlExtensions.Serialize(IBufferMessage)

Constructors

CommandGetExportedKeys()

public CommandGetExportedKeys()

CommandGetExportedKeys(CommandGetExportedKeys)

public CommandGetExportedKeys(CommandGetExportedKeys other)

Parameters

other CommandGetExportedKeys

Fields

CatalogFieldNumber

Field number for the "catalog" field.

public const int CatalogFieldNumber = 1

Field Value

int

DbSchemaFieldNumber

Field number for the "db_schema" field.

public const int DbSchemaFieldNumber = 2

Field Value

int

TableFieldNumber

Field number for the "table" field.

public const int TableFieldNumber = 3

Field Value

int

Properties

Catalog

Specifies the catalog to search for the foreign key 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

string

DbSchema

Specifies the schema to search for the foreign key 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

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

HasDbSchema

Gets whether the "db_schema" field is set

public bool HasDbSchema { get; }

Property Value

bool

Parser

public static MessageParser<CommandGetExportedKeys> Parser { get; }

Property Value

MessageParser<CommandGetExportedKeys>

Table

Specifies the foreign key table to get the foreign keys for.

public string Table { get; set; }

Property Value

string

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 CommandGetExportedKeys Clone()

Returns

CommandGetExportedKeys

A deep clone of this object.

Equals(CommandGetExportedKeys)

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

public bool Equals(CommandGetExportedKeys other)

Parameters

other CommandGetExportedKeys

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(CommandGetExportedKeys)

Merges the given message into this one.

public void MergeFrom(CommandGetExportedKeys other)

Parameters

other CommandGetExportedKeys

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.