Class CommandStatementQuery

Namespace

Arrow.Flight.Protocol.Sql

Assembly

Apache.Arrow.Flight.Sql.dll

Represents a SQL query. Used in the command member of FlightDescriptor for the following RPC calls:

• GetSchema: return the Arrow schema of the query. Fields on this schema may contain the following metadata:
  • ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name
  • ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
  • ARROW:FLIGHT:SQL:TABLE_NAME - Table name
  • ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
  • ARROW:FLIGHT:SQL:PRECISION - Column precision/size
  • ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
  • ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
  • ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.
  • ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.
  • ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
  • ARROW:FLIGHT:SQL:REMARKS - A comment describing the column. This field has been added after all others, clients should be prepared to find it missing.
• GetFlightInfo: execute the query.

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

Inheritance

object

CommandStatementQuery

Implements

IMessage<CommandStatementQuery>

IEquatable<CommandStatementQuery>

IDeepCloneable<CommandStatementQuery>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

FlightSqlExtensions.Serialize(IBufferMessage)

Constructors

CommandStatementQuery()

public CommandStatementQuery()

CommandStatementQuery(CommandStatementQuery)

public CommandStatementQuery(CommandStatementQuery other)

Parameters

other CommandStatementQuery

Fields

QueryFieldNumber

Field number for the "query" field.

public const int QueryFieldNumber = 1

Field Value

int

TransactionIdFieldNumber

Field number for the "transaction_id" field.

public const int TransactionIdFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

HasTransactionId

Gets whether the "transaction_id" field is set

public bool HasTransactionId { get; }

Property Value

bool

Parser

public static MessageParser<CommandStatementQuery> Parser { get; }

Property Value

MessageParser<CommandStatementQuery>

Query

The SQL syntax.

public string Query { get; set; }

Property Value

string

TransactionId

Include the query as part of this transaction (if unset, the query is auto-committed).

public ByteString TransactionId { get; set; }

Property Value

ByteString

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.

ClearTransactionId()

Clears the value of the "transaction_id" field

public void ClearTransactionId()

Clone()

Creates a deep clone of this object.

public CommandStatementQuery Clone()

Returns

CommandStatementQuery

A deep clone of this object.

Equals(CommandStatementQuery)

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

public bool Equals(CommandStatementQuery other)

Parameters

other CommandStatementQuery

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

Merges the given message into this one.

public void MergeFrom(CommandStatementQuery other)

Parameters

other CommandStatementQuery

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.