Struct mz_storage_types::parameters::StorageParameters

pub struct StorageParameters {

    pub pg_source_connect_timeout: Option<Duration>,
    pub pg_source_tcp_keepalives_retries: Option<u32>,
    pub pg_source_tcp_keepalives_idle: Option<Duration>,
    pub pg_source_tcp_keepalives_interval: Option<Duration>,
    pub pg_source_tcp_user_timeout: Option<Duration>,
    pub pg_source_tcp_configure_server: bool,
    pub pg_source_snapshot_statement_timeout: Duration,
    pub pg_source_wal_sender_timeout: Option<Duration>,
    pub mysql_source_timeouts: TimeoutConfig,
    pub keep_n_source_status_history_entries: usize,
    pub keep_n_sink_status_history_entries: usize,
    pub keep_n_privatelink_status_history_entries: usize,
    pub replica_status_history_retention_window: Duration,
    pub upsert_rocksdb_tuning_config: RocksDBTuningParameters,
    pub finalize_shards: bool,
    pub tracing: TracingParameters,
    pub upsert_auto_spill_config: UpsertAutoSpillConfig,
    pub storage_dataflow_max_inflight_bytes_config: StorageMaxInflightBytesConfig,
    pub grpc_client: GrpcClientParameters,
    pub shrink_upsert_unused_buffers_by_ratio: usize,
    pub record_namespaced_errors: bool,
    pub ssh_timeout_config: SshTimeoutConfig,
    pub kafka_timeout_config: TimeoutConfig,
    pub statistics_interval: Duration,
    pub statistics_collection_interval: Duration,
    pub pg_snapshot_config: PgSourceSnapshotConfig,
    pub user_storage_managed_collections_batch_duration: Duration,
    pub dyncfg_updates: ConfigUpdates,
}

Storage instance configuration parameters.

Parameters can be set (Some) or unset (None). Unset parameters should be interpreted to mean “use the previous value”.

Fields

pg_source_connect_timeout: Option<Duration>

pg_source_tcp_keepalives_retries: Option<u32>

pg_source_tcp_keepalives_idle: Option<Duration>

pg_source_tcp_keepalives_interval: Option<Duration>

pg_source_tcp_user_timeout: Option<Duration>

pg_source_tcp_configure_server: bool

Whether to apply the configuration on the server as well.

By default, the timeouts are only applied on the client.

pg_source_snapshot_statement_timeout: Duration

pg_source_wal_sender_timeout: Option<Duration>

mysql_source_timeouts: TimeoutConfig

keep_n_source_status_history_entries: usize

keep_n_sink_status_history_entries: usize

keep_n_privatelink_status_history_entries: usize

replica_status_history_retention_window: Duration

upsert_rocksdb_tuning_config: RocksDBTuningParameters

A set of parameters used to tune RocksDB when used with UPSERT sources.

finalize_shards: bool

Whether or not to allow shard finalization to occur. Note that this will only disable the actual finalization of shards, not registering them for finalization.

tracing: TracingParameters

upsert_auto_spill_config: UpsertAutoSpillConfig

A set of parameters used to configure auto spill behaviour if disk is used.

storage_dataflow_max_inflight_bytes_config: StorageMaxInflightBytesConfig

A set of parameters used to configure the maximum number of in-flight bytes emitted by persist_sources feeding storage dataflows

grpc_client: GrpcClientParameters

gRPC client parameters.

shrink_upsert_unused_buffers_by_ratio: usize

Configuration ratio to shrink upsert buffers by.

record_namespaced_errors: bool

Whether or not to record errors by namespace in the details column of the status history tables.

ssh_timeout_config: SshTimeoutConfig

Networking configuration for ssh connections.

kafka_timeout_config: TimeoutConfig

Networking configuration for kafka connections.

statistics_interval: Duration

The interval to emit records to statistics tables

statistics_collection_interval: Duration

The interval to collect statistics within clusterd.

pg_snapshot_config: PgSourceSnapshotConfig

user_storage_managed_collections_batch_duration: Duration

Duration that we wait to batch rows for user owned, storage managed, collections.

dyncfg_updates: ConfigUpdates

Updates used to update StorageConfiguration::config_set.

Implementations

impl StorageParameters

pub fn update(&mut self, _: StorageParameters)

Update the parameter values with the set ones from other.

NOTE that this does not necessarily update all global state related to these parameters, like persist parameters.

pub fn all_unset(&self) -> bool

Return whether all parameters are unset.

Trait Implementations

impl Clone for StorageParameters

fn clone(&self) -> StorageParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageParameters

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

Formats the value using the given formatter.

impl Default for StorageParameters

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StorageParameters

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StorageParameters

fn eq(&self, other: &StorageParameters) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RustType<ProtoStorageParameters> for StorageParameters

fn into_proto(&self) -> ProtoStorageParameters

Convert a Self into a Proto value.

fn from_proto(proto: ProtoStorageParameters) -> Result<Self, TryFromProtoError>

Consume and convert a Proto back into a Self value.

fn into_proto_owned(self) -> Proto

A zero clone version of Self::into_proto that types can optionally implement, otherwise, the default implementation delegates to Self::into_proto.

impl Serialize for StorageParameters

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StorageParameters