Struct mz_adapter::catalog::CatalogState

pub struct CatalogState { /* private fields */ }

The in-memory representation of the Catalog. This struct is not directly used to persist metadata to persistent storage. For persistent metadata see mz_catalog::durable::DurableCatalogState.

Serialize is implemented to create human readable dumps of the in-memory state, not for storing the contents of this struct on disk.

Implementations

impl CatalogState

pub fn pack_depends_update( &self, depender: GlobalId, dependee: GlobalId, diff: Diff ) -> BuiltinTableUpdate

pub fn pack_aws_privatelink_connection_update( &self, connection_id: GlobalId, aws_principal_context: &AwsPrincipalContext, diff: Diff ) -> BuiltinTableUpdate

pub fn pack_aws_connection_update( &self, connection_id: GlobalId, aws_config: &AwsConnection, diff: Diff ) -> Result<BuiltinTableUpdate, Error>

pub fn pack_op_update( &self, operator: &str, func_impl_details: FuncImplCatalogDetails, diff: Diff ) -> BuiltinTableUpdate

pub fn pack_audit_log_update( &self, event: &VersionedEvent, diff: Diff ) -> Result<BuiltinTableUpdate, Error>

pub fn pack_storage_usage_update( &self, VersionedStorageUsage::V1: &VersionedStorageUsage, diff: Diff ) -> BuiltinTableUpdate

pub fn pack_egress_ip_update( &self, ip: &Ipv4Addr ) -> Result<BuiltinTableUpdate, Error>

pub fn pack_replica_metric_updates( &self, replica_id: ReplicaId, updates: &[ServiceProcessMetrics], diff: Diff ) -> Vec<BuiltinTableUpdate>

pub fn pack_all_replica_size_updates(&self) -> Vec<BuiltinTableUpdate>

pub fn pack_subscribe_update( &self, id: GlobalId, subscribe: &ActiveSubscribe, diff: Diff ) -> BuiltinTableUpdate

pub fn pack_session_update( &self, conn: &ConnMeta, diff: Diff ) -> BuiltinTableUpdate

pub fn pack_default_privileges_update( &self, default_privilege_object: &DefaultPrivilegeObject, grantee: &RoleId, acl_mode: &AclMode, diff: Diff ) -> BuiltinTableUpdate

pub fn pack_system_privileges_update( &self, privileges: MzAclItem, diff: Diff ) -> BuiltinTableUpdate

pub fn pack_comment_update( &self, object_id: CommentObjectId, column_pos: Option<usize>, comment: &str, diff: Diff ) -> BuiltinTableUpdate

pub fn pack_webhook_source_update( &self, source_id: GlobalId, diff: Diff ) -> BuiltinTableUpdate

impl CatalogState

pub fn check_consistency(&self) -> Result<(), Box<CatalogInconsistencies>>

Checks the CatalogState to make sure we’re internally consistent.

impl CatalogState

pub fn empty() -> Self

pub fn for_session<'a>(&'a self, session: &'a Session) -> ConnCatalog<'a>

pub fn for_sessionless_user(&self, role_id: RoleId) -> ConnCatalog<'_>

pub fn for_system_session(&self) -> ConnCatalog<'_>

pub fn dependent_indexes(&self, id: GlobalId) -> Vec<GlobalId>

Computes the IDs of any indexes that transitively depend on this catalog entry.

pub fn transitive_uses( &self, id: GlobalId ) -> impl Iterator<Item = GlobalId> + '_

Returns an iterator over the deduplicated identifiers of all objects this catalog entry transitively depends on (where “depends on” is meant in the sense of CatalogItem::uses, rather than CatalogItem::references).

pub fn introspection_dependencies(&self, id: GlobalId) -> Vec<GlobalId>

Computes the IDs of any log sources this catalog entry transitively depends on.

pub fn resolve_full_name( &self, name: &QualifiedItemName, conn_id: Option<&ConnectionId> ) -> FullItemName

