Class CommandGetSqlInfo

Namespace

Arrow.Flight.Protocol.Sql

Assembly

Apache.Arrow.Flight.Sql.dll

Represents a metadata request. Used in the command member of FlightDescriptor for the following RPC calls:

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

The returned Arrow schema will be: < info_name: uint32 not null, value: dense_union< string_value: utf8, bool_value: bool, bigint_value: int64, int32_bitmask: int32, string_list: list<string_data: utf8> int32_to_int32_list_map: map<key: int32, value: list<\(data\): int32>>

where there is one row per requested piece of metadata information.

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

Inheritance

object

CommandGetSqlInfo

Implements

IMessage<CommandGetSqlInfo>

IEquatable<CommandGetSqlInfo>

IDeepCloneable<CommandGetSqlInfo>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

FlightSqlExtensions.Serialize(IBufferMessage)

Constructors

CommandGetSqlInfo()

public CommandGetSqlInfo()

CommandGetSqlInfo(CommandGetSqlInfo)

public CommandGetSqlInfo(CommandGetSqlInfo other)

Parameters

other CommandGetSqlInfo

Fields

InfoFieldNumber

Field number for the "info" field.

public const int InfoFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Info

Values are modelled after ODBC's SQLGetInfo() function. This information is intended to provide Flight SQL clients with basic, SQL syntax and SQL functions related information. More information types can be added in future releases. E.g. more SQL syntax support types, scalar functions support, type conversion support etc.

Note that the set of metadata may expand.

Initially, Flight SQL will support the following information types:

• Server Information - Range [0-500)
• Syntax Information - Range [500-1000) Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options). Custom options should start at 10,000.

If omitted, then all metadata will be retrieved. Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use. If additional metadata is included, the metadata IDs should start from 10,000.

public RepeatedField<uint> Info { get; }

Property Value

RepeatedField<uint>

Parser

public static MessageParser<CommandGetSqlInfo> Parser { get; }

Property Value

MessageParser<CommandGetSqlInfo>

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.

Clone()

Creates a deep clone of this object.

public CommandGetSqlInfo Clone()

Returns

CommandGetSqlInfo

A deep clone of this object.

Equals(CommandGetSqlInfo)

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

public bool Equals(CommandGetSqlInfo other)

Parameters

other CommandGetSqlInfo

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

Merges the given message into this one.

public void MergeFrom(CommandGetSqlInfo other)

Parameters

other CommandGetSqlInfo

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.