Struct arrow_flight::sql::CommandGetDbSchemas

pub struct CommandGetDbSchemas {
    pub catalog: Option<String>,
    pub db_schema_filter_pattern: Option<String>,
}

Represents a request to retrieve the list of database schemas on a Flight SQL enabled backend. The definition of a database schema depends on vendor/implementation. It is usually a collection of tables. 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: < catalog_name: utf8, db_schema_name: utf8 not null > The returned data should be ordered by catalog_name, then db_schema_name.

Fields

catalog: Option<String>

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

db_schema_filter_pattern: Option<String>

Specifies a filter pattern for schemas to search for. When no db_schema_filter_pattern is provided, the pattern will not be used to narrow the search. In the pattern string, two special characters can be used to denote matching rules: - “%” means to match any substring with 0 or more characters. - “_” means to match any one character.

Implementations

impl CommandGetDbSchemas

pub fn catalog(&self) -> &str

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

pub fn db_schema_filter_pattern(&self) -> &str

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

impl CommandGetDbSchemas

pub fn into_builder(self) -> GetDbSchemasBuilder

Create a builder suitable for constructing a response

Trait Implementations

impl Clone for CommandGetDbSchemas

fn clone(&self) -> CommandGetDbSchemas

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandGetDbSchemas

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

Formats the value using the given formatter.

impl Default for CommandGetDbSchemas

fn default() -> Self

Returns the “default value” for a type.

impl From<CommandGetDbSchemas> for GetDbSchemasBuilder

fn from(value: CommandGetDbSchemas) -> Self

Converts to this type from the input type.

impl Message for CommandGetDbSchemas

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

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

fn type_url() -> &'static str

type_url for this Message

fn as_any(&self) -> Any

Convert this Message to Any

impl StructuralPartialEq for CommandGetDbSchemas