arrow_flight::sql

Struct CommandPreparedStatementQuery

Source
pub struct CommandPreparedStatementQuery {
    pub prepared_statement_handle: Bytes,
}
Expand description

Represents an instance of executing a prepared statement. 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.

    If the schema is retrieved after parameter values have been bound with DoPut, then the server should account for the parameters when determining the schema.

  • DoPut: bind parameter values. All of the bound parameter sets will be executed as a single atomic execution.

  • GetFlightInfo: execute the prepared statement instance.

Fields§

§prepared_statement_handle: Bytes

Opaque handle for the prepared statement on the server.

Trait Implementations§

Source§

impl Clone for CommandPreparedStatementQuery

Source§

fn clone(&self) -> CommandPreparedStatementQuery

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandPreparedStatementQuery

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CommandPreparedStatementQuery

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Message for CommandPreparedStatementQuery

Source§

fn encoded_len(&self) -> usize

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

fn clear(&mut self)

Clears the message, resetting all fields to their default.
Source§

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,

Encodes the message to a newly allocated buffer.
Source§

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,

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

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,

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

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 more
Source§

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 CommandPreparedStatementQuery

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl ProstMessageExt for CommandPreparedStatementQuery

Source§

fn type_url() -> &'static str

type_url for this Message
Source§

fn as_any(&self) -> Any

Convert this Message to Any
Source§

impl StructuralPartialEq for CommandPreparedStatementQuery

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,