Skip to main content Module definitions Copy item path Source cluster_scheduling Configuration for how cluster replicas are scheduled. grpc_client Configuration for gRPC client connections. upsert_rocksdb Tuning for RocksDB used by UPSERT sources that takes effect on restart. feature_flags 🔒 Macro to simplify creating feature flags, i.e. boolean flags that we use to toggle the
availability of features. VarDefinition Definition of a variable. VarDefaultValue The kinds of compiled in default values that can be used with VarDefinition DEFAULT_DATABASE_NAME The name of the default database that Materialize uses. IS_SUPERUSER_NAME MZ_VERSION_NAME SCHEMA_ALIAS SERVER_MAJOR_VERSION The major version of PostgreSQL that Materialize claims to be. SERVER_MINOR_VERSION The minor version of PostgreSQL that Materialize claims to be. SERVER_PATCH_VERSION The patch version of PostgreSQL that Materialize claims to be. TRANSACTION_ISOLATION_VAR_NAME ALLOWED_CLUSTER_REPLICA_SIZES ALLOW_REAL_TIME_RECENCY ALLOW_REAL_TIME_RECENCY_VAR 🔒 APPLICATION_NAME AUTO_ROUTE_CATALOG_QUERIES CLIENT_ENCODING CLIENT_MIN_MESSAGES CLUSTER CLUSTER_REPLICA COORD_SLOW_MESSAGE_WARN_THRESHOLD CURRENT_OBJECT_MISSING_WARNINGS DATABASE DATE_STYLE DEFAULT_CLUSTER_REPLICATION_FACTOR DEFAULT_TIMESTAMP_INTERVAL DISALLOW_UNMATERIALIZABLE_FUNCTIONS_AS_OF DISALLOW_UNMATERIALIZABLE_FUNCTIONS_AS_OF_VAR 🔒 EMIT_INTROSPECTION_QUERY_NOTICE EMIT_PLAN_INSIGHTS_NOTICE EMIT_TIMESTAMP_NOTICE EMIT_TRACE_ID_NOTICE ENABLE_ALTER_SET_CLUSTER ENABLE_ALTER_SET_CLUSTER_VAR 🔒 ENABLE_ALTER_SWAP ENABLE_ALTER_SWAP_VAR 🔒 ENABLE_ALTER_TABLE_ADD_COLUMN ENABLE_ALTER_TABLE_ADD_COLUMN_VAR 🔒 ENABLE_BINARY_DATE_BIN ENABLE_BINARY_DATE_BIN_VAR 🔒 ENABLE_BOUNDED_STALENESS_ISOLATION ENABLE_BOUNDED_STALENESS_ISOLATION_VAR 🔒 ENABLE_CARDINALITY_ESTIMATES ENABLE_CARDINALITY_ESTIMATES_VAR 🔒 ENABLE_CASE_LITERAL_TRANSFORM ENABLE_CASE_LITERAL_TRANSFORM_VAR 🔒 ENABLE_CAST_ELIMINATION ENABLE_CAST_ELIMINATION_VAR 🔒 ENABLE_CLUSTER_SCHEDULE_REFRESH ENABLE_CLUSTER_SCHEDULE_REFRESH_VAR 🔒 ENABLE_COALESCE_CASE_TRANSFORM ENABLE_COALESCE_CASE_TRANSFORM_VAR 🔒 ENABLE_COLLECTION_PARTITION_BY ENABLE_COLLECTION_PARTITION_BY_VAR 🔒 ENABLE_CONNECTION_VALIDATION_SYNTAX ENABLE_CONNECTION_VALIDATION_SYNTAX_VAR 🔒 ENABLE_CREATE_TABLE_FROM_SOURCE ENABLE_CREATE_TABLE_FROM_SOURCE_VAR 🔒 ENABLE_DATE_BIN_HOPPING ENABLE_DATE_BIN_HOPPING_VAR 🔒 ENABLE_DEFAULT_CONNECTION_VALIDATION ENABLE_DEQUADRATIC_EQPROP_MAP ENABLE_DEQUADRATIC_EQPROP_MAP_VAR 🔒 ENABLE_EAGER_DELTA_JOINS ENABLE_EAGER_DELTA_JOINS_VAR 🔒 ENABLE_ENVELOPE_DEBEZIUM_IN_SUBSCRIBE ENABLE_ENVELOPE_DEBEZIUM_IN_SUBSCRIBE_VAR 🔒 ENABLE_ENVELOPE_MATERIALIZE ENABLE_ENVELOPE_MATERIALIZE_VAR 🔒 ENABLE_ENVELOPE_UPSERT_INLINE_ERRORS ENABLE_ENVELOPE_UPSERT_INLINE_ERRORS_VAR 🔒 ENABLE_EQ_CLASSES_WITHHOLDING_ERRORS ENABLE_EQ_CLASSES_WITHHOLDING_ERRORS_VAR 🔒 ENABLE_EXPLAIN_PUSHDOWN ENABLE_EXPLAIN_PUSHDOWN_VAR 🔒 ENABLE_EXPRESSIONS_IN_LIMIT_SYNTAX ENABLE_EXPRESSIONS_IN_LIMIT_SYNTAX_VAR 🔒 ENABLE_FAST_PATH_PLAN_INSIGHTS ENABLE_FAST_PATH_PLAN_INSIGHTS_VAR 🔒 ENABLE_FIXED_CORRELATED_CTE_LOWERING ENABLE_FIXED_CORRELATED_CTE_LOWERING_VAR 🔒 ENABLE_FRONTEND_PEEK_SEQUENCING ENABLE_FRONTEND_PEEK_SEQUENCING_VAR 🔒 ENABLE_GLUE_SCHEMA_REGISTRY ENABLE_GLUE_SCHEMA_REGISTRY_VAR 🔒 ENABLE_INDEX_OPTIONS ENABLE_INDEX_OPTIONS_VAR 🔒 ENABLE_INTERNAL_STATEMENT_LOGGING ENABLE_JOIN_PRIORITIZE_ARRANGED ENABLE_JOIN_PRIORITIZE_ARRANGED_VAR 🔒 ENABLE_KAFKA_BROKER_MATCHING_RULES ENABLE_KAFKA_BROKER_MATCHING_RULES_VAR 🔒 ENABLE_KAFKA_SINK_HEADERS ENABLE_KAFKA_SINK_HEADERS_VAR 🔒 ENABLE_LAUNCHDARKLY Boolean flag indicating whether to enable syncing from
LaunchDarkly. Can be turned off as an emergency measure to still
be able to alter parameters while LD is broken. ENABLE_LESS_REDUCE_IN_EQPROP ENABLE_LESS_REDUCE_IN_EQPROP_VAR 🔒 ENABLE_LETREC_FIXPOINT_ANALYSIS ENABLE_LETREC_FIXPOINT_ANALYSIS_VAR 🔒 ENABLE_LIST_LENGTH_MAX ENABLE_LIST_LENGTH_MAX_VAR 🔒 ENABLE_LIST_N_LAYERS ENABLE_LIST_N_LAYERS_VAR 🔒 ENABLE_LIST_REMOVE ENABLE_LIST_REMOVE_VAR 🔒 ENABLE_LOAD_GENERATOR_CLOCK ENABLE_LOAD_GENERATOR_CLOCK_VAR 🔒 ENABLE_LOAD_GENERATOR_COUNTER ENABLE_LOAD_GENERATOR_COUNTER_VAR 🔒 ENABLE_LOAD_GENERATOR_DATUMS ENABLE_LOAD_GENERATOR_DATUMS_VAR 🔒 ENABLE_LOAD_GENERATOR_KEY_VALUE ENABLE_LOAD_GENERATOR_KEY_VALUE_VAR 🔒 ENABLE_LOGICAL_COMPACTION_WINDOW ENABLE_LOGICAL_COMPACTION_WINDOW_VAR 🔒 ENABLE_MANAGED_CLUSTER_AVAILABILITY_ZONES ENABLE_MANAGED_CLUSTER_AVAILABILITY_ZONES_VAR 🔒 ENABLE_MULTI_WORKER_STORAGE_PERSIST_SINK ENABLE_MULTI_WORKER_STORAGE_PERSIST_SINK_VAR 🔒 ENABLE_MZ_NOTICES ENABLE_MZ_NOTICES_VAR 🔒 ENABLE_NETWORK_POLICIES ENABLE_NETWORK_POLICIES_VAR 🔒 ENABLE_NEW_OUTER_JOIN_LOWERING ENABLE_NEW_OUTER_JOIN_LOWERING_VAR 🔒 ENABLE_NOTICES_FOR_EQUALS_NULL ENABLE_NOTICES_FOR_EQUALS_NULL_VAR 🔒 ENABLE_NOTICES_FOR_INDEX_ALREADY_EXISTS ENABLE_NOTICES_FOR_INDEX_ALREADY_EXISTS_VAR 🔒 ENABLE_NOTICES_FOR_INDEX_EMPTY_KEY ENABLE_NOTICES_FOR_INDEX_EMPTY_KEY_VAR 🔒 ENABLE_NOTICES_FOR_INDEX_TOO_WIDE_FOR_LITERAL_CONSTRAINTS ENABLE_NOTICES_FOR_INDEX_TOO_WIDE_FOR_LITERAL_CONSTRAINTS_VAR 🔒 ENABLE_OFF_THREAD_OPTIMIZATION ENABLE_OFF_THREAD_OPTIMIZATION_VAR 🔒 ENABLE_PERSIST_STREAMING_COMPACTION ENABLE_PERSIST_STREAMING_COMPACTION_VAR 🔒 ENABLE_PERSIST_STREAMING_SNAPSHOT_AND_FETCH ENABLE_PERSIST_STREAMING_SNAPSHOT_AND_FETCH_VAR 🔒 ENABLE_PRIMARY_KEY_NOT_ENFORCED ENABLE_PRIMARY_KEY_NOT_ENFORCED_VAR 🔒 ENABLE_PROJECTION_PUSHDOWN_AFTER_RELATION_CSE ENABLE_PROJECTION_PUSHDOWN_AFTER_RELATION_CSE_VAR 🔒 ENABLE_RAISE_STATEMENT ENABLE_RAISE_STATEMENT_VAR 🔒 ENABLE_RBAC_CHECKS ENABLE_REDACTED_TEST_OPTION ENABLE_REDACTED_TEST_OPTION_VAR 🔒 ENABLE_REDUCE_MFP_FUSION ENABLE_REDUCE_MFP_FUSION_VAR 🔒 ENABLE_REFRESH_EVERY_MVS ENABLE_REFRESH_EVERY_MVS_VAR 🔒 ENABLE_REPEAT_ROW ENABLE_REPEAT_ROW_NON_NEGATIVE ENABLE_REPEAT_ROW_NON_NEGATIVE_VAR 🔒 ENABLE_REPEAT_ROW_VAR 🔒 ENABLE_REPLACEMENT_MATERIALIZED_VIEWS ENABLE_REPLACEMENT_MATERIALIZED_VIEWS_VAR 🔒 ENABLE_REPLICA_TARGETED_MATERIALIZED_VIEWS ENABLE_REPLICA_TARGETED_MATERIALIZED_VIEWS_VAR 🔒 ENABLE_SESSION_CARDINALITY_ESTIMATES ENABLE_SESSION_RBAC_CHECKS ENABLE_SESSION_TIMELINES ENABLE_SESSION_TIMELINES_VAR 🔒 ENABLE_SIMPLIFY_QUANTIFIED_COMPARISONS ENABLE_SIMPLIFY_QUANTIFIED_COMPARISONS_VAR 🔒 ENABLE_STATEMENT_ARRIVAL_LOGGING When on, the SQL frontends log incoming statements and other frontend
messages at info level as soon as they arrive, before processing them
(except that SQL text is parsed, for redaction). Messages consumed by
pgwire’s COPY subprotocol or its post-error drain loop are not logged. ENABLE_STORAGE_INTROSPECTION_LOGS ENABLE_STORAGE_INTROSPECTION_LOGS_VAR 🔒 ENABLE_STORAGE_SHARD_FINALIZATION ENABLE_TIME_AT_TIME_ZONE ENABLE_TIME_AT_TIME_ZONE_VAR 🔒 ENABLE_UNLIMITED_RETAIN_HISTORY ENABLE_UNLIMITED_RETAIN_HISTORY_VAR 🔒 ENABLE_VARIADIC_LEFT_JOIN_LOWERING ENABLE_VARIADIC_LEFT_JOIN_LOWERING_VAR 🔒 ENABLE_WILL_DISTINCT_PROPAGATION ENABLE_WILL_DISTINCT_PROPAGATION_VAR 🔒 ENABLE_WITHIN_TIMESTAMP_ORDER_BY_IN_SUBSCRIBE ENABLE_WITHIN_TIMESTAMP_ORDER_BY_IN_SUBSCRIBE_VAR 🔒 ENABLE_WITH_ORDINALITY_LEGACY_FALLBACK ENABLE_WITH_ORDINALITY_LEGACY_FALLBACK_VAR 🔒 ENABLE_WORKER_CORE_AFFINITY ENABLE_WORKER_CORE_AFFINITY_VAR 🔒 ENABLE_ZERO_DOWNTIME_CLUSTER_RECONFIGURATION ENABLE_ZERO_DOWNTIME_CLUSTER_RECONFIGURATION_VAR 🔒 EXTRA_FLOAT_DIGITS FAILPOINTS FEATURE_FLAGS FORCE_SOURCE_TABLE_SYNTAX IDLE_IN_TRANSACTION_SESSION_TIMEOUT INTEGER_DATETIMES INTERVAL_STYLE KAFKA_FETCH_METADATA_TIMEOUT Controls the timeout when fetching kafka metadata. Defaults to 10s. KAFKA_PROGRESS_RECORD_FETCH_TIMEOUT Controls the timeout when fetching kafka progress records. Defaults to 60s. KAFKA_SOCKET_CONNECTION_SETUP_TIMEOUT Controls socket.connection.setup.timeout.ms for rdkafka client connections. Defaults to the rdkafka default
(30000ms). Cannot be greater than i32::MAX or less than 1000ms KAFKA_SOCKET_KEEPALIVE Enables socket.keepalive.enable for rdkafka client connections. Defaults to true. KAFKA_SOCKET_TIMEOUT Controls socket.timeout.ms for rdkafka client connections. Defaults to the rdkafka default
(60000ms). Cannot be greater than 300000ms, more than 100ms greater than
kafka_transaction_timeout, or less than 10ms. KAFKA_TRANSACTION_TIMEOUT Controls transaction.timeout.ms for rdkafka client connections. Defaults to the rdkafka default
(60000ms). Cannot be greater than i32::MAX or less than 1000ms. KEEP_N_PRIVATELINK_STATUS_HISTORY_ENTRIES Controls mz_storage_types::parameters::StorageParameters::keep_n_privatelink_status_history_entries KEEP_N_SINK_STATUS_HISTORY_ENTRIES Controls mz_storage_types::parameters::StorageParameters::keep_n_sink_status_history_entries KEEP_N_SOURCE_STATUS_HISTORY_ENTRIES Controls mz_storage_types::parameters::StorageParameters::keep_n_source_status_history_entries LOGGING_FILTER LOGGING_FILTER_DEFAULTS MAX_AWS_PRIVATELINK_CONNECTIONS MAX_CLUSTERS MAX_CONNECTIONS MAX_COPY_FROM_ROW_SIZE MAX_CREDIT_CONSUMPTION_RATE MAX_DATABASES MAX_IDENTIFIER_LENGTH MAX_KAFKA_CONNECTIONS MAX_MATERIALIZED_VIEWS MAX_MYSQL_CONNECTIONS MAX_NETWORK_POLICIES MAX_OBJECTS_PER_SCHEMA MAX_POSTGRES_CONNECTIONS MAX_QUERY_RESULT_SIZE MAX_REPLICAS_PER_CLUSTER MAX_RESULT_SIZE MAX_ROLES MAX_RULES_PER_NETWORK_POLICY MAX_SCHEMAS_PER_DATABASE MAX_SECRETS MAX_SINKS MAX_SOURCES MAX_SQL_SERVER_CONNECTIONS MAX_TABLES MAX_TIMESTAMP_INTERVAL METRICS_RETENTION The logical compaction window for builtin tables and sources that have the
retained_metrics_relation flag set. MIN_TIMESTAMP_INTERVAL MYSQL_SOURCE_CONNECT_TIMEOUT Sets the timeout for establishing an authenticated connection to MySQL MYSQL_SOURCE_SNAPSHOT_LOCK_WAIT_TIMEOUT Sets the lock_wait_timeout value to use during the snapshotting phase of
MySQL sources. MYSQL_SOURCE_SNAPSHOT_MAX_EXECUTION_TIME Sets the max_execution_time value to use during the snapshotting phase of
MySQL sources. MYSQL_SOURCE_TCP_KEEPALIVE Sets the time between TCP keepalive probes when connecting to MySQL via mz_mysql_util. NETWORK_POLICY OPENTELEMETRY_FILTER OPENTELEMETRY_FILTER_DEFAULTS OPTIMIZER_E2E_LATENCY_WARNING_THRESHOLD OPTIMIZER_ONESHOT_STATS_TIMEOUT OPTIMIZER_STATS_TIMEOUT PERSIST_FAST_PATH_LIMIT PG_SOURCE_CONNECT_TIMEOUT Controls the connect_timeout setting when connecting to PG via mz_postgres_util. PG_SOURCE_SNAPSHOT_COLLECT_STRICT_COUNT Please see PgSourceSnapshotConfig. PG_SOURCE_SNAPSHOT_STATEMENT_TIMEOUT Sets the statement_timeout value to use during the snapshotting phase of
PG sources. PG_SOURCE_TCP_CONFIGURE_SERVER Sets whether to apply the TCP configuration parameters on the server when
connecting to PG via mz_postgres_util. PG_SOURCE_TCP_KEEPALIVES_IDLE Sets the amount of idle time before a keepalive packet is sent on the connection when connecting
to PG via mz_postgres_util. PG_SOURCE_TCP_KEEPALIVES_INTERVAL Sets the time interval between TCP keepalive probes when connecting to PG via mz_postgres_util. PG_SOURCE_TCP_KEEPALIVES_RETRIES Sets the maximum number of TCP keepalive probes that will be sent before dropping a connection
when connecting to PG via mz_postgres_util. PG_SOURCE_TCP_USER_TIMEOUT Sets the TCP user timeout when connecting to PG via mz_postgres_util. PG_SOURCE_WAL_SENDER_TIMEOUT Sets the wal_sender_timeout value to use during the replication phase of
PG sources. PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_SIZE Controls mz_adapter::coord::timestamp_oracle::postgres_oracle::DynamicConfig::pg_connection_pool_max_size. PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_WAIT Controls mz_adapter::coord::timestamp_oracle::postgres_oracle::DynamicConfig::pg_connection_pool_max_wait. PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL Controls mz_adapter::coord::timestamp_oracle::postgres_oracle::DynamicConfig::pg_connection_pool_ttl. PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL_STAGGER Controls mz_adapter::coord::timestamp_oracle::postgres_oracle::DynamicConfig::pg_connection_pool_ttl_stagger. PRIVATELINK_STATUS_UPDATE_QUOTA_PER_MINUTE REAL_TIME_RECENCY Feature flag indicating whether real time recency is enabled. Not that
unlike other feature flags, this is made available at the session level, so
is additionally gated by a feature flag. REAL_TIME_RECENCY_TIMEOUT REPLICA_STATUS_HISTORY_RETENTION_WINDOW Controls mz_storage_types::parameters::StorageParameters::replica_status_history_retention_window RESTRICT_TO_USER_OBJECTS SCRAM_ITERATIONS SEARCH_PATH SENTRY_FILTERS SERVER_VERSION SERVER_VERSION_NUM SQL_SAFE_UPDATES SSH_CHECK_INTERVAL Controls the check interval for connections to SSH bastions via mz_ssh_util. SSH_CONNECT_TIMEOUT Controls the connect timeout for connections to SSH bastions via mz_ssh_util. SSH_KEEPALIVES_IDLE Controls the keepalive idle interval for connections to SSH bastions via mz_ssh_util. STANDARD_CONFORMING_STRINGS STATEMENT_LOGGING_DEFAULT_SAMPLE_RATE STATEMENT_LOGGING_MAX_DATA_CREDIT STATEMENT_LOGGING_MAX_SAMPLE_RATE STATEMENT_LOGGING_SAMPLE_RATE STATEMENT_LOGGING_TARGET_DATA_RATE STATEMENT_LOGGING_USE_REPRODUCIBLE_RNG STATEMENT_LOGGING_USE_REPRODUCIBLE_RNG_VAR 🔒 STATEMENT_TIMEOUT STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES The maximum number of in-flight bytes emitted by persist_sources feeding storage
dataflows .
Currently defaults to 256MiB = 268435456 bytes
Note: Backpressure will only be turned on if disk is enabled based on
storage_dataflow_max_inflight_bytes_disk_only flag STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_DISK_ONLY STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_TO_CLUSTER_SIZE_FRACTION The fraction of the cluster replica size to be used as the maximum number of
in-flight bytes emitted by persist_sources feeding storage dataflows.
If not configured, the storage_dataflow_max_inflight_bytes value will be used.
For this value to be used storage_dataflow_max_inflight_bytes needs to be set. STORAGE_RECORD_SOURCE_SINK_NAMESPACED_ERRORS STORAGE_SHRINK_UPSERT_UNUSED_BUFFERS_BY_RATIO Configuration ratio to shrink unusef buffers in upsert by.
For eg: is 2 is set, then the buffers will be reduced by 2 i.e. halved.
Default is 0, which means shrinking is disabled. STORAGE_STATISTICS_COLLECTION_INTERVAL The interval to collect statistics for mz_source_statistics_per_worker and mz_sink_statistics_per_worker in
clusterd. Controls the accuracy of metrics. STORAGE_STATISTICS_INTERVAL The interval to submit statistics to mz_source_statistics_per_worker and mz_sink_statistics_per_worker. SUPERUSER_RESERVED_CONNECTIONS TIMEZONE TRANSACTION_ISOLATION UNSAFE_ENABLE_TABLE_CHECK_CONSTRAINT UNSAFE_ENABLE_TABLE_CHECK_CONSTRAINT_VAR 🔒 UNSAFE_ENABLE_TABLE_FOREIGN_KEY UNSAFE_ENABLE_TABLE_FOREIGN_KEY_VAR 🔒 UNSAFE_ENABLE_TABLE_KEYS UNSAFE_ENABLE_TABLE_KEYS_VAR 🔒 UNSAFE_ENABLE_UNBOUNDED_CUSTOM_TYPE_RESOLUTION UNSAFE_ENABLE_UNBOUNDED_CUSTOM_TYPE_RESOLUTION_VAR 🔒 UNSAFE_ENABLE_UNORCHESTRATED_CLUSTER_REPLICAS UNSAFE_ENABLE_UNORCHESTRATED_CLUSTER_REPLICAS_VAR 🔒 UNSAFE_ENABLE_UNSAFE_FUNCTIONS UNSAFE_ENABLE_UNSAFE_FUNCTIONS_VAR 🔒 UNSAFE_ENABLE_UNSTABLE_DEPENDENCIES UNSAFE_ENABLE_UNSTABLE_DEPENDENCIES_VAR 🔒 UNSAFE_MOCK_AUDIT_EVENT_TIMESTAMP UNSAFE_NEW_TRANSACTION_WALL_TIME USER_STORAGE_MANAGED_COLLECTIONS_BATCH_DURATION WEBHOOKS_SECRETS_CACHING_TTL_SECS WEBHOOK_CONCURRENT_REQUEST_LIMIT WELCOME_MESSAGE