Struct arrow_flight::sql::CommandGetCrossReference

pub struct CommandGetCrossReference {
    pub pk_catalog: Option<String>,
    pub pk_db_schema: Option<String>,
    pub pk_table: String,
    pub fk_catalog: Option<String>,
    pub fk_db_schema: Option<String>,
    pub fk_table: String,
}

Represents a request to retrieve a description of the foreign key columns in the given foreign key table that reference the primary key or the columns representing a unique constraint of the parent table (could be the same or a different 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: int not null, fk_key_name: utf8, pk_key_name: utf8, update_rule: uint1 not null, delete_rule: uint1 not null > The returned data should be ordered by pk_catalog_name, pk_db_schema_name, pk_table_name, pk_key_name, then key_sequence. update_rule and delete_rule returns a byte that is equivalent to actions: - 0 = CASCADE - 1 = RESTRICT - 2 = SET NULL - 3 = NO ACTION - 4 = SET DEFAULT

Fields

pk_catalog: Option<String>

The catalog name where the parent table is. An empty string retrieves those without a catalog. If omitted the catalog name should not be used to narrow the search.

pk_db_schema: Option<String>

The Schema name where the parent table is. An empty string retrieves those without a schema. If omitted the schema name should not be used to narrow the search.

pk_table: String

The parent table name. It cannot be null.

fk_catalog: Option<String>

The catalog name where the foreign table is. An empty string retrieves those without a catalog. If omitted the catalog name should not be used to narrow the search.

fk_db_schema: Option<String>

The schema name where the foreign table is. An empty string retrieves those without a schema. If omitted the schema name should not be used to narrow the search.

fk_table: String

The foreign table name. It cannot be null.

Implementations

impl CommandGetCrossReference

pub fn pk_catalog(&self) -> &str

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

pub fn pk_db_schema(&self) -> &str

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

pub fn fk_catalog(&self) -> &str

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

pub fn fk_db_schema(&self) -> &str

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

Trait Implementations

impl Clone for CommandGetCrossReference

fn clone(&self) -> CommandGetCrossReference

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandGetCrossReference

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

Formats the value using the given formatter.

impl Default for CommandGetCrossReference

fn default() -> Self

Returns the “default value” for a type.

impl Message for CommandGetCrossReference

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

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

fn type_url() -> &'static str

type_url for this Message

fn as_any(&self) -> Any

Convert this Message to Any

impl StructuralPartialEq for CommandGetCrossReference