pub struct CommandGetTables {
pub catalog: Option<String>,
pub db_schema_filter_pattern: Option<String>,
pub table_name_filter_pattern: Option<String>,
pub table_types: Vec<String>,
pub include_schema: bool,
}
Expand description
Represents a request to retrieve the list of tables, and optionally their schemas, 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: < catalog_name: utf8, db_schema_name: utf8, table_name: utf8 not null, table_type: utf8 not null, [optional] table_schema: bytes not null (schema of the table as described in Schema.fbs::Schema, it is serialized as an IPC message.)
Fields on table_schema may contain the following metadata:
- ARROW:FLIGHT:SQL:CATALOG_NAME - Table’s catalog name
- ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
- ARROW:FLIGHT:SQL:TABLE_NAME - Table name
- ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
- ARROW:FLIGHT:SQL:PRECISION - Column precision/size
- ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
- ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - “1” indicates if the column is auto incremented, “0” otherwise.
- ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - “1” indicates if the column is case-sensitive, “0” otherwise.
- ARROW:FLIGHT:SQL:IS_READ_ONLY - “1” indicates if the column is read only, “0” otherwise.
- ARROW:FLIGHT:SQL:IS_SEARCHABLE - “1” indicates if the column is searchable via WHERE clause, “0” otherwise. The returned data should be ordered by catalog_name, db_schema_name, table_name, then table_type, followed by table_schema if requested.
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, all schemas matching other filters are searched. 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.
table_name_filter_pattern: Option<String>
Specifies a filter pattern for tables to search for. When no table_name_filter_pattern is provided, all tables matching other filters are searched. 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.
table_types: Vec<String>
Specifies a filter of table types which must match. The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables. TABLE, VIEW, and SYSTEM TABLE are commonly supported.
include_schema: bool
Specifies if the Arrow schema should be returned for found tables.
Implementations§
Source§impl CommandGetTables
impl CommandGetTables
Sourcepub fn catalog(&self) -> &str
pub fn catalog(&self) -> &str
Returns the value of catalog
, or the default value if catalog
is unset.
Sourcepub fn db_schema_filter_pattern(&self) -> &str
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.
Sourcepub fn table_name_filter_pattern(&self) -> &str
pub fn table_name_filter_pattern(&self) -> &str
Returns the value of table_name_filter_pattern
, or the default value if table_name_filter_pattern
is unset.
Source§impl CommandGetTables
impl CommandGetTables
Sourcepub fn into_builder(self) -> GetTablesBuilder
pub fn into_builder(self) -> GetTablesBuilder
Create a builder suitable for constructing a response
Trait Implementations§
Source§impl Clone for CommandGetTables
impl Clone for CommandGetTables
Source§fn clone(&self) -> CommandGetTables
fn clone(&self) -> CommandGetTables
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CommandGetTables
impl Debug for CommandGetTables
Source§impl Default for CommandGetTables
impl Default for CommandGetTables
Source§impl From<CommandGetTables> for GetTablesBuilder
impl From<CommandGetTables> for GetTablesBuilder
Source§fn from(value: CommandGetTables) -> Self
fn from(value: CommandGetTables) -> Self
Source§impl Message for CommandGetTables
impl Message for CommandGetTables
Source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
Source§fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>where
Self: Sized,
fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>where
Self: Sized,
Source§fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
Source§fn encode_length_delimited(
&self,
buf: &mut impl BufMut,
) -> Result<(), EncodeError>where
Self: Sized,
fn encode_length_delimited(
&self,
buf: &mut impl BufMut,
) -> Result<(), EncodeError>where
Self: Sized,
Source§fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
Source§fn decode(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
fn decode(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
Source§fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
Source§fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
self
. Read moreSource§fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
self
.Source§impl PartialEq for CommandGetTables
impl PartialEq for CommandGetTables
Source§impl ProstMessageExt for CommandGetTables
impl ProstMessageExt for CommandGetTables
impl StructuralPartialEq for CommandGetTables
Auto Trait Implementations§
impl Freeze for CommandGetTables
impl RefUnwindSafe for CommandGetTables
impl Send for CommandGetTables
impl Sync for CommandGetTables
impl Unpin for CommandGetTables
impl UnwindSafe for CommandGetTables
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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