Struct arrow_flight::sql::metadata::GetDbSchemasBuilder

pub struct GetDbSchemasBuilder { /* private fields */ }

A builder for a CommandGetDbSchemas response.

Builds rows like this:

• catalog_name: utf8,
• db_schema_name: utf8,

Implementations

impl GetDbSchemasBuilder

pub fn new( catalog: Option<impl Into<String>>, db_schema_filter_pattern: Option<impl Into<String>>, ) -> Self

Create a new instance of GetDbSchemasBuilder

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.

pub fn append( &mut self, catalog_name: impl AsRef<str>, schema_name: impl AsRef<str>, )

Append a row

In case the catalog should be considered as empty, pass in an empty string ‘“”’.

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

builds a RecordBatch with the correct schema for a CommandGetDbSchemas response

pub fn schema(&self) -> SchemaRef

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

Trait Implementations

impl From<CommandGetDbSchemas> for GetDbSchemasBuilder

fn from(value: CommandGetDbSchemas) -> Self

Converts to this type from the input type.