pub struct CommandStatementSubstraitPlan {
pub plan: Option<SubstraitPlan>,
pub transaction_id: Option<Bytes>,
}
Expand description
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§
Source§impl CommandStatementSubstraitPlan
impl CommandStatementSubstraitPlan
Sourcepub fn transaction_id(&self) -> &[u8] ⓘ
pub fn transaction_id(&self) -> &[u8] ⓘ
Returns the value of transaction_id
, or the default value if transaction_id
is unset.
Trait Implementations§
Source§impl Clone for CommandStatementSubstraitPlan
impl Clone for CommandStatementSubstraitPlan
Source§fn clone(&self) -> CommandStatementSubstraitPlan
fn clone(&self) -> CommandStatementSubstraitPlan
Returns a copy of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl Message for CommandStatementSubstraitPlan
impl Message for CommandStatementSubstraitPlan
Source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
Returns the encoded length of the message without a length delimiter.
Source§fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>where
Self: Sized,
fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>where
Self: Sized,
Encodes the message to a buffer. Read more
Source§fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
Encodes the message to a newly allocated buffer.
Source§fn encode_length_delimited(
&self,
buf: &mut impl BufMut,
) -> Result<(), EncodeError>where
Self: Sized,
fn encode_length_delimited(
&self,
buf: &mut impl BufMut,
) -> Result<(), EncodeError>where
Self: Sized,
Encodes the message with a length-delimiter to a buffer. Read more
Source§fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
Encodes the message with a length-delimiter to a newly allocated buffer.
Source§fn decode(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
fn decode(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
Decodes an instance of the message from a buffer. Read more
Source§fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
Decodes a length-delimited instance of the message from the buffer.
Source§fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
Decodes an instance of the message from a buffer, and merges it into
self
. Read moreSource§fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
Decodes a length-delimited instance of the message from buffer, and
merges it into
self
.Source§impl PartialEq for CommandStatementSubstraitPlan
impl PartialEq for CommandStatementSubstraitPlan
Source§fn eq(&self, other: &CommandStatementSubstraitPlan) -> bool
fn eq(&self, other: &CommandStatementSubstraitPlan) -> bool
Tests for
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CommandStatementSubstraitPlan
Auto Trait Implementations§
impl !Freeze for CommandStatementSubstraitPlan
impl RefUnwindSafe for CommandStatementSubstraitPlan
impl Send for CommandStatementSubstraitPlan
impl Sync for CommandStatementSubstraitPlan
impl Unpin for CommandStatementSubstraitPlan
impl UnwindSafe for CommandStatementSubstraitPlan
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T
in a tonic::Request