Class ActionCreatePreparedStatementResult

Namespace

Arrow.Flight.Protocol.Sql

Assembly

Apache.Arrow.Flight.Sql.dll

Wrap the result of a "CreatePreparedStatement" or "CreatePreparedSubstraitPlan" action.

The resultant PreparedStatement can be closed either:

• Manually, through the "ClosePreparedStatement" action;
• Automatically, by a server timeout.

The result should be wrapped in a google.protobuf.Any message.

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

Inheritance

object

ActionCreatePreparedStatementResult

Implements

IMessage<ActionCreatePreparedStatementResult>

IEquatable<ActionCreatePreparedStatementResult>

IDeepCloneable<ActionCreatePreparedStatementResult>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

FlightSqlExtensions.Serialize(IBufferMessage)

Constructors

ActionCreatePreparedStatementResult()

public ActionCreatePreparedStatementResult()

ActionCreatePreparedStatementResult(ActionCreatePreparedStatementResult)

public ActionCreatePreparedStatementResult(ActionCreatePreparedStatementResult other)

Parameters

other ActionCreatePreparedStatementResult

Fields

DatasetSchemaFieldNumber

Field number for the "dataset_schema" field.

public const int DatasetSchemaFieldNumber = 2

Field Value

int

ParameterSchemaFieldNumber

Field number for the "parameter_schema" field.

public const int ParameterSchemaFieldNumber = 3

Field Value

int

PreparedStatementHandleFieldNumber

Field number for the "prepared_statement_handle" field.

public const int PreparedStatementHandleFieldNumber = 1

Field Value

int

Properties

DatasetSchema

If a result set generating query was provided, dataset_schema contains the schema of the result set. It should be an IPC-encapsulated Schema, as described in Schema.fbs. For some queries, the schema of the results may depend on the schema of the parameters. The server should provide its best guess as to the schema at this point. Clients must not assume that this schema, if provided, will be accurate.

public ByteString DatasetSchema { get; set; }

Property Value

ByteString

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ParameterSchema

If the query provided contained parameters, parameter_schema contains the schema of the expected parameters. It should be an IPC-encapsulated Schema, as described in Schema.fbs.

public ByteString ParameterSchema { get; set; }

Property Value

ByteString

Parser

public static MessageParser<ActionCreatePreparedStatementResult> Parser { get; }

Property Value

MessageParser<ActionCreatePreparedStatementResult>

PreparedStatementHandle

Opaque handle for the prepared statement on the server.

public ByteString PreparedStatementHandle { 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.

Clone()

Creates a deep clone of this object.

public ActionCreatePreparedStatementResult Clone()

Returns

ActionCreatePreparedStatementResult

A deep clone of this object.

Equals(ActionCreatePreparedStatementResult)

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

public bool Equals(ActionCreatePreparedStatementResult other)

Parameters

other ActionCreatePreparedStatementResult

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

Merges the given message into this one.

public void MergeFrom(ActionCreatePreparedStatementResult other)

Parameters

other ActionCreatePreparedStatementResult

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.