Struct arrow_flight::sql::CommandGetXdbcTypeInfo

pub struct CommandGetXdbcTypeInfo {
    pub data_type: Option<i32>,
}

Represents a request to retrieve information about data type supported on a Flight SQL enabled backend. Used in the command member of FlightDescriptor for the following RPC calls:

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

The returned schema will be: < type_name: utf8 not null (The name of the data type, for example: VARCHAR, INTEGER, etc), data_type: int not null (The SQL data type), column_size: int (The maximum size supported by that column. In case of exact numeric types, this represents the maximum precision. In case of string types, this represents the character length. In case of datetime data types, this represents the length in characters of the string representation. NULL is returned for data types where column size is not applicable.), literal_prefix: utf8 (Character or characters used to prefix a literal, NULL is returned for data types where a literal prefix is not applicable.), literal_suffix: utf8 (Character or characters used to terminate a literal, NULL is returned for data types where a literal suffix is not applicable.), create_params: list (A list of keywords corresponding to which parameters can be used when creating a column for that specific type. NULL is returned if there are no parameters for the data type definition.), nullable: int not null (Shows if the data type accepts a NULL value. The possible values can be seen in the Nullable enum.), case_sensitive: bool not null (Shows if a character data type is case-sensitive in collations and comparisons), searchable: int not null (Shows how the data type is used in a WHERE clause. The possible values can be seen in the Searchable enum.), unsigned_attribute: bool (Shows if the data type is unsigned. NULL is returned if the attribute is not applicable to the data type or the data type is not numeric.), fixed_prec_scale: bool not null (Shows if the data type has predefined fixed precision and scale.), auto_increment: bool (Shows if the data type is auto incremental. NULL is returned if the attribute is not applicable to the data type or the data type is not numeric.), local_type_name: utf8 (Localized version of the data source-dependent name of the data type. NULL is returned if a localized name is not supported by the data source), minimum_scale: int (The minimum scale of the data type on the data source. If a data type has a fixed scale, the MINIMUM_SCALE and MAXIMUM_SCALE columns both contain this value. NULL is returned if scale is not applicable.), maximum_scale: int (The maximum scale of the data type on the data source. NULL is returned if scale is not applicable.), sql_data_type: int not null (The value of the SQL DATA TYPE which has the same values as data_type value. Except for interval and datetime, which uses generic values. More info about those types can be obtained through datetime_subcode. The possible values can be seen in the XdbcDataType enum.), datetime_subcode: int (Only used when the SQL DATA TYPE is interval or datetime. It contains its sub types. For type different from interval and datetime, this value is NULL. The possible values can be seen in the XdbcDatetimeSubcode enum.), num_prec_radix: int (If the data type is an approximate numeric type, this column contains the value 2 to indicate that COLUMN_SIZE specifies a number of bits. For exact numeric types, this column contains the value 10 to indicate that column size specifies a number of decimal digits. Otherwise, this column is NULL.), interval_precision: int (If the data type is an interval data type, then this column contains the value of the interval leading precision. Otherwise, this column is NULL. This fields is only relevant to be used by ODBC). > The returned data should be ordered by data_type and then by type_name.

Fields

data_type: Option<i32>

Specifies the data type to search for the info.

Implementations

impl CommandGetXdbcTypeInfo

pub fn data_type(&self) -> i32

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

Trait Implementations

impl Clone for CommandGetXdbcTypeInfo

fn clone(&self) -> CommandGetXdbcTypeInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandGetXdbcTypeInfo

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

Formats the value using the given formatter.

impl Default for CommandGetXdbcTypeInfo

fn default() -> Self

Returns the “default value” for a type.

impl Message for CommandGetXdbcTypeInfo

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

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

fn type_url() -> &'static str

type_url for this Message

fn as_any(&self) -> Any

Convert this Message to Any

impl StructuralPartialEq for CommandGetXdbcTypeInfo