pub fn get_entry(&self, id: &GlobalId) -> &CatalogEntry

pub fn get_entry_mut(&mut self, id: &GlobalId) -> &mut CatalogEntry

pub fn get_item_by_name( &self, name: &QualifiedItemName, conn_id: &ConnectionId ) -> Option<&CatalogEntry>

pub fn get_type_by_name( &self, name: &QualifiedItemName, conn_id: &ConnectionId ) -> Option<&CatalogEntry>

pub fn try_get_entry(&self, id: &GlobalId) -> Option<&CatalogEntry>

pub fn get_role(&self, id: &RoleId) -> &Role

pub fn get_roles(&self) -> impl Iterator<Item = &RoleId>

pub fn try_get_webhook_url(&self, id: &GlobalId) -> Option<Url>

Returns the URL for POST-ing data to a webhook source, if id corresponds to a webhook source.

Note: Identifiers for the source, e.g. item name, are URL encoded.

pub fn parse_view_item(&self, create_sql: String) -> Result<CatalogItem, Error>

Parse a SQL string into a catalog view item with only a limited context.

pub fn get_indexes_on( &self, id: GlobalId, cluster: ClusterId ) -> impl Iterator<Item = (GlobalId, &Index)>

Returns all indexes on the given object and cluster known in the catalog.

pub fn get_system_configuration(&self, name: &str) -> Result<&dyn Var, Error>

Get system configuration name.

pub fn get_schema( &self, database_spec: &ResolvedDatabaseSpecifier, schema_spec: &SchemaSpecifier, conn_id: &ConnectionId ) -> &Schema

pub fn get_mz_catalog_schema_id(&self) -> &SchemaId

pub fn get_pg_catalog_schema_id(&self) -> &SchemaId

pub fn get_information_schema_id(&self) -> &SchemaId

pub fn get_mz_internal_schema_id(&self) -> &SchemaId

pub fn get_mz_unsafe_schema_id(&self) -> &SchemaId

pub fn is_system_schema(&self, schema: &str) -> bool

pub fn is_system_schema_id(&self, id: &SchemaId) -> bool

pub fn is_system_schema_specifier(&self, spec: &SchemaSpecifier) -> bool

pub fn create_temporary_schema( &mut self, conn_id: &ConnectionId, owner_id: RoleId ) -> Result<(), Error>

Creates a new schema in the Catalog for temporary items indicated by the TEMPORARY or TEMP keywords.

