Struct Catalog

pub struct Catalog {
    version: CatalogVersion,
    database_by_name: HashMap<String, DatabaseCatalog>,
    db_name_by_id: HashMap<u32, String>,
    table_by_id: HashMap<TableId, Arc<TableCatalog>>,
    table_stats: HummockVersionStats,
}

Root catalog of database catalog. It manages all database/schema/table in memory on frontend. It is protected by a RwLock. Only crate::observer::FrontendObserverNode will acquire the write lock and sync it with the meta catalog. In other situations, it is read only.

• catalog (root catalog)
  • database catalog
    • schema catalog
      • function catalog (i.e., user defined function)
      • table/sink/source/index/view catalog
      • column catalog

Fields

version: CatalogVersion

database_by_name: HashMap<String, DatabaseCatalog>

db_name_by_id: HashMap<u32, String>

table_by_id: HashMap<TableId, Arc<TableCatalog>>

all table catalogs in the cluster identified by universal unique table id.

table_stats: HummockVersionStats

Implementations

impl Catalog

fn get_database_mut(&mut self, db_id: u32) -> Option<&mut DatabaseCatalog>

pub fn clear(&mut self)

pub fn create_database(&mut self, db: &PbDatabase)

pub fn create_schema(&mut self, proto: &PbSchema)

pub fn create_table(&mut self, proto: &PbTable)

pub fn create_index(&mut self, proto: &PbIndex)

pub fn create_source(&mut self, proto: &PbSource)

pub fn create_sink(&mut self, proto: &PbSink)

pub fn create_subscription(&mut self, proto: &PbSubscription)

pub fn create_secret(&mut self, proto: &PbSecret)

pub fn create_view(&mut self, proto: &PbView)

pub fn create_function(&mut self, proto: &PbFunction)

pub fn create_connection(&mut self, proto: &PbConnection)

pub fn drop_connection( &mut self, db_id: u32, schema_id: u32, connection_id: u32, )

pub fn update_connection(&mut self, proto: &PbConnection)

pub fn update_secret(&mut self, proto: &PbSecret)

pub fn drop_database(&mut self, db_id: u32)

pub fn drop_schema(&mut self, db_id: u32, schema_id: u32)

pub fn drop_table(&mut self, db_id: u32, schema_id: u32, tb_id: TableId)

pub fn update_table(&mut self, proto: &PbTable)

pub fn update_database(&mut self, proto: &PbDatabase)

pub fn update_schema(&mut self, proto: &PbSchema)

pub fn update_index(&mut self, proto: &PbIndex)

pub fn drop_source(&mut self, db_id: u32, schema_id: u32, source_id: u32)

pub fn update_source(&mut self, proto: &PbSource)

pub fn drop_sink(&mut self, db_id: u32, schema_id: u32, sink_id: u32)

pub fn drop_secret(&mut self, db_id: u32, schema_id: u32, secret_id: SecretId)

pub fn update_sink(&mut self, proto: &PbSink)

pub fn drop_subscription( &mut self, db_id: u32, schema_id: u32, subscription_id: u32, )

pub fn update_subscription(&mut self, proto: &PbSubscription)

pub fn drop_index(&mut self, db_id: u32, schema_id: u32, index_id: IndexId)

pub fn drop_view(&mut self, db_id: u32, schema_id: u32, view_id: u32)

pub fn update_view(&mut self, proto: &PbView)

pub fn drop_function( &mut self, db_id: u32, schema_id: u32, function_id: FunctionId, )

pub fn update_function(&mut self, proto: &PbFunction)

pub fn get_database_by_name( &self, db_name: &str, ) -> Result<&DatabaseCatalog, CatalogError>

pub fn get_database_by_id( &self, db_id: &u32, ) -> Result<&DatabaseCatalog, CatalogError>

pub fn get_all_schema_names( &self, db_name: &str, ) -> Result<Vec<String>, CatalogError>

pub fn get_all_schema_info( &self, db_name: &str, ) -> Result<Vec<PbSchema>, CatalogError>

pub fn iter_schemas( &self, db_name: &str, ) -> Result<impl Iterator<Item = &SchemaCatalog>, CatalogError>

pub fn get_all_database_names(&self) -> Vec<String>

pub fn iter_databases(&self) -> impl Iterator<Item = &DatabaseCatalog>

pub fn get_schema_by_name( &self, db_name: &str, schema_name: &str, ) -> Result<&SchemaCatalog, CatalogError>

pub fn get_table_name_by_id( &self, table_id: TableId, ) -> Result<String, CatalogError>

pub fn get_schema_by_id( &self, db_id: &u32, schema_id: &u32, ) -> Result<&SchemaCatalog, CatalogError>

pub fn get_source_by_id( &self, db_id: &u32, schema_id: &u32, source_id: &u32, ) -> Result<&Arc<SourceCatalog>, CatalogError>

pub fn first_valid_schema( &self, db_name: &str, search_path: &SearchPath, user_name: &str, ) -> Result<&SchemaCatalog, CatalogError>

Refer to SearchPath.

