Class ActionCreatePreparedSubstraitPlanRequest

Namespace

Arrow.Flight.Protocol.Sql

Assembly

Apache.Arrow.Flight.Sql.dll

Request message for the "CreatePreparedSubstraitPlan" action on a Flight SQL enabled backend.

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

Inheritance

object

ActionCreatePreparedSubstraitPlanRequest

Implements

IMessage<ActionCreatePreparedSubstraitPlanRequest>

IEquatable<ActionCreatePreparedSubstraitPlanRequest>

IDeepCloneable<ActionCreatePreparedSubstraitPlanRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

FlightSqlExtensions.Serialize(IBufferMessage)

Constructors

ActionCreatePreparedSubstraitPlanRequest()

public ActionCreatePreparedSubstraitPlanRequest()

ActionCreatePreparedSubstraitPlanRequest(ActionCreatePreparedSubstraitPlanRequest)

public ActionCreatePreparedSubstraitPlanRequest(ActionCreatePreparedSubstraitPlanRequest other)

Parameters

other ActionCreatePreparedSubstraitPlanRequest

Fields

PlanFieldNumber

Field number for the "plan" field.

public const int PlanFieldNumber = 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<ActionCreatePreparedSubstraitPlanRequest> Parser { get; }

Property Value

MessageParser<ActionCreatePreparedSubstraitPlanRequest>

Plan

The serialized substrait.Plan to create a prepared statement for.

public SubstraitPlan Plan { get; set; }

Property Value

SubstraitPlan

TransactionId

Create/execute the prepared statement as part of this transaction (if unset, executions of the prepared statement will be 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 ActionCreatePreparedSubstraitPlanRequest Clone()

Returns

ActionCreatePreparedSubstraitPlanRequest

A deep clone of this object.

Equals(ActionCreatePreparedSubstraitPlanRequest)

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

public bool Equals(ActionCreatePreparedSubstraitPlanRequest other)

Parameters

other ActionCreatePreparedSubstraitPlanRequest

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

Merges the given message into this one.

public void MergeFrom(ActionCreatePreparedSubstraitPlanRequest other)

Parameters

other ActionCreatePreparedSubstraitPlanRequest

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.