Struct arrow_flight::sql::CommandGetSqlInfo

pub struct CommandGetSqlInfo {
    pub info: Vec<u32>,
}

Represents a metadata request. Used in the command member of FlightDescriptor for the following RPC calls:

• GetSchema: return the Arrow schema of the query.
• GetFlightInfo: execute the metadata request.

The returned Arrow schema will be: < info_name: uint32 not null, value: dense_union< string_value: utf8, bool_value: bool, bigint_value: int64, int32_bitmask: int32, string_list: list<string_data: utf8> int32_to_int32_list_map: map<key: int32, value: list<$data$: int32>> > where there is one row per requested piece of metadata information.

Fields

info: Vec<u32>

Values are modelled after ODBC’s SQLGetInfo() function. This information is intended to provide Flight SQL clients with basic, SQL syntax and SQL functions related information. More information types can be added in future releases. E.g. more SQL syntax support types, scalar functions support, type conversion support etc.

Note that the set of metadata may expand.

Initially, Flight SQL will support the following information types:

• Server Information - Range [0-500)
• Syntax Information - Range [500-1000) Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options). Custom options should start at 10,000.

If omitted, then all metadata will be retrieved. Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use. If additional metadata is included, the metadata IDs should start from 10,000.

Trait Implementations

impl Clone for CommandGetSqlInfo

fn clone(&self) -> CommandGetSqlInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandGetSqlInfo

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

Formats the value using the given formatter.

impl Default for CommandGetSqlInfo

fn default() -> Self

Returns the “default value” for a type.

impl Message for CommandGetSqlInfo

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

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

fn type_url() -> &'static str

type_url for this Message

fn as_any(&self) -> Any

Convert this Message to Any

impl StructuralPartialEq for CommandGetSqlInfo