Struct mz_adapter::catalog::ConnCatalog

pub struct ConnCatalog<'a> {
    state: Cow<'a, CatalogState>,
    unresolvable_ids: BTreeSet<CatalogItemId>,
    conn_id: ConnectionId,
    cluster: String,
    database: Option<DatabaseId>,
    search_path: Vec<(ResolvedDatabaseSpecifier, SchemaSpecifier)>,
    role_id: RoleId,
    prepared_statements: Option<&'a BTreeMap<String, PreparedStatement>>,
    notices_tx: UnboundedSender<AdapterNotice>,
}

Fields

state: Cow<'a, CatalogState>

unresolvable_ids: BTreeSet<CatalogItemId>

Because we don’t have any way of removing items from the catalog temporarily, we allow the ConnCatalog to pretend that a set of items don’t exist during resolution.

This feature is necessary to allow re-planning of statements, which is either incredibly useful or required when altering item definitions.

Note that uses of this field should be used by short-lived catalogs.

conn_id: ConnectionId

cluster: String

database: Option<DatabaseId>

search_path: Vec<(ResolvedDatabaseSpecifier, SchemaSpecifier)>

role_id: RoleId

prepared_statements: Option<&'a BTreeMap<String, PreparedStatement>>

notices_tx: UnboundedSender<AdapterNotice>

Implementations

impl ConnCatalog<'_>

pub fn conn_id(&self) -> &ConnectionId

pub fn state(&self) -> &CatalogState

pub fn mark_id_unresolvable_for_replanning(&mut self, id: CatalogItemId)

Prevent planning from resolving item with the provided ID. Instead, return an error as if the item did not exist.

This feature is meant exclusively to permit re-planning statements during update operations and should not be used otherwise given its extremely “powerful” semantics.

Panics

If the catalog’s role ID is not MZ_SYSTEM_ROLE_ID.

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

Returns the schemas:

• mz_catalog
• pg_catalog
• temp (if requested)
• all schemas from the session’s search_path var that exist

impl ConnCatalog<'_>

fn resolve_item_name( &self, name: &PartialItemName, ) -> Result<&QualifiedItemName, SqlCatalogError>

fn resolve_function_name( &self, name: &PartialItemName, ) -> Result<&QualifiedItemName, SqlCatalogError>

fn resolve_type_name( &self, name: &PartialItemName, ) -> Result<&QualifiedItemName, SqlCatalogError>

Trait Implementations

impl ConnectionResolver for ConnCatalog<'_>

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

impl<'a> Debug for ConnCatalog<'a>

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

Formats the value using the given formatter.

impl ExprHumanizer for ConnCatalog<'_>

fn humanize_id(&self, id: GlobalId) -> Option<String>

Attempts to return a human-readable string for the relation identified by id.

fn humanize_id_unqualified(&self, id: GlobalId) -> Option<String>

Same as above, but without qualifications, e.g., only foo for materialize.public.foo.

fn humanize_id_parts(&self, id: GlobalId) -> Option<Vec<String>>

Like Self::humanize_id, but returns the constituent parts of the name as individual elements.

fn humanize_scalar_type(&self, typ: &ScalarType) -> String

Returns a human-readable name for the specified scalar type.

fn column_names_for_id(&self, id: GlobalId) -> Option<Vec<String>>

Returns a vector of column names for the relation identified by id.

fn humanize_column(&self, id: GlobalId, column: usize) -> Option<String>

Returns the #column name for the relation identified by id.

fn id_exists(&self, id: GlobalId) -> bool

Returns whether the specified id exists.

fn humanize_column_type(&self, typ: &ColumnType) -> String

Returns a human-readable name for the specified column type.

impl SessionCatalog for ConnCatalog<'_>

fn minimal_qualification( &self, qualified_name: &QualifiedItemName, ) -> PartialItemName

Returns a PartialItemName with the minimum amount of qualifiers to unambiguously resolve the object.

fn active_role_id(&self) -> &RoleId

Returns the id of the role that is issuing the query.

fn get_prepared_statement_desc(&self, name: &str) -> Option<&StatementDesc>

Returns the descriptor of the named prepared statement on the session, or None if the prepared statement does not exist.

fn active_database(&self) -> Option<&DatabaseId>

Returns the database to use if one is not explicitly specified.

fn active_cluster(&self) -> &str

