Struct mz_sql::session::vars::SystemVars

pub struct SystemVars { /* private fields */ }

On disk variables.

See the crate::session::vars module documentation for more details on the Materialize configuration model.

Implementations

impl SystemVars

pub fn enable_all_feature_flags_by_default(&mut self)

pub fn enable_for_item_parsing(&mut self)

pub fn allow_real_time_recency(&self) -> bool

pub fn enable_binary_date_bin(&self) -> bool

pub fn enable_create_sink_denylist_with_options(&self) -> bool

pub fn enable_create_source_denylist_with_options(&self) -> bool

pub fn enable_date_bin_hopping(&self) -> bool

pub fn enable_envelope_debezium_in_subscribe(&self) -> bool

pub fn enable_envelope_materialize(&self) -> bool

pub fn enable_explain_pushdown(&self) -> bool

pub fn enable_index_options(&self) -> bool

pub fn enable_list_length_max(&self) -> bool

pub fn enable_list_n_layers(&self) -> bool

pub fn enable_list_remove(&self) -> bool

pub fn enable_logical_compaction_window(&self) -> bool

pub fn enable_primary_key_not_enforced(&self) -> bool

pub fn enable_multi_worker_storage_persist_sink(&self) -> bool

pub fn enable_persist_streaming_snapshot_and_fetch(&self) -> bool

pub fn enable_persist_streaming_compaction(&self) -> bool

pub fn enable_raise_statement(&self) -> bool

pub fn enable_repeat_row(&self) -> bool

pub fn enable_table_check_constraint(&self) -> bool

pub fn enable_table_foreign_key(&self) -> bool

pub fn enable_table_keys(&self) -> bool

pub fn enable_unorchestrated_cluster_replicas(&self) -> bool

pub fn enable_unstable_dependencies(&self) -> bool

pub fn enable_disk_cluster_replicas(&self) -> bool

pub fn enable_within_timestamp_order_by_in_subscribe(&self) -> bool

pub fn enable_cardinality_estimates(&self) -> bool

pub fn enable_connection_validation_syntax(&self) -> bool

pub fn enable_alter_set_cluster(&self) -> bool

pub fn enable_unsafe_functions(&self) -> bool

pub fn enable_managed_cluster_availability_zones(&self) -> bool

pub fn statement_logging_use_reproducible_rng(&self) -> bool

pub fn enable_notices_for_index_already_exists(&self) -> bool

pub fn enable_notices_for_index_too_wide_for_literal_constraints(&self) -> bool

pub fn enable_notices_for_index_empty_key(&self) -> bool

pub fn enable_comment(&self) -> bool

pub fn enable_alter_swap(&self) -> bool

pub fn enable_new_outer_join_lowering(&self) -> bool

pub fn enable_time_at_time_zone(&self) -> bool

pub fn enable_aws_connection(&self) -> bool

pub fn enable_mysql_source(&self) -> bool

pub fn enable_load_generator_key_value(&self) -> bool

pub fn enable_expressions_in_limit_syntax(&self) -> bool

pub fn enable_mz_notices(&self) -> bool

pub fn enable_eager_delta_joins(&self) -> bool

pub fn enable_off_thread_optimization(&self) -> bool

pub fn enable_refresh_every_mvs(&self) -> bool

pub fn enable_cluster_schedule_refresh(&self) -> bool

pub fn enable_reduce_mfp_fusion(&self) -> bool

pub fn enable_worker_core_affinity(&self) -> bool

pub fn wait_catalog_consolidation_on_startup(&self) -> bool

pub fn enable_copy_to_expr(&self) -> bool

pub fn enable_session_timelines(&self) -> bool

pub fn enable_variadic_left_join_lowering(&self) -> bool

pub fn enable_redacted_test_option(&self) -> bool

pub fn enable_letrec_fixpoint_analysis(&self) -> bool

impl SystemVars

pub fn new(active_connection_count: Arc<Mutex<ConnectionCounter>>) -> Self

pub fn dyncfgs(&self) -> &ConfigSet

pub fn set_unsafe(self, allow_unsafe: bool) -> Self

pub fn allow_unsafe(&self) -> bool

pub fn reset_all(&mut self)

