Struct sql_schema_describer::SqlSchema

pub struct SqlSchema { /* private fields */ }

The result of describing a database schema.

Implementations

impl SqlSchema

pub fn downcast_connector_data<T: 'static>(&self) -> &T

Extract connector-specific constructs. The type parameter must be the right one.

pub fn next_table_column_id(&self) -> TableColumnId

The id of the next column

pub fn next_view_column_id(&self) -> ViewColumnId

The id of the next column

pub fn enum_used_in_tables(&self, id: EnumId) -> bool

The given enum is used in tables.

pub fn downcast_connector_data_mut<T: 'static>(&mut self) -> &mut T

Extract connector-specific constructs mutably. The type parameter must be the right one.

pub fn clear_namespaces(&mut self)

Remove all namespaces from the schema.

pub fn set_connector_data(&mut self, data: Box<dyn Any + Send + Sync>)

Insert connector-specific data into the schema. This will replace existing connector data.

pub fn get_view(&self, name: &str) -> Option<&View>

Get a view.

pub fn find_enum(&self, name: &str, namespace: Option<&str>) -> Option<EnumId>

Try to find an enum by name.

pub fn find_table(&self, name: &str, namespace: Option<&str>) -> Option<TableId>

Try to find a table by name.

pub fn find_view(&self, name: &str, namespace: Option<&str>) -> Option<ViewId>

Try to find a table by name.

pub fn get_procedure(&self, name: &str) -> Option<&Procedure>

Get a procedure.

pub fn get_user_defined_type(&self, name: &str) -> Option<&UserDefinedType>

Get a user defined type by name.

pub fn get_namespace_id(&self, name: &str) -> Option<NamespaceId>

Find a namespace by name.

pub fn indexes_count(&self) -> usize

The total number of indexes in the schema.

pub fn make_fulltext_indexes_normal(&mut self)

Make all fulltext indexes non-fulltext, for the preview feature’s purpose.

pub fn push_table_column( &mut self, table_id: TableId, column: Column ) -> TableColumnId

Add a table column to the schema.

pub fn push_view_column( &mut self, view_id: ViewId, column: Column ) -> ViewColumnId

Add a view column to the schema.

pub fn push_enum( &mut self, namespace_id: NamespaceId, enum_name: String, description: Option<String> ) -> EnumId

Add an enum to the schema.

pub fn push_enum_variant( &mut self, enum_id: EnumId, variant_name: String ) -> EnumVariantId

Add a variant to an enum.

pub fn push_fulltext_index( &mut self, table_id: TableId, index_name: String ) -> IndexId

Add a fulltext index to the schema.

pub fn push_index(&mut self, table_id: TableId, index_name: String) -> IndexId

Add an index to the schema.

pub fn push_table_default_value( &mut self, column_id: TableColumnId, value: DefaultValue ) -> TableDefaultValueId

Add table default value to the schema.

pub fn push_view_default_value( &mut self, column_id: ViewColumnId, value: DefaultValue ) -> ViewDefaultValueId

Add table default value to the schema.

pub fn push_primary_key( &mut self, table_id: TableId, index_name: String ) -> IndexId

Add a primary key to the schema.

pub fn push_unique_constraint( &mut self, table_id: TableId, index_name: String ) -> IndexId

Add a unique constraint/index to the schema.

pub fn push_index_column(&mut self, column: IndexColumn) -> IndexColumnId

pub fn push_foreign_key( &mut self, constraint_name: Option<String>, [constrained_table, referenced_table]: [TableId; 2], [on_delete_action, on_update_action]: [ForeignKeyAction; 2] ) -> ForeignKeyId

pub fn push_foreign_key_column( &mut self, foreign_key_id: ForeignKeyId, [constrained_column, referenced_column]: [TableColumnId; 2] )

pub fn push_namespace(&mut self, name: String) -> NamespaceId

pub fn push_table( &mut self, name: String, namespace_id: NamespaceId, description: Option<String> ) -> TableId

pub fn push_view( &mut self, name: String, namespace_id: NamespaceId, definition: Option<String>, description: Option<String> ) -> ViewId

pub fn push_table_with_properties( &mut self, name: String, namespace_id: NamespaceId, properties: BitFlags<TableProperties>, description: Option<String> ) -> TableId

pub fn namespaces_count(&self) -> usize

pub fn namespace_walker<'a>(&'a self, name: &str) -> Option<NamespaceWalker<'a>>

pub fn tables_count(&self) -> usize

pub fn views_count(&self) -> usize

pub fn table_walker<'a>(&'a self, name: &str) -> Option<TableWalker<'a>>

pub fn table_walker_ns<'a>( &'a self, namespace: &str, name: &str ) -> Option<TableWalker<'a>>

pub fn view_walker<'a>(&'a self, name: &str) -> Option<ViewWalker<'a>>

pub fn view_walker_ns<'a>( &'a self, namespace: &str, name: &str ) -> Option<ViewWalker<'a>>

pub fn table_walkers(&self) -> impl ExactSizeIterator<Item = TableWalker<'_>>

pub fn view_walkers(&self) -> impl ExactSizeIterator<Item = ViewWalker<'_>>

pub fn udt_walkers(&self) -> impl Iterator<Item = UserDefinedTypeWalker<'_>>

pub fn enum_walkers(&self) -> impl ExactSizeIterator<Item = EnumWalker<'_>>

pub fn walk_foreign_keys(&self) -> impl Iterator<Item = ForeignKeyWalker<'_>>

pub fn walk<I>(&self, id: I) -> Walker<'_, I>

Traverse a schema item by id.

pub fn walk_table_columns(&self) -> impl Iterator<Item = TableColumnWalker<'_>>

Traverse all the table columns in the schema.

pub fn walk_view_columns(&self) -> impl Iterator<Item = ViewColumnWalker<'_>>

Traverse all the table columns in the schema.

pub fn walk_namespaces( &self ) -> impl ExactSizeIterator<Item = NamespaceWalker<'_>>

Traverse all namespaces in the catalog.

pub fn is_empty(&self) -> bool

No tables or enums in the catalog.

Trait Implementations

impl Debug for SqlSchema

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

Formats the value using the given formatter.

impl Default for SqlSchema

fn default() -> SqlSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SqlSchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SqlSchema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.