Struct arrow_flight::sql::CommandPreparedStatementQuery

pub struct CommandPreparedStatementQuery {
    pub prepared_statement_handle: Bytes,
}

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

impl Clone for CommandPreparedStatementQuery

fn clone(&self) -> CommandPreparedStatementQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandPreparedStatementQuery

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

Formats the value using the given formatter.

impl Default for CommandPreparedStatementQuery

fn default() -> Self

Returns the “default value” for a type.

impl Message for CommandPreparedStatementQuery

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>

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>

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 for CommandPreparedStatementQuery

fn eq(&self, other: &CommandPreparedStatementQuery) -> 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 CommandPreparedStatementQuery

fn type_url() -> &'static str

type_url for this Message

fn as_any(&self) -> Any

Convert this Message to Any

impl StructuralPartialEq for CommandPreparedStatementQuery