Reset all the values to their defaults (preserving defaults from `VarMut::set_default).

pub fn iter(&self) -> impl Iterator<Item = &dyn Var>

Returns an iterator over the configuration parameters and their current values on disk.

pub fn iter_synced(&self) -> impl Iterator<Item = &dyn Var>

Returns an iterator over the configuration parameters and their current values on disk. Compared to SystemVars::iter, this should omit vars that shouldn’t be synced by SystemParameterFrontend.

pub fn iter_session(&self) -> impl Iterator<Item = &dyn Var>

Returns an iterator over the configuration parameters that can be overriden per-Session.

pub fn user_modifiable(&self, name: &str) -> bool

Returns whether or not this parameter can be modified by a superuser.

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

Returns a Var representing the configuration parameter with the specified name.

Configuration parameters are matched case insensitively. If no such configuration parameter exists, get returns an error.

Note that:

• If name is known at compile time, you should instead use the named accessor to access the variable with its true Rust type. For example, self.get("max_tables").value() returns the string "25" or the current value, while self.max_tables() returns an i32.

• This function does not check that the access variable should be visible because of other settings or users. Before or after accessing this method, you should call Var::visible.

Errors

The call will return an error:

1. If name does not refer to a valid SystemVars field.

pub fn is_default( &self, name: &str, input: VarInput<'_> ) -> Result<bool, VarError>

Check if the given values is the default value for the Var identified by name.

Note that this function does not check that the access variable should be visible because of other settings or users. Before or after accessing this method, you should call Var::visible.

Errors

The call will return an error:

1. If name does not refer to a valid SystemVars field.
2. If values does not represent a valid SystemVars value for name.

pub fn set(&mut self, name: &str, input: VarInput<'_>) -> Result<bool, VarError>

Sets the configuration parameter named name to the value represented by value.

Like with SystemVars::get, configuration parameters are matched case insensitively. If value is not valid, as determined by the underlying configuration parameter, or if the named configuration parameter does not exist, an error is returned.

Return a bool value indicating whether the Var identified by name was modified by this call (it won’t be if it already had the given value).

Note that this function does not check that the access variable should be visible because of other settings or users. Before or after accessing this method, you should call Var::visible.

Errors

The call will return an error:

1. If name does not refer to a valid SystemVars field.
2. If value does not represent a valid SystemVars value for name.

pub fn set_default( &mut self, name: &str, input: VarInput<'_> ) -> Result<(), VarError>

Set the default for this variable. This is the value this variable will be be reset to. If no default is set, the static default in the variable definition is used instead.

Note that this function does not check that the access variable should be visible because of other settings or users. Before or after accessing this method, you should call Var::visible.

pub fn reset(&mut self, name: &str) -> Result<bool, VarError>

Sets the configuration parameter named name to its default value.

Like with SystemVars::get, configuration parameters are matched case insensitively. If the named configuration parameter does not exist, an error is returned.

Return a bool value indicating whether the Var identified by name was modified by this call (it won’t be if was already reset).

Note that this function does not check that the access variable should be visible because of other settings or users. Before or after accessing this method, you should call Var::visible.

Errors

The call will return an error:

1. If name does not refer to a valid SystemVars field.

pub fn defaults(&self) -> BTreeMap<String, String>

Returns a map from each system parameter’s name to its default value.

pub fn default_cluster(&self) -> String

Returns the system default for the CLUSTER session variable. To know the active cluster for the current session, you must check the SessionVars.

pub fn max_kafka_connections(&self) -> u32

Returns the value of the max_kafka_connections configuration parameter.

pub fn max_postgres_connections(&self) -> u32

Returns the value of the max_postgres_connections configuration parameter.

pub fn max_aws_privatelink_connections(&self) -> u32

Returns the value of the max_aws_privatelink_connections configuration parameter.

pub fn max_tables(&self) -> u32

Returns the value of the max_tables configuration parameter.

pub fn max_sources(&self) -> u32

Returns the value of the max_sources configuration parameter.

pub fn max_sinks(&self) -> u32

Returns the value of the max_sinks configuration parameter.

pub fn max_materialized_views(&self) -> u32

Returns the value of the max_materialized_views configuration parameter.

pub fn max_clusters(&self) -> u32

Returns the value of the max_clusters configuration parameter.

pub fn max_replicas_per_cluster(&self) -> u32

Returns the value of the max_replicas_per_cluster configuration parameter.

pub fn max_credit_consumption_rate(&self) -> Numeric

Returns the value of the max_credit_consumption_rate configuration parameter.

pub fn max_databases(&self) -> u32

Returns the value of the max_databases configuration parameter.

pub fn max_schemas_per_database(&self) -> u32

Returns the value of the max_schemas_per_database configuration parameter.

pub fn max_objects_per_schema(&self) -> u32

Returns the value of the max_objects_per_schema configuration parameter.

pub fn max_secrets(&self) -> u32

Returns the value of the max_secrets configuration parameter.

pub fn max_roles(&self) -> u32

Returns the value of the max_roles configuration parameter.

pub fn max_result_size(&self) -> u64

Returns the value of the max_result_size configuration parameter.

pub fn max_copy_from_size(&self) -> u32

Returns the value of the max_copy_from_size configuration parameter.

pub fn allowed_cluster_replica_sizes(&self) -> Vec<String>

Returns the value of the allowed_cluster_replica_sizes configuration parameter.

pub fn disk_cluster_replicas_default(&self) -> bool

Returns the disk_cluster_replicas_default configuration parameter.

pub fn upsert_rocksdb_auto_spill_to_disk(&self) -> bool

pub fn upsert_rocksdb_auto_spill_threshold_bytes(&self) -> usize

pub fn upsert_rocksdb_compaction_style(&self) -> CompactionStyle

pub fn upsert_rocksdb_optimize_compaction_memtable_budget(&self) -> usize

pub fn upsert_rocksdb_level_compaction_dynamic_level_bytes(&self) -> bool

pub fn upsert_rocksdb_universal_compaction_ratio(&self) -> i32

pub fn upsert_rocksdb_parallelism(&self) -> Option<i32>

pub fn upsert_rocksdb_compression_type(&self) -> CompressionType

pub fn upsert_rocksdb_bottommost_compression_type(&self) -> CompressionType

pub fn upsert_rocksdb_batch_size(&self) -> usize

pub fn upsert_rocksdb_retry_duration(&self) -> Duration

pub fn upsert_rocksdb_stats_log_interval_seconds(&self) -> u32

pub fn upsert_rocksdb_stats_persist_interval_seconds(&self) -> u32

pub fn upsert_rocksdb_point_lookup_block_cache_size_mb(&self) -> Option<u32>

pub fn upsert_rocksdb_shrink_allocated_buffers_by_ratio(&self) -> usize

pub fn upsert_rocksdb_write_buffer_manager_cluster_memory_fraction( &self ) -> Option<Numeric>

pub fn upsert_rocksdb_write_buffer_manager_memory_bytes(&self) -> Option<usize>

pub fn upsert_rocksdb_write_buffer_manager_allow_stall(&self) -> bool

pub fn persist_fast_path_limit(&self) -> usize

pub fn persist_txn_tables(&self) -> PersistTxnTablesImpl

pub fn pg_source_connect_timeout(&self) -> Duration

Returns the pg_source_connect_timeout configuration parameter.

pub fn pg_source_keepalives_retries(&self) -> u32

Returns the pg_source_keepalives_retries configuration parameter.

pub fn pg_source_keepalives_idle(&self) -> Duration

Returns the pg_source_keepalives_idle configuration parameter.

pub fn pg_source_keepalives_interval(&self) -> Duration

Returns the pg_source_keepalives_interval configuration parameter.

pub fn pg_source_tcp_user_timeout(&self) -> Duration

Returns the pg_source_tcp_user_timeout configuration parameter.

pub fn pg_source_snapshot_statement_timeout(&self) -> Duration

Returns the pg_source_snapshot_statement_timeout configuration parameter.

pub fn pg_source_wal_sender_timeout(&self) -> Duration

Returns the pg_source_wal_sender_timeout configuration parameter.

pub fn pg_source_snapshot_collect_strict_count(&self) -> bool

Returns the pg_source_snapshot_collect_strict_count configuration parameter.

pub fn pg_source_snapshot_fallback_to_strict_count(&self) -> bool

Returns the pg_source_snapshot_fallback_to_strict_count configuration parameter.

pub fn pg_source_snapshot_wait_for_count(&self) -> bool

Returns the pg_source_snapshot_collect_strict_count configuration parameter.

pub fn mysql_source_tcp_keepalive(&self) -> Duration

Returns the mysql_source_tcp_keepalive configuration parameter.

pub fn mysql_source_snapshot_max_execution_time(&self) -> Duration

Returns the mysql_source_snapshot_max_execution_time configuration parameter.

pub fn mysql_source_snapshot_lock_wait_timeout(&self) -> Duration

Returns the mysql_source_snapshot_lock_wait_timeout configuration parameter.

pub fn ssh_check_interval(&self) -> Duration

Returns the ssh_check_interval configuration parameter.

pub fn ssh_connect_timeout(&self) -> Duration

Returns the ssh_connect_timeout configuration parameter.

pub fn ssh_keepalives_idle(&self) -> Duration

Returns the ssh_keepalives_idle configuration parameter.

pub fn kafka_socket_keepalive(&self) -> bool

Returns the kafka_socket_keepalive configuration parameter.

pub fn kafka_socket_timeout(&self) -> Duration

Returns the kafka_socket_timeout configuration parameter.

pub fn kafka_transaction_timeout(&self) -> Duration

Returns the kafka_transaction_timeout configuration parameter.

pub fn kafka_socket_connection_setup_timeout(&self) -> Duration

Returns the kafka_socket_connection_setup_timeout configuration parameter.

pub fn kafka_fetch_metadata_timeout(&self) -> Duration

Returns the kafka_fetch_metadata_timeout configuration parameter.

pub fn kafka_progress_record_fetch_timeout(&self) -> Duration

Returns the kafka_progress_record_fetch_timeout configuration parameter.

pub fn kafka_default_metadata_fetch_interval(&self) -> Duration

Returns the kafka_default_metadata_fetch_interval configuration parameter.

pub fn crdb_connect_timeout(&self) -> Duration

Returns the crdb_connect_timeout configuration parameter.

pub fn crdb_tcp_user_timeout(&self) -> Duration

Returns the crdb_tcp_user_timeout configuration parameter.

pub fn storage_dataflow_max_inflight_bytes(&self) -> Option<usize>

Returns the storage_dataflow_max_inflight_bytes configuration parameter.

pub fn storage_dataflow_max_inflight_bytes_to_cluster_size_fraction( &self ) -> Option<Numeric>

Returns the storage_dataflow_max_inflight_bytes_to_cluster_size_fraction configuration parameter.

pub fn storage_shrink_upsert_unused_buffers_by_ratio(&self) -> usize

Returns the storage_shrink_upsert_unused_buffers_by_ratio configuration parameter.

pub fn storage_dataflow_max_inflight_bytes_disk_only(&self) -> bool

Returns the storage_dataflow_max_inflight_bytes_disk_only configuration parameter.

pub fn storage_statistics_interval(&self) -> Duration

Returns the storage_statistics_interval configuration parameter.

pub fn storage_statistics_collection_interval(&self) -> Duration

Returns the storage_statistics_collection_interval configuration parameter.

pub fn storage_record_source_sink_namespaced_errors(&self) -> bool

Returns the storage_record_source_sink_namespaced_errors configuration parameter.

pub fn persist_stats_filter_enabled(&self) -> bool

Returns the persist_stats_filter_enabled configuration parameter.

pub fn dyncfg_updates(&self) -> ConfigUpdates

pub fn metrics_retention(&self) -> Duration

Returns the metrics_retention configuration parameter.

pub fn unsafe_mock_audit_event_timestamp(&self) -> Option<Timestamp>

Returns the unsafe_mock_audit_event_timestamp configuration parameter.

pub fn enable_rbac_checks(&self) -> bool

Returns the enable_rbac_checks configuration parameter.

pub fn max_connections(&self) -> u32

Returns the max_connections configuration parameter.

pub fn superuser_reserved_connections(&self) -> u32

Returns the superuser_reserved_connections configuration parameter.

pub fn keep_n_source_status_history_entries(&self) -> usize

pub fn keep_n_sink_status_history_entries(&self) -> usize

pub fn keep_n_privatelink_status_history_entries(&self) -> usize

pub fn arrangement_exert_proportionality(&self) -> u32

Returns the arrangement_exert_proportionality configuration parameter.

pub fn enable_storage_shard_finalization(&self) -> bool

Returns the enable_storage_shard_finalization configuration parameter.

pub fn enable_consolidate_after_union_negate(&self) -> bool

pub fn enable_default_connection_validation(&self) -> bool

Returns the enable_default_connection_validation configuration parameter.

pub fn min_timestamp_interval(&self) -> Duration

Returns the min_timestamp_interval configuration parameter.

pub fn max_timestamp_interval(&self) -> Duration

Returns the max_timestamp_interval configuration parameter.

pub fn logging_filter(&self) -> CloneableEnvFilter

pub fn opentelemetry_filter(&self) -> CloneableEnvFilter

pub fn logging_filter_defaults(&self) -> Vec<SerializableDirective>

pub fn opentelemetry_filter_defaults(&self) -> Vec<SerializableDirective>

pub fn sentry_filters(&self) -> Vec<SerializableDirective>

pub fn webhooks_secrets_caching_ttl_secs(&self) -> usize

pub fn coord_slow_message_warn_threshold(&self) -> Duration

pub fn grpc_client_http2_keep_alive_interval(&self) -> Duration

pub fn grpc_client_http2_keep_alive_timeout(&self) -> Duration

pub fn grpc_connect_timeout(&self) -> Duration

pub fn cluster_multi_process_replica_az_affinity_weight(&self) -> Option<i32>

pub fn cluster_soften_replication_anti_affinity(&self) -> bool

pub fn cluster_soften_replication_anti_affinity_weight(&self) -> i32

pub fn cluster_enable_topology_spread(&self) -> bool

pub fn cluster_topology_spread_ignore_non_singular_scale(&self) -> bool

pub fn cluster_topology_spread_max_skew(&self) -> i32

pub fn cluster_topology_spread_soft(&self) -> bool

pub fn cluster_soften_az_affinity(&self) -> bool

pub fn cluster_soften_az_affinity_weight(&self) -> i32

pub fn cluster_always_use_disk(&self) -> bool

pub fn cluster_check_scheduling_policies_interval(&self) -> Duration

pub fn privatelink_status_update_quota_per_minute(&self) -> u32

Returns the privatelink_status_update_quota_per_minute configuration parameter.

pub fn statement_logging_target_data_rate(&self) -> Option<usize>

pub fn statement_logging_max_data_credit(&self) -> Option<usize>

pub fn statement_logging_max_sample_rate(&self) -> Numeric

Returns the statement_logging_max_sample_rate configuration parameter.

pub fn statement_logging_default_sample_rate(&self) -> Numeric

Returns the statement_logging_default_sample_rate configuration parameter.

pub fn optimizer_stats_timeout(&self) -> Duration

Returns the optimizer_stats_timeout configuration parameter.

pub fn optimizer_oneshot_stats_timeout(&self) -> Duration

Returns the optimizer_oneshot_stats_timeout configuration parameter.

pub fn webhook_concurrent_request_limit(&self) -> usize

Returns the webhook_concurrent_request_limit configuration parameter.

pub fn pg_timestamp_oracle_connection_pool_max_size(&self) -> usize

Returns the pg_timestamp_oracle_connection_pool_max_size configuration parameter.

pub fn pg_timestamp_oracle_connection_pool_max_wait(&self) -> Option<Duration>

Returns the pg_timestamp_oracle_connection_pool_max_wait configuration parameter.

pub fn pg_timestamp_oracle_connection_pool_ttl(&self) -> Duration

Returns the pg_timestamp_oracle_connection_pool_ttl configuration parameter.

pub fn pg_timestamp_oracle_connection_pool_ttl_stagger(&self) -> Duration

Returns the pg_timestamp_oracle_connection_pool_ttl_stagger configuration parameter.

pub fn enable_dependency_read_hold_asserts(&self) -> bool

pub fn user_storage_managed_collections_batch_duration(&self) -> Duration

Returns the user_storage_managed_collections_batch_duration configuration parameter.

pub fn is_compute_config_var(&self, name: &str) -> bool

Returns whether the named variable is a compute configuration parameter (things that go in ComputeParameters and are sent to replicas via UpdateConfiguration commands).

pub fn is_storage_config_var(&self, name: &str) -> bool

Returns whether the named variable is a storage configuration parameter.

Trait Implementations

impl Clone for SystemVars

fn clone(&self) -> SystemVars

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SystemVars

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

Formats the value using the given formatter.

impl Default for SystemVars

fn default() -> Self

Returns the “default value” for a type.

impl From<&SystemVars> for Config

fn from(vars: &SystemVars) -> Self

Converts to this type from the input type.

impl From<&SystemVars> for OptimizerFeatures

fn from(vars: &SystemVars) -> Self

Converts to this type from the input type.