Returns the cluster to use if one is not explicitly specified.

fn search_path(&self) -> &[(ResolvedDatabaseSpecifier, SchemaSpecifier)]

Returns the resolved search paths for the current user. (Invalid search paths are skipped.)

fn resolve_database( &self, database_name: &str, ) -> Result<&dyn CatalogDatabase, SqlCatalogError>

Resolves the named database.

fn get_database(&self, id: &DatabaseId) -> &dyn CatalogDatabase

Gets a database by its ID.

fn get_databases(&self) -> Vec<&dyn CatalogDatabase>

Gets all databases.

fn resolve_schema( &self, database_name: Option<&str>, schema_name: &str, ) -> Result<&dyn CatalogSchema, SqlCatalogError>

Resolves a partially-specified schema name.

fn resolve_schema_in_database( &self, database_spec: &ResolvedDatabaseSpecifier, schema_name: &str, ) -> Result<&dyn CatalogSchema, SqlCatalogError>

Resolves a schema name within a specified database.

fn get_schema( &self, database_spec: &ResolvedDatabaseSpecifier, schema_spec: &SchemaSpecifier, ) -> &dyn CatalogSchema

Gets a schema by its ID.

fn get_schemas(&self) -> Vec<&dyn CatalogSchema>

Gets all schemas.

fn get_mz_internal_schema_id(&self) -> SchemaId

Gets the mz_internal schema id.

fn get_mz_unsafe_schema_id(&self) -> SchemaId

Gets the mz_unsafe schema id.

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

Returns true if schema is an internal system schema, false otherwise

fn resolve_role( &self, role_name: &str, ) -> Result<&dyn CatalogRole, SqlCatalogError>

Resolves the named role.

fn resolve_network_policy( &self, policy_name: &str, ) -> Result<&dyn CatalogNetworkPolicy, SqlCatalogError>

Resolves the named network policy.

fn try_get_role(&self, id: &RoleId) -> Option<&dyn CatalogRole>

Gets a role by its ID.

fn get_role(&self, id: &RoleId) -> &dyn CatalogRole

Gets a role by its ID.

fn get_roles(&self) -> Vec<&dyn CatalogRole>

Gets all roles.

fn mz_system_role_id(&self) -> RoleId

Gets the id of the mz_system role.

fn collect_role_membership(&self, id: &RoleId) -> BTreeSet<RoleId>

Collects all role IDs that id is transitively a member of.

fn get_network_policy(&self, id: &NetworkPolicyId) -> &dyn CatalogNetworkPolicy

Resolves the named cluster. Gets a network_policy by its ID.

fn get_network_policies(&self) -> Vec<&dyn CatalogNetworkPolicy>

Gets all roles.

fn resolve_cluster( &self, cluster_name: Option<&str>, ) -> Result<&dyn CatalogCluster<'_>, SqlCatalogError>

If the provided name is None, resolves the currently active cluster.

fn resolve_cluster_replica( &self, cluster_replica_name: &QualifiedReplica, ) -> Result<&dyn CatalogClusterReplica<'_>, SqlCatalogError>

Resolves the named cluster replica.

fn resolve_item( &self, name: &PartialItemName, ) -> Result<&dyn CatalogItem, SqlCatalogError>

Resolves a partially-specified item name, that is NOT a function or type. (For resolving functions or types, please use SessionCatalog::resolve_function or SessionCatalog::resolve_type.)

fn resolve_function( &self, name: &PartialItemName, ) -> Result<&dyn CatalogItem, SqlCatalogError>

Performs the same operation as SessionCatalog::resolve_item but for functions within the catalog.

fn resolve_type( &self, name: &PartialItemName, ) -> Result<&dyn CatalogItem, SqlCatalogError>

Performs the same operation as SessionCatalog::resolve_item but for types within the catalog.

fn get_system_type(&self, name: &str) -> &dyn CatalogItem

Gets a type named name from exactly one of the system schemas.

fn try_get_item(&self, id: &CatalogItemId) -> Option<&dyn CatalogItem>

Gets an item by its ID.

fn try_get_item_by_global_id( &self, id: &GlobalId, ) -> Option<Box<dyn CatalogCollectionItem>>

Tries to get an item by a GlobalId, returning None if the GlobalId does not exist.

fn get_item(&self, id: &CatalogItemId) -> &dyn CatalogItem

