Module ddl

Data definition language (DDL).

This module houses the handlers for statements that modify the catalog, like ALTER, CREATE, and DROP.

Modules

connection 🔒

Data definition language (DDL) utilities for CONNECTION objects.

Structs

AlterConnectionOptionExtracted

AlterSourceAddSubsourceOptionExtracted

AvroSchemaOptionExtracted

ClusterAlterOptionExtracted

ClusterAlterUntilReadyOptionExtracted

ClusterFeatureExtracted

ClusterOptionExtracted

ContinualTaskOptionExtracted

CreateConnectionOptionExtracted

CreateSinkOptionExtracted

CreateSourceOptionExtracted

CreateSubsourceOptionExtracted

CreateTypeListOptionExtracted

CreateTypeMapOptionExtracted

CsrConfigOptionExtracted

Creating this by hand instead of using generate_extracted_config! macro because the macro doesn’t support parameterized enums. See https://github.com/MaterializeInc/database-issues/issues/6698

IndexOptionExtracted

LoadGeneratorOptionExtracted

MaterializedViewOptionExtracted

MySqlConfigOptionExtracted

NetworkPolicyOptionExtracted

NetworkPolicyRuleOptionExtracted

PgConfigOptionExtracted

PlannedRoleAttributes

ReplicaOptionExtracted

Schema

SqlServerConfigOptionExtracted

TableFromSourceOptionExtracted

TableOptionExtracted

Enums

PlannedAlterRoleOption

PlannedRoleVariable

Constants

MAX_NUM_COLUMNS 🔒

Statics

MANAGED_REPLICA_PATTERN 🔒

Functions

alter_retain_history 🔒

apply_source_envelope_encoding 🔒

check_partition_by 🔒

Given a relation desc and a column list, checks that:

contains_single_replica_objects 🔒

Returns true if the cluster has any object that requires a single replica. Returns false if the cluster has no objects.

continual_task_query 🔒

dependency_prevents_drop 🔒

Does the dependency dep prevent a drop of a non-cascade query?

describe_alter_cluster_set_options

describe_alter_connection

describe_alter_index_options

describe_alter_network_policy

describe_alter_object_rename

describe_alter_object_swap

describe_alter_retain_history

describe_alter_role

describe_alter_secret_options

describe_alter_set_cluster

describe_alter_sink

describe_alter_source

describe_alter_system_reset

describe_alter_system_reset_all

describe_alter_system_set

describe_alter_table_add_column

describe_comment

describe_create_cluster

describe_create_cluster_replica

describe_create_connection

describe_create_continual_task

describe_create_database

describe_create_index

describe_create_materialized_view

describe_create_network_policy

describe_create_role

describe_create_schema

describe_create_secret

describe_create_sink

describe_create_source

describe_create_subsource

describe_create_table

describe_create_table_from_source

describe_create_type

describe_create_view

describe_create_webhook_source

describe_drop_objects

describe_drop_owned

ensure_cluster_is_not_managed 🔒

Returns an error if the given cluster is a managed cluster

get_encoding 🔒

get_encoding_inner 🔒

get_key_envelope 🔒

Extract the key envelope, if it is requested

get_unnamed_key_envelope 🔒

Gets the key envelope for a given key encoding when no name for the key has been requested by the user.

kafka_sink_builder 🔒

key_constraint_err 🔒

load_generator_ast_to_generator 🔒

plan_alter_cluster

plan_alter_cluster_rename

plan_alter_cluster_replica_rename

plan_alter_cluster_swap

plan_alter_connection

plan_alter_index_options

plan_alter_item_rename

plan_alter_item_set_cluster

plan_alter_network_policy

plan_alter_object_rename

plan_alter_object_swap

plan_alter_retain_history

plan_alter_role

plan_alter_schema_rename

plan_alter_schema_swap

plan_alter_secret

plan_alter_sink

plan_alter_source

plan_alter_system_reset

plan_alter_system_reset_all

plan_alter_system_set

plan_alter_table_add_column

plan_cluster_schedule 🔒

Convert a ClusterScheduleOptionValue into a ClusterSchedule.

plan_comment

plan_compute_replica_config 🔒

Convert an Option<OptionalDuration> and bool into a ComputeReplicaConfig.

plan_create_cluster

Convert a CreateClusterStatement into a Plan.

plan_create_cluster_inner

plan_create_cluster_replica

plan_create_connection

plan_create_continual_task

plan_create_database

plan_create_index

plan_create_materialized_view

plan_create_network_policy

plan_create_role

plan_create_schema

plan_create_secret

plan_create_sink

plan_create_source

plan_create_subsource

plan_create_table

plan_create_table_from_source

plan_create_type

plan_create_view

plan_create_webhook_source

plan_drop_cluster 🔒

plan_drop_cluster_replica 🔒

plan_drop_database 🔒

plan_drop_item 🔒

Returns the CatalogItemId of the item we should drop, if it exists.

plan_drop_network_policy 🔒

plan_drop_objects

plan_drop_owned

plan_drop_role 🔒

plan_drop_schema 🔒

plan_index_options 🔒

plan_replica_config 🔒

plan_retain_history 🔒

plan_retain_history_option 🔒

plan_role_attributes 🔒

plan_role_variable 🔒

plan_sink 🔒

This function will plan a sink as if it does not exist in the catalog. This is so the planning logic is reused by both CREATE SINK and ALTER SINK planning. It is the responsibility of the callers (plan_create_sink and plan_alter_sink) to check for name collisions if this is important.

plan_source_export_desc 🔒

Plans the RelationDesc for a source export (subsource or table) that has a defined list of columns and constraints.

plan_table_options 🔒

plan_view

resolve_cluster 🔒

resolve_cluster_replica 🔒

resolve_database 🔒

resolve_item_or_type 🔒

resolve_network_policy 🔒

resolve_schema 🔒

source_sink_cluster_config 🔒

Determine the cluster ID to use for this item.

typecheck_debezium 🔒

unplan_cluster_schedule 🔒

Convert a ClusterSchedule into a ClusterScheduleOptionValue.

unplan_compute_replica_config 🔒

Convert a ComputeReplicaConfig into an Option<OptionalDuration> and bool.

unplan_create_cluster

Convert a CreateClusterPlan into a CreateClusterStatement.