Struct mz_adapter::session::vars::SystemVars

pub struct SystemVars {

    config_has_synced_once: SystemVar<bool>,
    max_aws_privatelink_connections: SystemVar<u32>,
    max_tables: SystemVar<u32>,
    max_sources: SystemVar<u32>,
    max_sinks: SystemVar<u32>,
    max_materialized_views: SystemVar<u32>,
    max_clusters: SystemVar<u32>,
    max_replicas_per_cluster: SystemVar<u32>,
    max_databases: SystemVar<u32>,
    max_schemas_per_database: SystemVar<u32>,
    max_objects_per_schema: SystemVar<u32>,
    max_secrets: SystemVar<u32>,
    max_roles: SystemVar<u32>,
    max_result_size: SystemVar<u32>,
    allowed_cluster_replica_sizes: SystemVar<Vec<Ident>>,
    enable_with_mutually_recursive: SystemVar<bool>,
    persist_blob_target_size: SystemVar<usize>,
    persist_compaction_minimum_timeout: SystemVar<Duration>,
    persist_sink_minimum_batch_updates: SystemVar<usize>,
    crdb_connect_timeout: SystemVar<Duration>,
    dataflow_max_inflight_bytes: SystemVar<usize>,
    metrics_retention: SystemVar<Duration>,
    mock_audit_event_timestamp: SystemVar<Option<Timestamp>>,
}

On disk variables.

See SessionVars for more details on the Materialize configuration model.

Fields

config_has_synced_once: SystemVar<bool>

max_aws_privatelink_connections: SystemVar<u32>

max_tables: SystemVar<u32>

max_sources: SystemVar<u32>

max_sinks: SystemVar<u32>

max_materialized_views: SystemVar<u32>

max_clusters: SystemVar<u32>

max_replicas_per_cluster: SystemVar<u32>

max_databases: SystemVar<u32>

max_schemas_per_database: SystemVar<u32>

max_objects_per_schema: SystemVar<u32>

max_secrets: SystemVar<u32>

max_roles: SystemVar<u32>

max_result_size: SystemVar<u32>

allowed_cluster_replica_sizes: SystemVar<Vec<Ident>>

enable_with_mutually_recursive: SystemVar<bool>

persist_blob_target_size: SystemVar<usize>

persist_compaction_minimum_timeout: SystemVar<Duration>

persist_sink_minimum_batch_updates: SystemVar<usize>

crdb_connect_timeout: SystemVar<Duration>

dataflow_max_inflight_bytes: SystemVar<usize>

metrics_retention: SystemVar<Duration>

mock_audit_event_timestamp: SystemVar<Option<Timestamp>>

Implementations

impl SystemVars

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 crate::config::SystemParameterFrontend.

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

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.

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, AdapterError>

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

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, AdapterError>

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).

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 reset(&mut self, name: &str) -> Result<bool, AdapterError>

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).

Errors

The call will return an error:

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

pub fn config_has_synced_once(&self) -> bool

Returns the config_has_synced_once 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_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) -> u32

Returns the value of the max_result_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 persist_blob_target_size(&self) -> usize

Returns the persist_blob_target_size configuration parameter.

pub fn persist_compaction_minimum_timeout(&self) -> Duration

Returns the persist_compaction_minimum_timeout configuration parameter.

pub fn crdb_connect_timeout(&self) -> Duration

Returns the crdb_connect_timeout configuration parameter.

pub fn dataflow_max_inflight_bytes(&self) -> usize

Returns the dataflow_max_inflight_bytes configuration parameter.

pub fn persist_sink_minimum_batch_updates(&self) -> usize

Returns the persist_sink_minimum_batch_updates configuration parameter.

pub fn metrics_retention(&self) -> Duration

Returns the metrics_retention configuration parameter.

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

Returns the mock_audit_event_timestamp configuration parameter.

pub fn enable_with_mutually_recursive(&self) -> bool

Returns the enable_with_mutually_recursive configuration parameter.

pub fn set_enable_with_mutually_recursive(&mut self, value: bool) -> bool

Sets the enable_with_mutually_recursive 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.