Struct arrow_flight::sql::CommandStatementSubstraitPlan

pub struct CommandStatementSubstraitPlan {
    pub plan: Option<SubstraitPlan>,
    pub transaction_id: Option<Bytes>,
}

Represents a Substrait plan. 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.
• GetFlightInfo: execute the query.
• DoPut: execute the query.

Fields

plan: Option<SubstraitPlan>

A serialized substrait.Plan

transaction_id: Option<Bytes>

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

Implementations

impl CommandStatementSubstraitPlan

pub fn transaction_id(&self) -> &[u8]

Returns the value of transaction_id, or the default value if transaction_id is unset.

Trait Implementations

impl Clone for CommandStatementSubstraitPlan

fn clone(&self) -> CommandStatementSubstraitPlan

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandStatementSubstraitPlan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CommandStatementSubstraitPlan

fn default() -> Self

Returns the “default value” for a type.

impl Message for CommandStatementSubstraitPlan

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<CommandStatementSubstraitPlan> for CommandStatementSubstraitPlan

fn eq(&self, other: &CommandStatementSubstraitPlan) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ProstMessageExt for CommandStatementSubstraitPlan

fn type_url() -> &'static str

type_url for this Message

fn as_any(&self) -> Any

Convert this Message to Any

impl StructuralPartialEq for CommandStatementSubstraitPlan