Struct arrow_flight::sql::CommandGetDbSchemas
source · pub struct CommandGetDbSchemas {
pub catalog: Option<String>,
pub db_schema_filter_pattern: Option<String>,
}
Expand description
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§
Trait Implementations§
source§impl Clone for CommandGetDbSchemas
impl Clone for CommandGetDbSchemas
source§fn clone(&self) -> CommandGetDbSchemas
fn clone(&self) -> CommandGetDbSchemas
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CommandGetDbSchemas
impl Debug for CommandGetDbSchemas
source§impl Default for CommandGetDbSchemas
impl Default for CommandGetDbSchemas
source§impl Message for CommandGetDbSchemas
impl Message for CommandGetDbSchemas
source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
source§fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
source§fn encode_to_vec(&self) -> Vec<u8, Global>where
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8, Global>where
Self: Sized,
source§fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
source§fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where
Self: Sized,
source§fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
source§fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
source§fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
self
. Read moresource§fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
self
.source§impl PartialEq<CommandGetDbSchemas> for CommandGetDbSchemas
impl PartialEq<CommandGetDbSchemas> for CommandGetDbSchemas
source§fn eq(&self, other: &CommandGetDbSchemas) -> bool
fn eq(&self, other: &CommandGetDbSchemas) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CommandGetDbSchemas
Auto Trait Implementations§
impl RefUnwindSafe for CommandGetDbSchemas
impl Send for CommandGetDbSchemas
impl Sync for CommandGetDbSchemas
impl Unpin for CommandGetDbSchemas
impl UnwindSafe for CommandGetDbSchemas
Blanket Implementations§
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request