Class DoPutPreparedStatementResult

Namespace

Arrow.Flight.Protocol.Sql

Assembly

Apache.Arrow.Flight.Sql.dll

An optional response returned when DoPut is called with CommandPreparedStatementQuery.

Note on legacy behavior: previous versions of the protocol did not return any result for this command, and that behavior should still be supported by clients. In that case, the client can continue as though the fields in this message were not provided or set to sensible default values.

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

Inheritance

object

DoPutPreparedStatementResult

Implements

IMessage<DoPutPreparedStatementResult>

IEquatable<DoPutPreparedStatementResult>

IDeepCloneable<DoPutPreparedStatementResult>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

FlightSqlExtensions.Serialize(IBufferMessage)

Constructors

DoPutPreparedStatementResult()

public DoPutPreparedStatementResult()

DoPutPreparedStatementResult(DoPutPreparedStatementResult)

public DoPutPreparedStatementResult(DoPutPreparedStatementResult other)

Parameters

other DoPutPreparedStatementResult

Fields

PreparedStatementHandleFieldNumber

Field number for the "prepared_statement_handle" field.

public const int PreparedStatementHandleFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

HasPreparedStatementHandle

Gets whether the "prepared_statement_handle" field is set

public bool HasPreparedStatementHandle { get; }

Property Value

bool

Parser

public static MessageParser<DoPutPreparedStatementResult> Parser { get; }

Property Value

MessageParser<DoPutPreparedStatementResult>

PreparedStatementHandle

Represents a (potentially updated) opaque handle for the prepared statement on the server. Because the handle could potentially be updated, any previous handles for this prepared statement should be considered invalid, and all subsequent requests for this prepared statement must use this new handle. The updated handle allows implementing query parameters with stateless services.

When an updated handle is not provided by the server, clients should continue using the previous handle provided by ActionCreatePreparedStatementResonse.

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.

ClearPreparedStatementHandle()

Clears the value of the "prepared_statement_handle" field

public void ClearPreparedStatementHandle()

Clone()

Creates a deep clone of this object.

public DoPutPreparedStatementResult Clone()

Returns

DoPutPreparedStatementResult

A deep clone of this object.

Equals(DoPutPreparedStatementResult)

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

public bool Equals(DoPutPreparedStatementResult other)

Parameters

other DoPutPreparedStatementResult

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

Merges the given message into this one.

public void MergeFrom(DoPutPreparedStatementResult other)

Parameters

other DoPutPreparedStatementResult

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.