pub fn resolve_builtin_table(&self, builtin: &'static BuiltinTable) -> GlobalId

Optimized lookup for a builtin table.

Panics if the builtin table doesn’t exist in the catalog.

pub fn resolve_builtin_log(&self, builtin: &'static BuiltinLog) -> GlobalId

Optimized lookup for a builtin log.

Panics if the builtin log doesn’t exist in the catalog.

pub fn resolve_builtin_source( &self, builtin: &'static BuiltinSource ) -> GlobalId

Optimized lookup for a builtin storage collection.

Panics if the builtin storage collection doesn’t exist in the catalog.

pub fn resolve_builtin_object<T: TypeReference>( &self, builtin: &Builtin<T> ) -> GlobalId

Optimized lookup for a builtin object.

Panics if the builtin object doesn’t exist in the catalog.

pub fn resolve_builtin_type_references( &self, builtin: &BuiltinType<NameReference> ) -> BuiltinType<IdReference>

Resolve a BuiltinType<NameReference> to a BuiltinType<IdReference>.

pub fn config(&self) -> &CatalogConfig

pub fn resolve_database( &self, database_name: &str ) -> Result<&Database, SqlCatalogError>

pub fn resolve_schema( &self, current_database: Option<&DatabaseId>, database_name: Option<&str>, schema_name: &str, conn_id: &ConnectionId ) -> Result<&Schema, SqlCatalogError>

pub fn resolve_system_schema(&self, name: &str) -> SchemaId

Optimized lookup for a system schema.

Panics if the system schema doesn’t exist in the catalog.

pub fn resolve_search_path( &self, session: &dyn SessionMetadata ) -> Vec<(ResolvedDatabaseSpecifier, SchemaSpecifier)>

pub fn effective_search_path( &self, search_path: &[(ResolvedDatabaseSpecifier, SchemaSpecifier)], include_temp_schema: bool ) -> Vec<(ResolvedDatabaseSpecifier, SchemaSpecifier)>

pub fn resolve_cluster(&self, name: &str) -> Result<&Cluster, SqlCatalogError>

pub fn resolve_builtin_cluster(&self, cluster: &BuiltinCluster) -> &Cluster

pub fn resolve_cluster_replica( &self, cluster_replica_name: &QualifiedReplica ) -> Result<&ClusterReplica, SqlCatalogError>

pub fn resolve( &self, get_schema_entries: fn(_: &Schema) -> &BTreeMap<String, GlobalId>, current_database: Option<&DatabaseId>, search_path: &Vec<(ResolvedDatabaseSpecifier, SchemaSpecifier)>, name: &PartialItemName, conn_id: &ConnectionId, err_gen: fn(_: String) -> SqlCatalogError ) -> Result<&CatalogEntry, SqlCatalogError>

Resolves PartialItemName into a CatalogEntry.

If name does not specify a database, the current_database is used. If name does not specify a schema, then the schemas in search_path are searched in order.

pub fn resolve_entry( &self, current_database: Option<&DatabaseId>, search_path: &Vec<(ResolvedDatabaseSpecifier, SchemaSpecifier)>, name: &PartialItemName, conn_id: &ConnectionId ) -> Result<&CatalogEntry, SqlCatalogError>

Resolves name to a non-function CatalogEntry.

pub fn resolve_function( &self, current_database: Option<&DatabaseId>, search_path: &Vec<(ResolvedDatabaseSpecifier, SchemaSpecifier)>, name: &PartialItemName, conn_id: &ConnectionId ) -> Result<&CatalogEntry, SqlCatalogError>

Resolves name to a function CatalogEntry.

pub fn resolve_type( &self, current_database: Option<&DatabaseId>, search_path: &Vec<(ResolvedDatabaseSpecifier, SchemaSpecifier)>, name: &PartialItemName, conn_id: &ConnectionId ) -> Result<&CatalogEntry, SqlCatalogError>

Resolves name to a type CatalogEntry.

pub fn system_config(&self) -> &SystemVars

Return current system configuration.

pub fn dump(&self) -> Result<String, Error>

Serializes the catalog’s in-memory state.

There are no guarantees about the format of the serialized state, except that the serialized state for two identical catalogs will compare identically.

pub fn availability_zones(&self) -> &[String]

pub fn concretize_replica_location( &self, location: ReplicaLocation, allowed_sizes: &Vec<String>, allowed_availability_zones: Option<&[String]> ) -> Result<ReplicaLocation, Error>

pub fn ensure_not_reserved_role(&self, role_id: &RoleId) -> Result<(), Error>

pub fn ensure_grantable_role(&self, role_id: &RoleId) -> Result<(), Error>

pub fn ensure_not_system_role(&self, role_id: &RoleId) -> Result<(), Error>

pub fn ensure_not_predefined_role(&self, role_id: &RoleId) -> Result<(), Error>

pub fn storage_metadata(&self) -> &StorageMetadata

Returns a read-only view of the current StorageMetadata.

To write to this struct, you must use a Transaction, followed by a call to update_storage_metadata.

Trait Implementations

impl Clone for CatalogState

fn clone(&self) -> CatalogState

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConnectionResolver for CatalogState

fn resolve_connection(&self, id: GlobalId) -> Connection<InlinedConnection>

impl Debug for CatalogState

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

Formats the value using the given formatter.

impl Serialize for CatalogState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.