Module introspection 

Read-only catalog introspection queries.

Methods on IntrospectionClient query the mz_catalog and information_schema to inspect the live environment without modifying it. Provides batch existence checks for schemas, clusters, and objects, as well as dependency lookups used during deployment planning and sink repointing.

Structs

DependentSink

A sink that depends on an object in a schema being dropped.

Functions

auto_scaling_query_parts 🔒

SQL fragments (a select expression and a join) that add the configured autoscaling policy to a cluster query. On regions that predate the feature, they yield a NULL policy column instead.

check_catalog_objects_exist 🔒

Check which objects from the given set exist in a specific catalog table.

check_clusters_exist 🔒

Check which clusters from a set of names exist.

check_connection_exists 🔒

Check if a connection exists in the specified database and schema.

check_connections_exist 🔒

Check which connections from the given set exist in the database.

check_objects_exist 🔒

Check which objects from a set exist in the production database.

check_schemas_exist 🔒

Check which schemas from a set of (database, schema) pairs exist.

check_secrets_exist 🔒

Check which secrets from the given set exist in the database.

check_sinks_exist 🔒

Check which sinks from the given set exist in the database.

check_sources_exist 🔒

Check which sources from the given set exist in the database.

check_tables_exist 🔒

Check which tables from the given set exist in the database.

cluster_exists 🔒

Check if a cluster exists.

drop_objects 🔒

Drop specific objects by their ObjectIds.

drop_schema_objects 🔒

Drop all objects in a schema.

drop_staging_clusters 🔒

Drop staging clusters by name.

drop_staging_schemas 🔒

Drop staging schemas by name.

find_sinks_depending_on_schemas 🔒

Find sinks that depend on objects in the specified schemas.

get_cluster 🔒

Get a cluster by name.

get_cluster_config 🔒

Get cluster configuration including replicas and grants.

get_cluster_grants 🔒

Get privilege grants on a cluster by name.

get_connection_create_sql 🔒

Get the CREATE CONNECTION SQL for an existing connection.

get_current_user 🔒

Get the current Materialize user/role.

get_database_object_grants 🔒

Get privilege grants on a database object (table, source, secret, connection).

get_default_privilege_grants_for_cluster 🔒

Get default privilege grants for a cluster by name.

get_default_privilege_grants_for_database_object 🔒

Get default privilege grants for a database object (table, source, secret, connection).

get_default_privilege_grants_for_named_object 🔒

Get default privilege grants for a named infrastructure object (cluster, network policy).

get_default_privilege_grants_for_network_policy 🔒

Get default privilege grants for a network policy by name.

get_named_object_grants 🔒

Get privilege grants on a named infrastructure object (cluster, network policy).

get_network_policy_grants 🔒

Get privilege grants on a network policy by name.

get_role_members 🔒

Get the members granted to a role.

get_role_parameters 🔒

Get session default parameter names for a role.

get_staging_clusters 🔒

Get staging cluster names for a specific deployment.

get_staging_schemas 🔒

Get staging schema names for a specific deployment.

list_clusters 🔒

List all clusters.

mz_type_to_drop_keyword 🔒

Map a Materialize object type string to its DROP keyword.

network_policy_exists 🔒

Check if a network policy exists.

object_exists 🔒

Check if an object (MV, table, source) exists in the specified schema.

parse_auto_scaling_strategy 🔒

The cluster’s configured autoscaling policy, read from the auto_scaling_strategy column of a cluster query row. A NULL column means “no policy”: the cluster has none, or the region predates the feature.

role_exists 🔒

Check if a role exists.

schema_exists 🔒

Check if a schema exists in the specified database.