Class SubstraitPlan

Namespace

Arrow.Flight.Protocol.Sql

Assembly

Apache.Arrow.Flight.Sql.dll

An embedded message describing a Substrait plan to execute.

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

Inheritance

object

SubstraitPlan

Implements

IMessage<SubstraitPlan>

IEquatable<SubstraitPlan>

IDeepCloneable<SubstraitPlan>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

FlightSqlExtensions.Serialize(IBufferMessage)

Constructors

SubstraitPlan()

public SubstraitPlan()

SubstraitPlan(SubstraitPlan)

public SubstraitPlan(SubstraitPlan other)

Parameters

other SubstraitPlan

Fields

PlanFieldNumber

Field number for the "plan" field.

public const int PlanFieldNumber = 1

Field Value

int

VersionFieldNumber

Field number for the "version" field.

public const int VersionFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<SubstraitPlan> Parser { get; }

Property Value

MessageParser<SubstraitPlan>

Plan

The serialized substrait.Plan to create a prepared statement for. XXX(ARROW-16902): this is bytes instead of an embedded message because Protobuf does not really support one DLL using Protobuf definitions from another DLL.

public ByteString Plan { get; set; }

Property Value

ByteString

Version

The Substrait release, e.g. "0.12.0". This information is not tracked in the plan itself, so this is the only way for consumers to potentially know if they can handle the plan.

public string Version { get; set; }

Property Value

string

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 SubstraitPlan Clone()

Returns

SubstraitPlan

A deep clone of this object.

Equals(SubstraitPlan)

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

public bool Equals(SubstraitPlan other)

Parameters

other SubstraitPlan

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

Merges the given message into this one.

public void MergeFrom(SubstraitPlan other)

Parameters

other SubstraitPlan

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.