Gets an item by its ID.

fn get_item_by_global_id(&self, id: &GlobalId) -> Box<dyn CatalogCollectionItem>

Gets an item by a GlobalId.

fn get_items(&self) -> Vec<&dyn CatalogItem>

Gets all items.

fn get_item_by_name( &self, name: &QualifiedItemName, ) -> Option<&dyn SqlCatalogItem>

Looks up an item by its name.

fn get_type_by_name( &self, name: &QualifiedItemName, ) -> Option<&dyn SqlCatalogItem>

Looks up a type by its name.

fn get_cluster(&self, id: ClusterId) -> &dyn CatalogCluster<'_>

Gets a cluster by ID.

fn get_clusters(&self) -> Vec<&dyn CatalogCluster<'_>>

Gets all clusters.

fn get_cluster_replica( &self, cluster_id: ClusterId, replica_id: ReplicaId, ) -> &dyn CatalogClusterReplica<'_>

Gets a cluster replica by ID.

fn get_cluster_replicas(&self) -> Vec<&dyn CatalogClusterReplica<'_>>

Gets all cluster replicas.

fn get_system_privileges(&self) -> &PrivilegeMap

Gets all system privileges.

fn get_default_privileges( &self, ) -> Vec<(&DefaultPrivilegeObject, Vec<&DefaultPrivilegeAclItem>)>

Gets all default privileges.

fn find_available_name(&self, name: QualifiedItemName) -> QualifiedItemName

Finds a name like name that is not already in use.

fn resolve_full_name(&self, name: &QualifiedItemName) -> FullItemName

Returns a fully qualified human readable name from fully qualified non-human readable name

fn resolve_full_schema_name(&self, name: &QualifiedSchemaName) -> FullSchemaName

Returns a fully qualified human readable schema name from fully qualified non-human readable schema name

fn resolve_item_id(&self, global_id: &GlobalId) -> CatalogItemId

Returns the CatalogItemId for from a GlobalId.

fn resolve_global_id( &self, item_id: &CatalogItemId, version: RelationVersionSelector, ) -> GlobalId

Returns the GlobalId for the specificed Catalog Item, at the specified version.

fn config(&self) -> &CatalogConfig

Returns the configuration of the catalog.

fn now(&self) -> EpochMillis

Returns the number of milliseconds since the system epoch. For normal use this means the Unix epoch. This can safely be mocked in tests and start at 0.

fn aws_privatelink_availability_zones(&self) -> Option<BTreeSet<String>>

Returns the set of supported AWS PrivateLink availability zone ids.

fn system_vars(&self) -> &SystemVars

Returns system vars

fn system_vars_mut(&mut self) -> &mut SystemVars

Returns mutable system vars

fn get_owner_id(&self, id: &ObjectId) -> Option<RoleId>

Returns the RoleId of the owner of an object by its ID.

fn get_privileges(&self, id: &SystemObjectId) -> Option<&PrivilegeMap>

Returns the PrivilegeMap of the object.

fn object_dependents(&self, ids: &Vec<ObjectId>) -> Vec<ObjectId>

Returns all the IDs of all objects that depend on ids, including ids themselves.

fn item_dependents(&self, id: CatalogItemId) -> Vec<ObjectId>

Returns all the IDs of all objects that depend on id, including id themselves.

fn all_object_privileges(&self, object_type: SystemObjectType) -> AclMode

Returns all possible privileges associated with an object type.

fn get_object_type(&self, object_id: &ObjectId) -> ObjectType

Returns the object type of object_id.

fn get_system_object_type(&self, id: &SystemObjectId) -> SystemObjectType

Returns the system object type of id.

fn add_notice(&self, notice: PlanNotice)

Adds a PlanNotice that will be displayed to the user if the plan successfully executes.

fn get_item_comments( &self, id: &CatalogItemId, ) -> Option<&BTreeMap<Option<usize>, String>>

Returns the associated comments for the given id

fn is_cluster_size_cc(&self, size: &str) -> bool

Reports whether the specified cluster size is a modern “cc” size rather than a legacy T-shirt size.

fn active_database_name(&self) -> Option<&str>

Returns the database to use if one is not explicitly specified.

fn resolve_item_or_type( &self, name: &PartialItemName, ) -> Result<&dyn CatalogItem, CatalogError>

Resolves name to a type or item, preferring the type if both exist.