pub fn get_any_table_by_name<'a>( &self, db_name: &str, schema_path: SchemaPath<'a>, table_name: &str, ) -> Result<(&Arc<TableCatalog>, &'a str), CatalogError>

Used to get TableCatalog for Materialized Views, Tables and Indexes. Retrieves all tables, created or creating.

pub fn get_created_table_by_name<'a>( &self, db_name: &str, schema_path: SchemaPath<'a>, table_name: &str, ) -> Result<(&Arc<TableCatalog>, &'a str), CatalogError>

Used to get TableCatalog for Materialized Views, Tables and Indexes. Retrieves only created tables.

pub fn get_any_table_by_id( &self, table_id: &TableId, ) -> Result<&Arc<TableCatalog>, CatalogError>

pub fn get_created_table_by_id_with_db( &self, db_name: &str, table_id: u32, ) -> Result<&Arc<TableCatalog>, CatalogError>

This function is similar to get_table_by_id expect that a table must be in a given database.

pub fn get_schema_by_table_id( &self, db_name: &str, table_id: &TableId, ) -> Result<&SchemaCatalog, CatalogError>

pub fn alter_table_name_by_id(&mut self, table_id: &TableId, table_name: &str)

pub fn get_sys_table_by_name( &self, db_name: &str, schema_name: &str, table_name: &str, ) -> Result<&Arc<SystemTableCatalog>, CatalogError>

pub fn get_source_by_name<'a>( &self, db_name: &str, schema_path: SchemaPath<'a>, source_name: &str, ) -> Result<(&Arc<SourceCatalog>, &'a str), CatalogError>

pub fn get_sink_by_name<'a>( &self, db_name: &str, schema_path: SchemaPath<'a>, sink_name: &str, ) -> Result<(&Arc<SinkCatalog>, &'a str), CatalogError>

pub fn get_subscription_by_name<'a>( &self, db_name: &str, schema_path: SchemaPath<'a>, subscription_name: &str, ) -> Result<(&Arc<SubscriptionCatalog>, &'a str), CatalogError>

pub fn get_index_by_name<'a>( &self, db_name: &str, schema_path: SchemaPath<'a>, index_name: &str, ) -> Result<(&Arc<IndexCatalog>, &'a str), CatalogError>

pub fn get_index_by_id( &self, db_name: &str, index_id: u32, ) -> Result<&Arc<IndexCatalog>, CatalogError>

pub fn get_view_by_name<'a>( &self, db_name: &str, schema_path: SchemaPath<'a>, view_name: &str, ) -> Result<(&Arc<ViewCatalog>, &'a str), CatalogError>

pub fn get_view_by_id( &self, db_name: &str, view_id: u32, ) -> Result<Arc<ViewCatalog>, CatalogError>

pub fn get_secret_by_name<'a>( &self, db_name: &str, schema_path: SchemaPath<'a>, secret_name: &str, ) -> Result<(&Arc<SecretCatalog>, &'a str), CatalogError>

pub fn get_connection_by_name<'a>( &self, db_name: &str, schema_path: SchemaPath<'a>, connection_name: &str, ) -> Result<(&Arc<ConnectionCatalog>, &'a str), CatalogError>

pub fn get_function_by_name_inputs<'a>( &self, db_name: &str, schema_path: SchemaPath<'a>, function_name: &str, inputs: &mut [ExprImpl], ) -> Result<(&Arc<FunctionCatalog>, &'a str), CatalogError>

pub fn get_function_by_name_args<'a>( &self, db_name: &str, schema_path: SchemaPath<'a>, function_name: &str, args: &[DataType], ) -> Result<(&Arc<FunctionCatalog>, &'a str), CatalogError>

pub fn get_functions_by_name<'a>( &self, db_name: &str, schema_path: SchemaPath<'a>, function_name: &str, ) -> Result<(Vec<&Arc<FunctionCatalog>>, &'a str), CatalogError>

Gets all functions with the given name.

pub fn check_relation_name_duplicated( &self, db_name: &str, schema_name: &str, relation_name: &str, ) -> Result<(), CatalogError>

Check if the name duplicates with existing table, materialized view or source.

pub fn check_function_name_duplicated( &self, db_name: &str, schema_name: &str, function_name: &str, arg_types: &[DataType], ) -> Result<(), CatalogError>

pub fn check_connection_name_duplicated( &self, db_name: &str, schema_name: &str, connection_name: &str, ) -> Result<(), CatalogError>

Check if the name duplicates with existing connection.

pub fn check_secret_name_duplicated( &self, db_name: &str, schema_name: &str, secret_name: &str, ) -> Result<(), CatalogError>

pub fn version(&self) -> u64

Get the catalog cache’s catalog version.

pub fn set_version(&mut self, catalog_version: CatalogVersion)

Set the catalog cache’s catalog version.

pub fn table_stats(&self) -> &HummockVersionStats

pub fn set_table_stats(&mut self, table_stats: HummockVersionStats)

pub fn get_all_indexes_related_to_object( &self, db_id: u32, schema_id: u32, mv_id: TableId, ) -> Vec<Arc<IndexCatalog>>

pub fn get_id_by_class_name( &self, db_name: &str, schema_path: SchemaPath<'_>, class_name: &str, ) -> Result<u32, CatalogError>

Trait Implementations

impl Default for Catalog

fn default() -> Self

Returns the “default value” for a type.