Struct arrow_flight::sql::CommandGetExportedKeys

pub struct CommandGetExportedKeys {
    pub catalog: Option<String>,
    pub db_schema: Option<String>,
    pub table: String,
}

Represents a request to retrieve a description of the foreign key columns that reference the given table’s primary key columns (the foreign keys exported by a table) of a table on a Flight SQL enabled backend. Used in the command member of FlightDescriptor for the following RPC calls:

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

The returned Arrow schema will be: < pk_catalog_name: utf8, pk_db_schema_name: utf8, pk_table_name: utf8 not null, pk_column_name: utf8 not null, fk_catalog_name: utf8, fk_db_schema_name: utf8, fk_table_name: utf8 not null, fk_column_name: utf8 not null, key_sequence: int32 not null, fk_key_name: utf8, pk_key_name: utf8, update_rule: uint8 not null, delete_rule: uint8 not null > The returned data should be ordered by fk_catalog_name, fk_db_schema_name, fk_table_name, fk_key_name, then key_sequence. update_rule and delete_rule returns a byte that is equivalent to actions declared on UpdateDeleteRules enum.

Fields

catalog: Option<String>

Specifies the catalog to search for the foreign key table. An empty string retrieves those without a catalog. If omitted the catalog name should not be used to narrow the search.

db_schema: Option<String>

Specifies the schema to search for the foreign key table. An empty string retrieves those without a schema. If omitted the schema name should not be used to narrow the search.

table: String

Specifies the foreign key table to get the foreign keys for.

Implementations

impl CommandGetExportedKeys

pub fn catalog(&self) -> &str

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

pub fn db_schema(&self) -> &str

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

Trait Implementations

impl Clone for CommandGetExportedKeys

fn clone(&self) -> CommandGetExportedKeys

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandGetExportedKeys

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

Formats the value using the given formatter.

impl Default for CommandGetExportedKeys

fn default() -> Self

Returns the “default value” for a type.

impl Message for CommandGetExportedKeys

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

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

fn type_url() -> &'static str

type_url for this Message

fn as_any(&self) -> Any

Convert this Message to Any

impl StructuralPartialEq for CommandGetExportedKeys