Struct arrow_flight::sql::metadata::GetTablesBuilder

pub struct GetTablesBuilder { /* private fields */ }

A builder for a CommandGetTables response.

Builds rows like this:

• 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.)

Implementations

impl GetTablesBuilder

pub fn new( catalog: Option<impl Into<String>>, db_schema_filter_pattern: Option<impl Into<String>>, table_name_filter_pattern: Option<impl Into<String>>, table_types: impl IntoIterator<Item = impl Into<String>>, include_schema: bool, ) -> Self

Create a new instance of GetTablesBuilder

Parameters

• catalog: Specifies the Catalog to search for the tables.
  • An empty string retrieves those without a catalog.
  • If omitted the catalog name is not used to narrow the search.
• db_schema_filter_pattern: Specifies a filter pattern for schemas to search for. When no 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.
• table_name_filter_pattern: Specifies a filter pattern for tables to search for. When no 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: Specifies a filter of table types which must match. An empy Vec matches all table types.
• include_schema: Specifies if the Arrow schema should be returned for found tables.

pub fn append( &mut self, catalog_name: impl AsRef<str>, schema_name: impl AsRef<str>, table_name: impl AsRef<str>, table_type: impl AsRef<str>, table_schema: &Schema, ) -> Result<()>

Append a row

pub fn build(self) -> Result<RecordBatch>

builds a RecordBatch for CommandGetTables

pub fn schema(&self) -> SchemaRef

Return the schema of the RecordBatch that will be returned from CommandGetTables

Note the schema differs based on the values of `include_schema

pub fn include_schema(&self) -> bool

Should the “schema” column be included

Trait Implementations

impl From<CommandGetTables> for GetTablesBuilder

fn from(value: CommandGetTables) -> Self

Converts to this type from the input type.