Skip to main content

mz_sql/session/
vars.rs

1// Copyright Materialize, Inc. and contributors. All rights reserved.
2//
3// Use of this software is governed by the Business Source License
4// included in the LICENSE file.
5//
6// As of the Change Date specified in that file, in accordance with
7// the Business Source License, use of this software will be governed
8// by the Apache License, Version 2.0.
9
10//! Run-time configuration parameters
11//!
12//! ## Overview
13//! Materialize roughly follows the PostgreSQL configuration model, which works
14//! as follows. There is a global set of named configuration parameters, like
15//! `DateStyle` and `client_encoding`. These parameters can be set in several
16//! places: in an on-disk configuration file (in Postgres, named
17//! postgresql.conf), in command line arguments when the server is started, or
18//! at runtime via the `ALTER SYSTEM` or `SET` statements. Parameters that are
19//! set in a session take precedence over database defaults, which in turn take
20//! precedence over command line arguments, which in turn take precedence over
21//! settings in the on-disk configuration. Note that changing the value of
22//! parameters obeys transaction semantics: if a transaction fails to commit,
23//! any parameters that were changed in that transaction (i.e., via `SET`) will
24//! be rolled back to their previous value.
25//!
26//! The Materialize configuration hierarchy at the moment is much simpler.
27//! Global defaults are hardcoded into the binary, and a select few parameters
28//! can be overridden per session. A select few parameters can be overridden on
29//! disk.
30//!
31//! The set of variables that can be overridden per session and the set of
32//! variables that can be overridden on disk are currently disjoint. The
33//! infrastructure has been designed with an eye towards merging these two sets
34//! and supporting additional layers to the hierarchy, however, should the need
35//! arise.
36//!
37//! The configuration parameters that exist are driven by compatibility with
38//! PostgreSQL drivers that expect them, not because they are particularly
39//! important.
40//!
41//! ## Structure
42//! The most meaningful exports from this module are:
43//!
44//! - [`SessionVars`] represent per-session parameters, which each user can
45//!   access independently of one another, and are accessed via `SET`.
46//!
47//!   The fields of [`SessionVars`] are either;
48//!     - `SessionVar`, which is preferable and simply requires full support of
49//!       the `SessionVar` impl for its embedded value type.
50//!     - `ServerVar` for types that do not currently support everything
51//!       required by `SessionVar`, e.g. they are fixed-value parameters.
52//!
53//!   In the fullness of time, all fields in [`SessionVars`] should be
54//!   `SessionVar`.
55//!
56//! - [`SystemVars`] represent system-wide configuration settings and are
57//!   accessed via `ALTER SYSTEM SET`.
58//!
59//!   All elements of [`SystemVars`] are `SystemVar`.
60//!
61//! Some [`VarDefinition`] are also marked as a [`FeatureFlag`]; this is just a
62//! wrapper to make working with a set of [`VarDefinition`] easier, primarily from
63//! within SQL planning, where we might want to check if a feature is enabled
64//! before planning it.
65
66use std::borrow::Cow;
67use std::clone::Clone;
68use std::collections::BTreeMap;
69use std::fmt::Debug;
70use std::net::IpAddr;
71use std::num::NonZeroU32;
72use std::string::ToString;
73use std::sync::{Arc, LazyLock};
74use std::time::Duration;
75
76use chrono::{DateTime, Utc};
77use derivative::Derivative;
78use im::OrdMap;
79use mz_build_info::BuildInfo;
80use mz_dyncfg::{ConfigSet, ConfigType, ConfigUpdates, ConfigVal};
81use mz_persist_client::cfg::{
82    CRDB_CONNECT_TIMEOUT, CRDB_KEEPALIVES_IDLE, CRDB_KEEPALIVES_INTERVAL, CRDB_KEEPALIVES_RETRIES,
83    CRDB_TCP_USER_TIMEOUT,
84};
85use mz_repr::adt::numeric::Numeric;
86use mz_repr::adt::timestamp::CheckedTimestamp;
87use mz_repr::bytes::ByteSize;
88use mz_repr::user::ExternalUserMetadata;
89use mz_tracing::{CloneableEnvFilter, SerializableDirective};
90use serde::Serialize;
91use thiserror::Error;
92use uncased::UncasedStr;
93
94use crate::ast::Ident;
95use crate::session::user::User;
96
97pub(crate) mod constraints;
98pub(crate) mod definitions;
99pub(crate) mod errors;
100pub(crate) mod polyfill;
101pub(crate) mod value;
102
103pub use definitions::*;
104pub use errors::*;
105pub use value::*;
106
107/// The action to take during end_transaction.
108///
109/// This enum lives here because of convenience: it's more of an adapter
110/// concept but [`SessionVars::end_transaction`] takes it.
111#[derive(Debug, Clone, Copy, PartialEq, Eq)]
112pub enum EndTransactionAction {
113    /// Commit the transaction.
114    Commit,
115    /// Rollback the transaction.
116    Rollback,
117}
118
119/// Represents the input to a variable.
120///
121/// Each variable has different rules for how it handles each style of input.
122/// This type allows us to defer interpretation of the input until the
123/// variable-specific interpretation can be applied.
124#[derive(Debug, Clone, Copy)]
125pub enum VarInput<'a> {
126    /// The input has been flattened into a single string.
127    Flat(&'a str),
128    /// The input comes from a SQL `SET` statement and is jumbled across
129    /// multiple components.
130    SqlSet(&'a [String]),
131}
132
133impl<'a> VarInput<'a> {
134    /// Converts the variable input to an owned vector of strings.
135    pub fn to_vec(&self) -> Vec<String> {
136        match self {
137            VarInput::Flat(v) => vec![v.to_string()],
138            VarInput::SqlSet(values) => values.into_iter().map(|v| v.to_string()).collect(),
139        }
140    }
141}
142
143/// An owned version of [`VarInput`].
144#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Serialize)]
145pub enum OwnedVarInput {
146    /// See [`VarInput::Flat`].
147    Flat(String),
148    /// See [`VarInput::SqlSet`].
149    SqlSet(Vec<String>),
150}
151
152impl OwnedVarInput {
153    /// Converts this owned variable input as a [`VarInput`].
154    pub fn borrow(&self) -> VarInput<'_> {
155        match self {
156            OwnedVarInput::Flat(v) => VarInput::Flat(v),
157            OwnedVarInput::SqlSet(v) => VarInput::SqlSet(v),
158        }
159    }
160}
161
162/// A `Var` represents a configuration parameter of an arbitrary type.
163pub trait Var: Debug {
164    /// Returns the name of the configuration parameter.
165    fn name(&self) -> &'static str;
166
167    /// Constructs a flattened string representation of the current value of the
168    /// configuration parameter.
169    ///
170    /// The resulting string is guaranteed to be parsable if provided to
171    /// `Value::parse` as a [`VarInput::Flat`].
172    fn value(&self) -> String;
173
174    /// Returns a short sentence describing the purpose of the configuration
175    /// parameter.
176    fn description(&self) -> &'static str;
177
178    /// Returns the name of the type of this variable.
179    fn type_name(&self) -> Cow<'static, str>;
180
181    /// Indicates wither the [`Var`] is visible as a function of the `user` and `system_vars`.
182    /// "Invisible" parameters return `VarErrors`.
183    ///
184    /// Variables marked as `internal` are only visible for the system user.
185    fn visible(&self, user: &User, system_vars: &SystemVars) -> Result<(), VarError>;
186
187    /// Reports whether the variable is only visible in unsafe mode.
188    fn is_unsafe(&self) -> bool {
189        self.name().starts_with("unsafe_")
190    }
191
192    /// Upcast `self` to a `dyn Var`, useful when working with multiple different implementors of
193    /// [`Var`].
194    fn as_var(&self) -> &dyn Var
195    where
196        Self: Sized,
197    {
198        self
199    }
200}
201
202/// A `SessionVar` is the session value for a configuration parameter. If unset,
203/// the server default is used instead.
204///
205/// Note: even though all of the different `*_value` fields are `Box<dyn Value>` they are enforced
206/// to be the same type because we use the `definition`s `parse(...)` method. This is guaranteed to
207/// return the same type as the compiled in default.
208#[derive(Debug)]
209pub struct SessionVar {
210    definition: VarDefinition,
211    /// System or Role default value.
212    default_value: Option<Box<dyn Value>>,
213    /// Value `LOCAL` to a transaction, will be unset at the completion of the transaction.
214    local_value: Option<Box<dyn Value>>,
215    /// Value set during a transaction, will be set if the transaction is committed.
216    staged_value: Option<Box<dyn Value>>,
217    /// Value that overrides the default.
218    session_value: Option<Box<dyn Value>>,
219}
220
221impl Clone for SessionVar {
222    fn clone(&self) -> Self {
223        SessionVar {
224            definition: self.definition.clone(),
225            default_value: self.default_value.as_ref().map(|v| v.box_clone()),
226            local_value: self.local_value.as_ref().map(|v| v.box_clone()),
227            staged_value: self.staged_value.as_ref().map(|v| v.box_clone()),
228            session_value: self.session_value.as_ref().map(|v| v.box_clone()),
229        }
230    }
231}
232
233impl SessionVar {
234    pub const fn new(var: VarDefinition) -> Self {
235        SessionVar {
236            definition: var,
237            default_value: None,
238            local_value: None,
239            staged_value: None,
240            session_value: None,
241        }
242    }
243
244    /// Checks if the provided [`VarInput`] is valid for the current session variable, returning
245    /// the formatted output if it's valid.
246    pub fn check(&self, input: VarInput) -> Result<String, VarError> {
247        let v = self.definition.parse(input)?;
248        self.validate_constraints(v.as_ref())?;
249
250        Ok(v.format())
251    }
252
253    /// Parse the input and update the stored value to match.
254    pub fn set(&mut self, input: VarInput, local: bool) -> Result<(), VarError> {
255        let v = self.definition.parse(input)?;
256
257        // Validate our parsed value.
258        self.validate_constraints(v.as_ref())?;
259
260        if local {
261            self.local_value = Some(v);
262        } else {
263            self.local_value = None;
264            self.staged_value = Some(v);
265        }
266        Ok(())
267    }
268
269    /// Sets the default value for the variable.
270    pub fn set_default(&mut self, input: VarInput) -> Result<(), VarError> {
271        let v = self.definition.parse(input)?;
272        self.validate_constraints(v.as_ref())?;
273        self.default_value = Some(v);
274        Ok(())
275    }
276
277    /// Reset the stored value to the default.
278    pub fn reset(&mut self, local: bool) {
279        let value = self
280            .default_value
281            .as_ref()
282            .map(|v| v.as_ref())
283            .unwrap_or_else(|| self.definition.value.value());
284        if local {
285            self.local_value = Some(value.box_clone());
286        } else {
287            self.local_value = None;
288            self.staged_value = Some(value.box_clone());
289        }
290    }
291
292    /// Returns a possibly new SessionVar if this needs to mutate at transaction end.
293    #[must_use]
294    pub fn end_transaction(&self, action: EndTransactionAction) -> Option<Self> {
295        if !self.is_mutating() {
296            return None;
297        }
298        let mut next: Self = self.clone();
299        next.local_value = None;
300        match action {
301            EndTransactionAction::Commit if next.staged_value.is_some() => {
302                next.session_value = next.staged_value.take()
303            }
304            _ => next.staged_value = None,
305        }
306        Some(next)
307    }
308
309    /// Whether this Var needs to mutate at the end of a transaction.
310    pub fn is_mutating(&self) -> bool {
311        self.local_value.is_some() || self.staged_value.is_some()
312    }
313
314    pub fn value_dyn(&self) -> &dyn Value {
315        self.local_value
316            .as_deref()
317            .or(self.staged_value.as_deref())
318            .or(self.session_value.as_deref())
319            .or(self.default_value.as_deref())
320            .unwrap_or_else(|| self.definition.value.value())
321    }
322
323    /// Returns the [`Value`] that is currently stored as the `session_value`.
324    ///
325    /// Note: This should __only__ be used for inspection, if you want to determine the current
326    /// value of this [`SessionVar`] you should use [`SessionVar::value`].
327    pub fn inspect_session_value(&self) -> Option<&dyn Value> {
328        self.session_value.as_deref()
329    }
330
331    fn validate_constraints(&self, val: &dyn Value) -> Result<(), VarError> {
332        if let Some(constraint) = &self.definition.constraint {
333            constraint.check_constraint(self, self.value_dyn(), val)
334        } else {
335            Ok(())
336        }
337    }
338}
339
340impl Var for SessionVar {
341    fn name(&self) -> &'static str {
342        self.definition.name.as_str()
343    }
344
345    fn value(&self) -> String {
346        self.value_dyn().format()
347    }
348
349    fn description(&self) -> &'static str {
350        self.definition.description
351    }
352
353    fn type_name(&self) -> Cow<'static, str> {
354        self.definition.type_name()
355    }
356
357    fn visible(
358        &self,
359        user: &User,
360        system_vars: &super::vars::SystemVars,
361    ) -> Result<(), super::vars::VarError> {
362        self.definition.visible(user, system_vars)
363    }
364}
365
366#[derive(Debug, Clone, PartialEq, Eq)]
367pub struct MzVersion {
368    /// Inputs to computed variables.
369    build_info: &'static BuildInfo,
370    /// Helm chart version
371    helm_chart_version: Option<String>,
372}
373
374impl MzVersion {
375    pub fn new(build_info: &'static BuildInfo, helm_chart_version: Option<String>) -> Self {
376        MzVersion {
377            build_info,
378            helm_chart_version,
379        }
380    }
381}
382
383/// Session variables.
384///
385/// See the [`crate::session::vars`] module documentation for more details on the
386/// Materialize configuration model.
387#[derive(Debug, Clone)]
388pub struct SessionVars {
389    /// The set of all session variables.
390    vars: OrdMap<&'static UncasedStr, SessionVar>,
391    /// Inputs to computed variables.
392    mz_version: MzVersion,
393    /// Information about the user associated with this Session.
394    user: User,
395}
396
397impl SessionVars {
398    /// Creates a new [`SessionVars`] without considering the System or Role defaults.
399    pub fn new_unchecked(
400        build_info: &'static BuildInfo,
401        user: User,
402        helm_chart_version: Option<String>,
403    ) -> SessionVars {
404        use definitions::*;
405
406        let vars = [
407            &FAILPOINTS,
408            &SERVER_VERSION,
409            &SERVER_VERSION_NUM,
410            &SQL_SAFE_UPDATES,
411            &REAL_TIME_RECENCY,
412            &EMIT_PLAN_INSIGHTS_NOTICE,
413            &EMIT_TIMESTAMP_NOTICE,
414            &EMIT_TRACE_ID_NOTICE,
415            &AUTO_ROUTE_CATALOG_QUERIES,
416            &ENABLE_SESSION_RBAC_CHECKS,
417            &ENABLE_SESSION_CARDINALITY_ESTIMATES,
418            &MAX_IDENTIFIER_LENGTH,
419            &STATEMENT_LOGGING_SAMPLE_RATE,
420            &EMIT_INTROSPECTION_QUERY_NOTICE,
421            &UNSAFE_NEW_TRANSACTION_WALL_TIME,
422            &WELCOME_MESSAGE,
423        ]
424        .into_iter()
425        .chain(SESSION_SYSTEM_VARS.iter().map(|(_name, var)| *var))
426        .map(|var| (var.name, SessionVar::new(var.clone())))
427        .collect();
428
429        SessionVars {
430            vars,
431            mz_version: MzVersion::new(build_info, helm_chart_version),
432            user,
433        }
434    }
435
436    fn expect_value<V: Value>(&self, var: &VarDefinition) -> &V {
437        let var = self
438            .vars
439            .get(var.name)
440            .expect("provided var should be in state");
441        let val = var.value_dyn();
442        val.as_any().downcast_ref::<V>().expect("success")
443    }
444
445    /// Returns an iterator over the configuration parameters and their current
446    /// values for this session.
447    ///
448    /// Note that this function does not check that the access variable should
449    /// be visible because of other settings or users. Before or after accessing
450    /// this method, you should call `Var::visible`.
451    pub fn iter(&self) -> impl Iterator<Item = &dyn Var> {
452        #[allow(clippy::as_conversions)]
453        self.vars
454            .values()
455            .map(|v| v.as_var())
456            .chain([&self.mz_version as &dyn Var, &self.user])
457    }
458
459    /// Returns an iterator over configuration parameters (and their current
460    /// values for this session) that are expected to be sent to the client when
461    /// a new connection is established or when their value changes.
462    pub fn notify_set(&self) -> impl Iterator<Item = &dyn Var> {
463        // WARNING: variables in this set are not checked for visibility, and
464        // are assumed to be visible for all sessions.
465        //
466        // This is fixible with some elbow grease, but at the moment it seems
467        // unlikely that we'll have a variable in the notify set that shouldn't
468        // be visible to all sessions.
469        [
470            &APPLICATION_NAME,
471            &CLIENT_ENCODING,
472            &DATE_STYLE,
473            &INTEGER_DATETIMES,
474            &SERVER_VERSION,
475            &STANDARD_CONFORMING_STRINGS,
476            &TIMEZONE,
477            &INTERVAL_STYLE,
478            // Including `cluster`, `cluster_replica`, `database`, and `search_path` in the notify
479            // set is a Materialize extension. Doing so allows users to more easily identify where
480            // their queries will be executing, which is important to know when you consider the
481            // size of a cluster, what indexes are present, etc.
482            &CLUSTER,
483            &CLUSTER_REPLICA,
484            &DEFAULT_CLUSTER_REPLICATION_FACTOR,
485            &DATABASE,
486            &SEARCH_PATH,
487        ]
488        .into_iter()
489        .map(|v| self.vars[v.name].as_var())
490        // Including `mz_version` in the notify set is a Materialize
491        // extension. Doing so allows applications to detect whether they
492        // are talking to Materialize or PostgreSQL without an additional
493        // network roundtrip. This is known to be safe because CockroachDB
494        // has an analogous extension [0].
495        // [0]: https://github.com/cockroachdb/cockroach/blob/369c4057a/pkg/sql/pgwire/conn.go#L1840
496        .chain(std::iter::once(self.mz_version.as_var()))
497    }
498
499    /// Resets all variables to their default value.
500    pub fn reset_all(&mut self) {
501        let names: Vec<_> = self.vars.keys().copied().collect();
502        for name in names {
503            self.vars[name].reset(false);
504        }
505    }
506
507    /// Returns a [`Var`] representing the configuration parameter with the
508    /// specified name.
509    ///
510    /// Configuration parameters are matched case insensitively. If no such
511    /// configuration parameter exists, `get` returns an error.
512    ///
513    /// Note that if `name` is known at compile time, you should instead use the
514    /// named accessor to access the variable with its true Rust type. For
515    /// example, `self.get("sql_safe_updates").value()` returns the string
516    /// `"true"` or `"false"`, while `self.sql_safe_updates()` returns a bool.
517    pub fn get(&self, system_vars: &SystemVars, name: &str) -> Result<&dyn Var, VarError> {
518        let name = compat_translate_name(name);
519
520        let name = UncasedStr::new(name);
521        if name == MZ_VERSION_NAME {
522            Ok(&self.mz_version)
523        } else if name == IS_SUPERUSER_NAME {
524            Ok(&self.user)
525        } else {
526            self.vars
527                .get(name)
528                .map(|v| {
529                    v.visible(&self.user, system_vars)?;
530                    Ok(v.as_var())
531                })
532                .transpose()?
533                .ok_or_else(|| VarError::UnknownParameter(name.to_string()))
534        }
535    }
536
537    /// Returns a [`SessionVar`] for inspection.
538    ///
539    /// Note: If you're trying to determine the value of the variable with `name` you should
540    /// instead use the named accessor, or [`SessionVars::get`].
541    pub fn inspect(&self, name: &str) -> Result<&SessionVar, VarError> {
542        let name = compat_translate_name(name);
543
544        self.vars
545            .get(UncasedStr::new(name))
546            .ok_or_else(|| VarError::UnknownParameter(name.to_string()))
547    }
548
549    /// Sets the configuration parameter named `name` to the value represented
550    /// by `value`.
551    ///
552    /// The new value may be either committed or rolled back by the next call to
553    /// [`SessionVars::end_transaction`]. If `local` is true, the new value is always
554    /// discarded by the next call to [`SessionVars::end_transaction`], even if the
555    /// transaction is marked to commit.
556    ///
557    /// Like with [`SessionVars::get`], configuration parameters are matched case
558    /// insensitively. If `value` is not valid, as determined by the underlying
559    /// configuration parameter, or if the named configuration parameter does
560    /// not exist, an error is returned.
561    pub fn set(
562        &mut self,
563        system_vars: &SystemVars,
564        name: &str,
565        input: VarInput,
566        local: bool,
567    ) -> Result<(), VarError> {
568        let (name, input) = compat_translate(name, input);
569
570        let name = UncasedStr::new(name);
571        self.check_read_only(name)?;
572
573        self.vars
574            .get_mut(name)
575            .map(|v| {
576                v.visible(&self.user, system_vars)?;
577                v.set(input, local)
578            })
579            .transpose()?
580            .ok_or_else(|| VarError::UnknownParameter(name.to_string()))
581    }
582
583    /// Sets the default value for the parameter named `name` to the value
584    /// represented by `value`.
585    pub fn set_default(&mut self, name: &str, input: VarInput) -> Result<(), VarError> {
586        let (name, input) = compat_translate(name, input);
587
588        let name = UncasedStr::new(name);
589        self.check_read_only(name)?;
590
591        self.vars
592            .get_mut(name)
593            // Note: visibility is checked when persisting a role default.
594            .map(|v| v.set_default(input))
595            .transpose()?
596            .ok_or_else(|| VarError::UnknownParameter(name.to_string()))
597    }
598
599    /// Sets the configuration parameter named `name` to its default value.
600    ///
601    /// The new value may be either committed or rolled back by the next call to
602    /// [`SessionVars::end_transaction`]. If `local` is true, the new value is
603    /// always discarded by the next call to [`SessionVars::end_transaction`],
604    /// even if the transaction is marked to commit.
605    ///
606    /// Like with [`SessionVars::get`], configuration parameters are matched
607    /// case insensitively. If the named configuration parameter does not exist,
608    /// an error is returned.
609    ///
610    /// If the variable does not exist or the user does not have the visibility
611    /// requires, this function returns an error.
612    pub fn reset(
613        &mut self,
614        system_vars: &SystemVars,
615        name: &str,
616        local: bool,
617    ) -> Result<(), VarError> {
618        let name = compat_translate_name(name);
619
620        let name = UncasedStr::new(name);
621        self.check_read_only(name)?;
622
623        self.vars
624            .get_mut(name)
625            .map(|v| {
626                v.visible(&self.user, system_vars)?;
627                v.reset(local);
628                Ok(())
629            })
630            .transpose()?
631            .ok_or_else(|| VarError::UnknownParameter(name.to_string()))
632    }
633
634    /// Returns an error if the variable corresponding to `name` is read only.
635    fn check_read_only(&self, name: &UncasedStr) -> Result<(), VarError> {
636        if name == MZ_VERSION_NAME {
637            Err(VarError::ReadOnlyParameter(MZ_VERSION_NAME.as_str()))
638        } else if name == IS_SUPERUSER_NAME {
639            Err(VarError::ReadOnlyParameter(IS_SUPERUSER_NAME.as_str()))
640        } else if name == MAX_IDENTIFIER_LENGTH.name {
641            Err(VarError::ReadOnlyParameter(
642                MAX_IDENTIFIER_LENGTH.name.as_str(),
643            ))
644        } else {
645            Ok(())
646        }
647    }
648
649    /// Commits or rolls back configuration parameter updates made via
650    /// [`SessionVars::set`] since the last call to `end_transaction`.
651    ///
652    /// Returns any session parameters that changed because the transaction ended.
653    #[mz_ore::instrument(level = "debug")]
654    pub fn end_transaction(
655        &mut self,
656        action: EndTransactionAction,
657    ) -> BTreeMap<&'static str, String> {
658        let mut changed = BTreeMap::new();
659        let mut updates = Vec::new();
660        for (name, var) in self.vars.iter() {
661            if !var.is_mutating() {
662                continue;
663            }
664            let before = var.value();
665            let next = var.end_transaction(action).expect("must mutate");
666            let after = next.value();
667            updates.push((*name, next));
668
669            // Report the new value of the parameter.
670            if before != after {
671                changed.insert(var.name(), after);
672            }
673        }
674        self.vars.extend(updates);
675        changed
676    }
677
678    /// Returns the value of the `application_name` configuration parameter.
679    pub fn application_name(&self) -> &str {
680        self.expect_value::<String>(&APPLICATION_NAME).as_str()
681    }
682
683    /// Returns the build info.
684    pub fn build_info(&self) -> &'static BuildInfo {
685        self.mz_version.build_info
686    }
687
688    /// Returns the value of the `client_encoding` configuration parameter.
689    pub fn client_encoding(&self) -> &ClientEncoding {
690        self.expect_value(&CLIENT_ENCODING)
691    }
692
693    /// Returns the value of the `client_min_messages` configuration parameter.
694    pub fn client_min_messages(&self) -> &ClientSeverity {
695        self.expect_value(&CLIENT_MIN_MESSAGES)
696    }
697
698    /// Returns the value of the `cluster` configuration parameter.
699    pub fn cluster(&self) -> &str {
700        self.expect_value::<String>(&CLUSTER).as_str()
701    }
702
703    /// Returns the value of the `cluster_replica` configuration parameter.
704    pub fn cluster_replica(&self) -> Option<&str> {
705        self.expect_value::<Option<String>>(&CLUSTER_REPLICA)
706            .as_deref()
707    }
708
709    /// Returns the value of the `current_object_missing_warnings` configuration
710    /// parameter.
711    pub fn current_object_missing_warnings(&self) -> bool {
712        *self.expect_value::<bool>(&CURRENT_OBJECT_MISSING_WARNINGS)
713    }
714
715    /// Returns the value of the `DateStyle` configuration parameter.
716    pub fn date_style(&self) -> &[&str] {
717        &self.expect_value::<DateStyle>(&DATE_STYLE).0
718    }
719
720    /// Returns the value of the `database` configuration parameter.
721    pub fn database(&self) -> &str {
722        self.expect_value::<String>(&DATABASE).as_str()
723    }
724
725    /// Returns the value of the `extra_float_digits` configuration parameter.
726    pub fn extra_float_digits(&self) -> i32 {
727        *self.expect_value(&EXTRA_FLOAT_DIGITS)
728    }
729
730    /// Returns the value of the `integer_datetimes` configuration parameter.
731    pub fn integer_datetimes(&self) -> bool {
732        *self.expect_value(&INTEGER_DATETIMES)
733    }
734
735    /// Returns the value of the `intervalstyle` configuration parameter.
736    pub fn intervalstyle(&self) -> &IntervalStyle {
737        self.expect_value(&INTERVAL_STYLE)
738    }
739
740    /// Returns the value of the `mz_version` configuration parameter.
741    pub fn mz_version(&self) -> String {
742        self.mz_version.value()
743    }
744
745    /// Returns the value of the `search_path` configuration parameter.
746    pub fn search_path(&self) -> &[Ident] {
747        self.expect_value::<Vec<Ident>>(&SEARCH_PATH).as_slice()
748    }
749
750    /// Returns the value of the `server_version` configuration parameter.
751    pub fn server_version(&self) -> &str {
752        self.expect_value::<String>(&SERVER_VERSION).as_str()
753    }
754
755    /// Returns the value of the `server_version_num` configuration parameter.
756    pub fn server_version_num(&self) -> i32 {
757        *self.expect_value(&SERVER_VERSION_NUM)
758    }
759
760    /// Returns the value of the `sql_safe_updates` configuration parameter.
761    pub fn sql_safe_updates(&self) -> bool {
762        *self.expect_value(&SQL_SAFE_UPDATES)
763    }
764
765    /// Returns the value of the `standard_conforming_strings` configuration
766    /// parameter.
767    pub fn standard_conforming_strings(&self) -> bool {
768        *self.expect_value(&STANDARD_CONFORMING_STRINGS)
769    }
770
771    /// Returns the value of the `statement_timeout` configuration parameter.
772    pub fn statement_timeout(&self) -> &Duration {
773        self.expect_value(&STATEMENT_TIMEOUT)
774    }
775
776    /// Returns the value of the `idle_in_transaction_session_timeout` configuration parameter.
777    pub fn idle_in_transaction_session_timeout(&self) -> &Duration {
778        self.expect_value(&IDLE_IN_TRANSACTION_SESSION_TIMEOUT)
779    }
780
781    /// Returns the value of the `timezone` configuration parameter.
782    pub fn timezone(&self) -> &TimeZone {
783        self.expect_value(&TIMEZONE)
784    }
785
786    /// Returns the value of the `transaction_isolation` configuration
787    /// parameter.
788    pub fn transaction_isolation(&self) -> &IsolationLevel {
789        self.expect_value(&TRANSACTION_ISOLATION)
790    }
791
792    /// Returns the value of `real_time_recency` configuration parameter.
793    pub fn real_time_recency(&self) -> bool {
794        *self.expect_value(&REAL_TIME_RECENCY)
795    }
796
797    /// Returns the value of the `real_time_recency_timeout` configuration parameter.
798    pub fn real_time_recency_timeout(&self) -> &Duration {
799        self.expect_value(&REAL_TIME_RECENCY_TIMEOUT)
800    }
801
802    /// Returns the value of `emit_plan_insights_notice` configuration parameter.
803    pub fn emit_plan_insights_notice(&self) -> bool {
804        *self.expect_value(&EMIT_PLAN_INSIGHTS_NOTICE)
805    }
806
807    /// Returns the value of `emit_timestamp_notice` configuration parameter.
808    pub fn emit_timestamp_notice(&self) -> bool {
809        *self.expect_value(&EMIT_TIMESTAMP_NOTICE)
810    }
811
812    /// Returns the value of `emit_trace_id_notice` configuration parameter.
813    pub fn emit_trace_id_notice(&self) -> bool {
814        *self.expect_value(&EMIT_TRACE_ID_NOTICE)
815    }
816
817    /// Returns the value of `auto_route_catalog_queries` configuration parameter.
818    pub fn auto_route_catalog_queries(&self) -> bool {
819        *self.expect_value(&AUTO_ROUTE_CATALOG_QUERIES)
820    }
821
822    /// Returns the value of `enable_session_rbac_checks` configuration parameter.
823    pub fn enable_session_rbac_checks(&self) -> bool {
824        *self.expect_value(&ENABLE_SESSION_RBAC_CHECKS)
825    }
826
827    /// Returns the value of `enable_session_cardinality_estimates` configuration parameter.
828    pub fn enable_session_cardinality_estimates(&self) -> bool {
829        *self.expect_value(&ENABLE_SESSION_CARDINALITY_ESTIMATES)
830    }
831
832    /// Returns the value of `is_superuser` configuration parameter.
833    pub fn is_superuser(&self) -> bool {
834        self.user.is_superuser()
835    }
836
837    /// Returns the user associated with this `SessionVars` instance.
838    pub fn user(&self) -> &User {
839        &self.user
840    }
841
842    /// Returns the value of the `max_query_result_size` configuration parameter.
843    pub fn max_query_result_size(&self) -> u64 {
844        self.expect_value::<ByteSize>(&MAX_QUERY_RESULT_SIZE)
845            .as_bytes()
846    }
847
848    /// Sets the external metadata associated with the user.
849    pub fn set_external_user_metadata(&mut self, metadata: ExternalUserMetadata) {
850        self.user.external_metadata = Some(metadata);
851    }
852
853    pub fn set_cluster(&mut self, cluster: String) {
854        let var = self
855            .vars
856            .get_mut(UncasedStr::new(CLUSTER.name()))
857            .expect("cluster variable must exist");
858        var.set(VarInput::Flat(&cluster), false)
859            .expect("setting cluster must succeed");
860    }
861
862    pub fn set_local_transaction_isolation(&mut self, transaction_isolation: IsolationLevel) {
863        let var = self
864            .vars
865            .get_mut(UncasedStr::new(TRANSACTION_ISOLATION.name()))
866            .expect("transaction_isolation variable must exist");
867        var.set(VarInput::Flat(transaction_isolation.as_str()), true)
868            .expect("setting transaction isolation must succeed");
869    }
870
871    pub fn get_statement_logging_sample_rate(&self) -> Numeric {
872        *self.expect_value(&STATEMENT_LOGGING_SAMPLE_RATE)
873    }
874
875    /// Returns the value of the `emit_introspection_query_notice` configuration parameter.
876    pub fn emit_introspection_query_notice(&self) -> bool {
877        *self.expect_value(&EMIT_INTROSPECTION_QUERY_NOTICE)
878    }
879
880    pub fn unsafe_new_transaction_wall_time(&self) -> Option<CheckedTimestamp<DateTime<Utc>>> {
881        *self.expect_value(&UNSAFE_NEW_TRANSACTION_WALL_TIME)
882    }
883
884    /// Returns the value of the `welcome_message` configuration parameter.
885    pub fn welcome_message(&self) -> bool {
886        *self.expect_value(&WELCOME_MESSAGE)
887    }
888}
889
890// TODO(database-issues#8069) remove together with `compat_translate`
891pub const OLD_CATALOG_SERVER_CLUSTER: &str = "mz_introspection";
892pub const OLD_AUTO_ROUTE_CATALOG_QUERIES: &str = "auto_route_introspection_queries";
893
894/// If the given variable name and/or input is deprecated, return a corresponding updated value,
895/// otherwise return the original.
896///
897/// This method was introduced to gracefully handle the rename of the `mz_introspection` cluster to
898/// `mz_cluster_server`. The plan is to remove it once all users have migrated to the new name. The
899/// debug logs will be helpful for checking this in production.
900// TODO(database-issues#8069) remove this after sufficient time has passed
901fn compat_translate<'a, 'b>(name: &'a str, input: VarInput<'b>) -> (&'a str, VarInput<'b>) {
902    if name == CLUSTER.name() {
903        if let Ok(value) = CLUSTER.parse(input) {
904            if value.format() == OLD_CATALOG_SERVER_CLUSTER {
905                tracing::debug!(
906                    github_27285 = true,
907                    "encountered deprecated `cluster` variable value: {}",
908                    OLD_CATALOG_SERVER_CLUSTER,
909                );
910                return (name, VarInput::Flat("mz_catalog_server"));
911            }
912        }
913    }
914
915    if name == OLD_AUTO_ROUTE_CATALOG_QUERIES {
916        tracing::debug!(
917            github_27285 = true,
918            "encountered deprecated `{}` variable name",
919            OLD_AUTO_ROUTE_CATALOG_QUERIES,
920        );
921        return (AUTO_ROUTE_CATALOG_QUERIES.name(), input);
922    }
923
924    (name, input)
925}
926
927fn compat_translate_name(name: &str) -> &str {
928    let (name, _) = compat_translate(name, VarInput::Flat(""));
929    name
930}
931
932/// A `SystemVar` is persisted on disk value for a configuration parameter. If unset,
933/// the server default is used instead.
934#[derive(Debug)]
935pub struct SystemVar {
936    definition: VarDefinition,
937    /// Value currently persisted to disk.
938    persisted_value: Option<Box<dyn Value>>,
939    /// Current default, not persisted to disk.
940    dynamic_default: Option<Box<dyn Value>>,
941}
942
943impl Clone for SystemVar {
944    fn clone(&self) -> Self {
945        SystemVar {
946            definition: self.definition.clone(),
947            persisted_value: self.persisted_value.as_ref().map(|v| v.box_clone()),
948            dynamic_default: self.dynamic_default.as_ref().map(|v| v.box_clone()),
949        }
950    }
951}
952
953impl SystemVar {
954    pub fn new(definition: VarDefinition) -> Self {
955        SystemVar {
956            definition,
957            persisted_value: None,
958            dynamic_default: None,
959        }
960    }
961
962    fn is_default(&self, input: VarInput) -> Result<bool, VarError> {
963        let v = self.definition.parse(input)?;
964        Ok(self.definition.default_value() == v.as_ref())
965    }
966
967    pub fn value_dyn(&self) -> &dyn Value {
968        self.persisted_value
969            .as_deref()
970            .or(self.dynamic_default.as_deref())
971            .unwrap_or_else(|| self.definition.default_value())
972    }
973
974    pub fn value<V: 'static>(&self) -> &V {
975        let val = self.value_dyn();
976        val.as_any().downcast_ref::<V>().expect("success")
977    }
978
979    fn parse(&self, input: VarInput) -> Result<Box<dyn Value>, VarError> {
980        let v = self.definition.parse(input)?;
981        // Validate our parsed value.
982        self.validate_constraints(v.as_ref())?;
983        Ok(v)
984    }
985
986    fn set(&mut self, input: VarInput) -> Result<bool, VarError> {
987        let v = self.parse(input)?;
988
989        if self.persisted_value.as_ref() != Some(&v) {
990            self.persisted_value = Some(v);
991            Ok(true)
992        } else {
993            Ok(false)
994        }
995    }
996
997    fn reset(&mut self) -> bool {
998        if self.persisted_value.is_some() {
999            self.persisted_value = None;
1000            true
1001        } else {
1002            false
1003        }
1004    }
1005
1006    fn set_default(&mut self, input: VarInput) -> Result<(), VarError> {
1007        let v = self.definition.parse(input)?;
1008        self.dynamic_default = Some(v);
1009        Ok(())
1010    }
1011
1012    fn validate_constraints(&self, val: &dyn Value) -> Result<(), VarError> {
1013        if let Some(constraint) = &self.definition.constraint {
1014            constraint.check_constraint(self, self.value_dyn(), val)
1015        } else {
1016            Ok(())
1017        }
1018    }
1019}
1020
1021impl Var for SystemVar {
1022    fn name(&self) -> &'static str {
1023        self.definition.name.as_str()
1024    }
1025
1026    fn value(&self) -> String {
1027        self.value_dyn().format()
1028    }
1029
1030    fn description(&self) -> &'static str {
1031        self.definition.description
1032    }
1033
1034    fn type_name(&self) -> Cow<'static, str> {
1035        self.definition.type_name()
1036    }
1037
1038    fn visible(&self, user: &User, system_vars: &SystemVars) -> Result<(), VarError> {
1039        self.definition.visible(user, system_vars)
1040    }
1041}
1042
1043#[derive(Debug, Error)]
1044pub enum NetworkPolicyError {
1045    #[error("Access denied for address {0}")]
1046    AddressDenied(IpAddr),
1047}
1048
1049/// On disk variables.
1050///
1051/// See the [`crate::session::vars`] module documentation for more details on the
1052/// Materialize configuration model.
1053#[derive(Derivative, Clone)]
1054#[derivative(Debug)]
1055pub struct SystemVars {
1056    /// Allows "unsafe" parameters to be set.
1057    allow_unsafe: bool,
1058    /// Set of all [`SystemVar`]s.
1059    vars: BTreeMap<&'static UncasedStr, SystemVar>,
1060    /// External components interested in when a [`SystemVar`] gets updated.
1061    #[derivative(Debug = "ignore")]
1062    callbacks: BTreeMap<String, Vec<Arc<dyn Fn(&SystemVars) + Send + Sync>>>,
1063
1064    /// NB: This is intentionally disconnected from the one that is plumbed around to persist and
1065    /// the controllers. This is so we can explicitly control and reason about when changes to config
1066    /// values are propagated to the rest of the system.
1067    dyncfgs: ConfigSet,
1068}
1069
1070impl Default for SystemVars {
1071    fn default() -> Self {
1072        Self::new()
1073    }
1074}
1075
1076impl SystemVars {
1077    pub fn new() -> Self {
1078        let system_vars = vec![
1079            &MAX_KAFKA_CONNECTIONS,
1080            &MAX_POSTGRES_CONNECTIONS,
1081            &MAX_MYSQL_CONNECTIONS,
1082            &MAX_SQL_SERVER_CONNECTIONS,
1083            &MAX_AWS_PRIVATELINK_CONNECTIONS,
1084            &MAX_TABLES,
1085            &MAX_SOURCES,
1086            &MAX_SINKS,
1087            &MAX_MATERIALIZED_VIEWS,
1088            &MAX_CLUSTERS,
1089            &MAX_REPLICAS_PER_CLUSTER,
1090            &MAX_CREDIT_CONSUMPTION_RATE,
1091            &MAX_DATABASES,
1092            &MAX_SCHEMAS_PER_DATABASE,
1093            &MAX_OBJECTS_PER_SCHEMA,
1094            &MAX_SECRETS,
1095            &MAX_ROLES,
1096            &MAX_CONTINUAL_TASKS,
1097            &MAX_NETWORK_POLICIES,
1098            &MAX_RULES_PER_NETWORK_POLICY,
1099            &MAX_RESULT_SIZE,
1100            &MAX_COPY_FROM_SIZE,
1101            &ALLOWED_CLUSTER_REPLICA_SIZES,
1102            &upsert_rocksdb::UPSERT_ROCKSDB_COMPACTION_STYLE,
1103            &upsert_rocksdb::UPSERT_ROCKSDB_OPTIMIZE_COMPACTION_MEMTABLE_BUDGET,
1104            &upsert_rocksdb::UPSERT_ROCKSDB_LEVEL_COMPACTION_DYNAMIC_LEVEL_BYTES,
1105            &upsert_rocksdb::UPSERT_ROCKSDB_UNIVERSAL_COMPACTION_RATIO,
1106            &upsert_rocksdb::UPSERT_ROCKSDB_PARALLELISM,
1107            &upsert_rocksdb::UPSERT_ROCKSDB_COMPRESSION_TYPE,
1108            &upsert_rocksdb::UPSERT_ROCKSDB_BOTTOMMOST_COMPRESSION_TYPE,
1109            &upsert_rocksdb::UPSERT_ROCKSDB_BATCH_SIZE,
1110            &upsert_rocksdb::UPSERT_ROCKSDB_RETRY_DURATION,
1111            &upsert_rocksdb::UPSERT_ROCKSDB_STATS_LOG_INTERVAL_SECONDS,
1112            &upsert_rocksdb::UPSERT_ROCKSDB_STATS_PERSIST_INTERVAL_SECONDS,
1113            &upsert_rocksdb::UPSERT_ROCKSDB_POINT_LOOKUP_BLOCK_CACHE_SIZE_MB,
1114            &upsert_rocksdb::UPSERT_ROCKSDB_SHRINK_ALLOCATED_BUFFERS_BY_RATIO,
1115            &upsert_rocksdb::UPSERT_ROCKSDB_WRITE_BUFFER_MANAGER_CLUSTER_MEMORY_FRACTION,
1116            &upsert_rocksdb::UPSERT_ROCKSDB_WRITE_BUFFER_MANAGER_MEMORY_BYTES,
1117            &upsert_rocksdb::UPSERT_ROCKSDB_WRITE_BUFFER_MANAGER_ALLOW_STALL,
1118            &STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES,
1119            &STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_TO_CLUSTER_SIZE_FRACTION,
1120            &STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_DISK_ONLY,
1121            &STORAGE_STATISTICS_INTERVAL,
1122            &STORAGE_STATISTICS_COLLECTION_INTERVAL,
1123            &STORAGE_SHRINK_UPSERT_UNUSED_BUFFERS_BY_RATIO,
1124            &STORAGE_RECORD_SOURCE_SINK_NAMESPACED_ERRORS,
1125            &PERSIST_FAST_PATH_LIMIT,
1126            &METRICS_RETENTION,
1127            &UNSAFE_MOCK_AUDIT_EVENT_TIMESTAMP,
1128            &ENABLE_RBAC_CHECKS,
1129            &PG_SOURCE_CONNECT_TIMEOUT,
1130            &PG_SOURCE_TCP_KEEPALIVES_IDLE,
1131            &PG_SOURCE_TCP_KEEPALIVES_INTERVAL,
1132            &PG_SOURCE_TCP_KEEPALIVES_RETRIES,
1133            &PG_SOURCE_TCP_USER_TIMEOUT,
1134            &PG_SOURCE_TCP_CONFIGURE_SERVER,
1135            &PG_SOURCE_SNAPSHOT_STATEMENT_TIMEOUT,
1136            &PG_SOURCE_WAL_SENDER_TIMEOUT,
1137            &PG_SOURCE_SNAPSHOT_COLLECT_STRICT_COUNT,
1138            &MYSQL_SOURCE_TCP_KEEPALIVE,
1139            &MYSQL_SOURCE_SNAPSHOT_MAX_EXECUTION_TIME,
1140            &MYSQL_SOURCE_SNAPSHOT_LOCK_WAIT_TIMEOUT,
1141            &MYSQL_SOURCE_CONNECT_TIMEOUT,
1142            &SSH_CHECK_INTERVAL,
1143            &SSH_CONNECT_TIMEOUT,
1144            &SSH_KEEPALIVES_IDLE,
1145            &KAFKA_SOCKET_KEEPALIVE,
1146            &KAFKA_SOCKET_TIMEOUT,
1147            &KAFKA_TRANSACTION_TIMEOUT,
1148            &KAFKA_SOCKET_CONNECTION_SETUP_TIMEOUT,
1149            &KAFKA_FETCH_METADATA_TIMEOUT,
1150            &KAFKA_PROGRESS_RECORD_FETCH_TIMEOUT,
1151            &ENABLE_LAUNCHDARKLY,
1152            &MAX_CONNECTIONS,
1153            &NETWORK_POLICY,
1154            &SUPERUSER_RESERVED_CONNECTIONS,
1155            &KEEP_N_SOURCE_STATUS_HISTORY_ENTRIES,
1156            &KEEP_N_SINK_STATUS_HISTORY_ENTRIES,
1157            &KEEP_N_PRIVATELINK_STATUS_HISTORY_ENTRIES,
1158            &REPLICA_STATUS_HISTORY_RETENTION_WINDOW,
1159            &ENABLE_STORAGE_SHARD_FINALIZATION,
1160            &ENABLE_CONSOLIDATE_AFTER_UNION_NEGATE,
1161            &ENABLE_DEFAULT_CONNECTION_VALIDATION,
1162            &ENABLE_REDUCE_REDUCTION,
1163            &MIN_TIMESTAMP_INTERVAL,
1164            &MAX_TIMESTAMP_INTERVAL,
1165            &LOGGING_FILTER,
1166            &OPENTELEMETRY_FILTER,
1167            &LOGGING_FILTER_DEFAULTS,
1168            &OPENTELEMETRY_FILTER_DEFAULTS,
1169            &SENTRY_FILTERS,
1170            &WEBHOOKS_SECRETS_CACHING_TTL_SECS,
1171            &COORD_SLOW_MESSAGE_WARN_THRESHOLD,
1172            &grpc_client::CONNECT_TIMEOUT,
1173            &grpc_client::HTTP2_KEEP_ALIVE_INTERVAL,
1174            &grpc_client::HTTP2_KEEP_ALIVE_TIMEOUT,
1175            &cluster_scheduling::CLUSTER_MULTI_PROCESS_REPLICA_AZ_AFFINITY_WEIGHT,
1176            &cluster_scheduling::CLUSTER_SOFTEN_REPLICATION_ANTI_AFFINITY,
1177            &cluster_scheduling::CLUSTER_SOFTEN_REPLICATION_ANTI_AFFINITY_WEIGHT,
1178            &cluster_scheduling::CLUSTER_ENABLE_TOPOLOGY_SPREAD,
1179            &cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_IGNORE_NON_SINGULAR_SCALE,
1180            &cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_MAX_SKEW,
1181            &cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_MIN_DOMAINS,
1182            &cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_SOFT,
1183            &cluster_scheduling::CLUSTER_SOFTEN_AZ_AFFINITY,
1184            &cluster_scheduling::CLUSTER_SOFTEN_AZ_AFFINITY_WEIGHT,
1185            &cluster_scheduling::CLUSTER_ALTER_CHECK_READY_INTERVAL,
1186            &cluster_scheduling::CLUSTER_CHECK_SCHEDULING_POLICIES_INTERVAL,
1187            &cluster_scheduling::CLUSTER_SECURITY_CONTEXT_ENABLED,
1188            &cluster_scheduling::CLUSTER_REFRESH_MV_COMPACTION_ESTIMATE,
1189            &grpc_client::HTTP2_KEEP_ALIVE_TIMEOUT,
1190            &STATEMENT_LOGGING_MAX_SAMPLE_RATE,
1191            &STATEMENT_LOGGING_DEFAULT_SAMPLE_RATE,
1192            &STATEMENT_LOGGING_TARGET_DATA_RATE,
1193            &STATEMENT_LOGGING_MAX_DATA_CREDIT,
1194            &ENABLE_INTERNAL_STATEMENT_LOGGING,
1195            &OPTIMIZER_STATS_TIMEOUT,
1196            &OPTIMIZER_ONESHOT_STATS_TIMEOUT,
1197            &PRIVATELINK_STATUS_UPDATE_QUOTA_PER_MINUTE,
1198            &WEBHOOK_CONCURRENT_REQUEST_LIMIT,
1199            &PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_SIZE,
1200            &PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_WAIT,
1201            &PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL,
1202            &PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL_STAGGER,
1203            &USER_STORAGE_MANAGED_COLLECTIONS_BATCH_DURATION,
1204            &FORCE_SOURCE_TABLE_SYNTAX,
1205            &OPTIMIZER_E2E_LATENCY_WARNING_THRESHOLD,
1206            &SCRAM_ITERATIONS,
1207        ];
1208
1209        let dyncfgs = mz_dyncfgs::all_dyncfgs();
1210        let dyncfg_vars: Vec<_> = dyncfgs
1211            .entries()
1212            .map(|cfg| match cfg.default() {
1213                ConfigVal::Bool(default) => {
1214                    VarDefinition::new_runtime(cfg.name(), *default, cfg.desc(), false)
1215                }
1216                ConfigVal::U32(default) => {
1217                    VarDefinition::new_runtime(cfg.name(), *default, cfg.desc(), false)
1218                }
1219                ConfigVal::Usize(default) => {
1220                    VarDefinition::new_runtime(cfg.name(), *default, cfg.desc(), false)
1221                }
1222                ConfigVal::OptUsize(default) => {
1223                    VarDefinition::new_runtime(cfg.name(), *default, cfg.desc(), false)
1224                }
1225                ConfigVal::F64(default) => {
1226                    VarDefinition::new_runtime(cfg.name(), *default, cfg.desc(), false)
1227                }
1228                ConfigVal::String(default) => {
1229                    VarDefinition::new_runtime(cfg.name(), default.clone(), cfg.desc(), false)
1230                }
1231                ConfigVal::Duration(default) => {
1232                    VarDefinition::new_runtime(cfg.name(), default.clone(), cfg.desc(), false)
1233                }
1234                ConfigVal::Json(default) => {
1235                    VarDefinition::new_runtime(cfg.name(), default.clone(), cfg.desc(), false)
1236                }
1237            })
1238            .collect();
1239
1240        let vars: BTreeMap<_, _> = system_vars
1241            .into_iter()
1242            // Include all of our feature flags.
1243            .chain(definitions::FEATURE_FLAGS.iter().copied())
1244            // Include the subset of Session variables we allow system defaults for.
1245            .chain(SESSION_SYSTEM_VARS.values().copied())
1246            .cloned()
1247            // Include Persist configs.
1248            .chain(dyncfg_vars)
1249            .map(|var| (var.name, SystemVar::new(var)))
1250            .collect();
1251
1252        let vars = SystemVars {
1253            vars,
1254            callbacks: BTreeMap::new(),
1255            allow_unsafe: false,
1256            dyncfgs,
1257        };
1258
1259        vars
1260    }
1261
1262    pub fn dyncfgs(&self) -> &ConfigSet {
1263        &self.dyncfgs
1264    }
1265
1266    pub fn set_unsafe(mut self, allow_unsafe: bool) -> Self {
1267        self.allow_unsafe = allow_unsafe;
1268        self
1269    }
1270
1271    pub fn allow_unsafe(&self) -> bool {
1272        self.allow_unsafe
1273    }
1274
1275    fn expect_value<V: 'static>(&self, var: &VarDefinition) -> &V {
1276        let val = self
1277            .vars
1278            .get(var.name)
1279            .expect("provided var should be in state");
1280
1281        val.value_dyn()
1282            .as_any()
1283            .downcast_ref::<V>()
1284            .expect("provided var type should matched stored var")
1285    }
1286
1287    fn expect_config_value<V: ConfigType + 'static>(&self, name: &UncasedStr) -> &V {
1288        let val = self
1289            .vars
1290            .get(name)
1291            .unwrap_or_else(|| panic!("provided var {name} should be in state"));
1292
1293        val.value_dyn()
1294            .as_any()
1295            .downcast_ref()
1296            .expect("provided var type should matched stored var")
1297    }
1298
1299    /// Reset all the values to their defaults (preserving
1300    /// defaults from `VarMut::set_default).
1301    pub fn reset_all(&mut self) {
1302        for (_, var) in &mut self.vars {
1303            var.reset();
1304        }
1305    }
1306
1307    /// Returns an iterator over the configuration parameters and their current
1308    /// values on disk.
1309    pub fn iter(&self) -> impl Iterator<Item = &dyn Var> {
1310        self.vars
1311            .values()
1312            .map(|v| v.as_var())
1313            .filter(|v| !SESSION_SYSTEM_VARS.contains_key(UncasedStr::new(v.name())))
1314    }
1315
1316    /// Returns an iterator over the configuration parameters and their current
1317    /// values on disk. Compared to [`SystemVars::iter`], this should omit vars
1318    /// that shouldn't be synced by SystemParameterFrontend.
1319    pub fn iter_synced(&self) -> impl Iterator<Item = &dyn Var> {
1320        self.iter().filter(|v| v.name() != ENABLE_LAUNCHDARKLY.name)
1321    }
1322
1323    /// Returns an iterator over the configuration parameters that can be overriden per-Session.
1324    pub fn iter_session(&self) -> impl Iterator<Item = &dyn Var> {
1325        self.vars
1326            .values()
1327            .map(|v| v.as_var())
1328            .filter(|v| SESSION_SYSTEM_VARS.contains_key(UncasedStr::new(v.name())))
1329    }
1330
1331    /// Returns whether or not this parameter can be modified by a superuser.
1332    pub fn user_modifiable(&self, name: &str) -> bool {
1333        SESSION_SYSTEM_VARS.contains_key(UncasedStr::new(name))
1334            || name == ENABLE_RBAC_CHECKS.name()
1335            || name == NETWORK_POLICY.name()
1336    }
1337
1338    /// Returns a [`Var`] representing the configuration parameter with the
1339    /// specified name.
1340    ///
1341    /// Configuration parameters are matched case insensitively. If no such
1342    /// configuration parameter exists, `get` returns an error.
1343    ///
1344    /// Note that:
1345    /// - If `name` is known at compile time, you should instead use the named
1346    /// accessor to access the variable with its true Rust type. For example,
1347    /// `self.get("max_tables").value()` returns the string `"25"` or the
1348    /// current value, while `self.max_tables()` returns an i32.
1349    ///
1350    /// - This function does not check that the access variable should be
1351    /// visible because of other settings or users. Before or after accessing
1352    /// this method, you should call `Var::visible`.
1353    ///
1354    /// # Errors
1355    ///
1356    /// The call will return an error:
1357    /// 1. If `name` does not refer to a valid [`SystemVars`] field.
1358    pub fn get(&self, name: &str) -> Result<&dyn Var, VarError> {
1359        self.vars
1360            .get(UncasedStr::new(name))
1361            .map(|v| v.as_var())
1362            .ok_or_else(|| VarError::UnknownParameter(name.into()))
1363    }
1364
1365    /// Check if the given `values` is the default value for the [`Var`]
1366    /// identified by `name`.
1367    ///
1368    /// Note that this function does not check that the access variable should
1369    /// be visible because of other settings or users. Before or after accessing
1370    /// this method, you should call `Var::visible`.
1371    ///
1372    /// # Errors
1373    ///
1374    /// The call will return an error:
1375    /// 1. If `name` does not refer to a valid [`SystemVars`] field.
1376    /// 2. If `values` does not represent a valid [`SystemVars`] value for
1377    ///    `name`.
1378    pub fn is_default(&self, name: &str, input: VarInput) -> Result<bool, VarError> {
1379        self.vars
1380            .get(UncasedStr::new(name))
1381            .ok_or_else(|| VarError::UnknownParameter(name.into()))
1382            .and_then(|v| v.is_default(input))
1383    }
1384
1385    /// Sets the configuration parameter named `name` to the value represented
1386    /// by `input`.
1387    ///
1388    /// Like with [`SystemVars::get`], configuration parameters are matched case
1389    /// insensitively. If `input` is not valid, as determined by the underlying
1390    /// configuration parameter, or if the named configuration parameter does
1391    /// not exist, an error is returned.
1392    ///
1393    /// Return a `bool` value indicating whether the [`Var`] identified by
1394    /// `name` was modified by this call (it won't be if it already had the
1395    /// given `input`).
1396    ///
1397    /// Note that this function does not check that the access variable should
1398    /// be visible because of other settings or users. Before or after accessing
1399    /// this method, you should call `Var::visible`.
1400    ///
1401    /// # Errors
1402    ///
1403    /// The call will return an error:
1404    /// 1. If `name` does not refer to a valid [`SystemVars`] field.
1405    /// 2. If `input` does not represent a valid [`SystemVars`] value for
1406    ///    `name`.
1407    pub fn set(&mut self, name: &str, input: VarInput) -> Result<bool, VarError> {
1408        let result = self
1409            .vars
1410            .get_mut(UncasedStr::new(name))
1411            .ok_or_else(|| VarError::UnknownParameter(name.into()))
1412            .and_then(|v| v.set(input))?;
1413        self.notify_callbacks(name);
1414        Ok(result)
1415    }
1416
1417    /// Parses the configuration parameter value represented by `input` named
1418    /// `name`.
1419    ///
1420    /// Like with [`SystemVars::get`], configuration parameters are matched case
1421    /// insensitively. If `input` is not valid, as determined by the underlying
1422    /// configuration parameter, or if the named configuration parameter does
1423    /// not exist, an error is returned.
1424    ///
1425    /// Return a `Box<dyn Value>` that is the result of parsing `input`.
1426    ///
1427    /// Note that this function does not check that the access variable should
1428    /// be visible because of other settings or users. Before or after accessing
1429    /// this method, you should call `Var::visible`.
1430    ///
1431    /// # Errors
1432    ///
1433    /// The call will return an error:
1434    /// 1. If `name` does not refer to a valid [`SystemVars`] field.
1435    /// 2. If `input` does not represent a valid [`SystemVars`] value for
1436    ///    `name`.
1437    pub fn parse(&self, name: &str, input: VarInput) -> Result<Box<dyn Value>, VarError> {
1438        self.vars
1439            .get(UncasedStr::new(name))
1440            .ok_or_else(|| VarError::UnknownParameter(name.into()))
1441            .and_then(|v| v.parse(input))
1442    }
1443
1444    /// Set the default for this variable. This is the value this
1445    /// variable will be be `reset` to. If no default is set, the static default in the
1446    /// variable definition is used instead.
1447    ///
1448    /// Note that this function does not check that the access variable should
1449    /// be visible because of other settings or users. Before or after accessing
1450    /// this method, you should call `Var::visible`.
1451    pub fn set_default(&mut self, name: &str, input: VarInput) -> Result<(), VarError> {
1452        let result = self
1453            .vars
1454            .get_mut(UncasedStr::new(name))
1455            .ok_or_else(|| VarError::UnknownParameter(name.into()))
1456            .and_then(|v| v.set_default(input))?;
1457        self.notify_callbacks(name);
1458        Ok(result)
1459    }
1460
1461    /// Sets the configuration parameter named `name` to its default value.
1462    ///
1463    /// Like with [`SystemVars::get`], configuration parameters are matched case
1464    /// insensitively. If the named configuration parameter does not exist, an
1465    /// error is returned.
1466    ///
1467    /// Return a `bool` value indicating whether the [`Var`] identified by
1468    /// `name` was modified by this call (it won't be if was already reset).
1469    ///
1470    /// Note that this function does not check that the access variable should
1471    /// be visible because of other settings or users. Before or after accessing
1472    /// this method, you should call `Var::visible`.
1473    ///
1474    /// # Errors
1475    ///
1476    /// The call will return an error:
1477    /// 1. If `name` does not refer to a valid [`SystemVars`] field.
1478    pub fn reset(&mut self, name: &str) -> Result<bool, VarError> {
1479        let result = self
1480            .vars
1481            .get_mut(UncasedStr::new(name))
1482            .ok_or_else(|| VarError::UnknownParameter(name.into()))
1483            .map(|v| v.reset())?;
1484        self.notify_callbacks(name);
1485        Ok(result)
1486    }
1487
1488    /// Returns a map from each system parameter's name to its default value.
1489    pub fn defaults(&self) -> BTreeMap<String, String> {
1490        self.vars
1491            .iter()
1492            .map(|(name, var)| {
1493                let default = var
1494                    .dynamic_default
1495                    .as_deref()
1496                    .unwrap_or_else(|| var.definition.default_value());
1497                (name.as_str().to_owned(), default.format())
1498            })
1499            .collect()
1500    }
1501
1502    /// Registers a closure that will get called when the value for the
1503    /// specified [`VarDefinition`] changes.
1504    ///
1505    /// The callback is guaranteed to be called at least once.
1506    pub fn register_callback(
1507        &mut self,
1508        var: &VarDefinition,
1509        callback: Arc<dyn Fn(&SystemVars) + Send + Sync>,
1510    ) {
1511        self.callbacks
1512            .entry(var.name().to_string())
1513            .or_default()
1514            .push(callback);
1515        self.notify_callbacks(var.name());
1516    }
1517
1518    /// Notify any external components interested in this variable.
1519    fn notify_callbacks(&self, name: &str) {
1520        // Get the callbacks interested in this variable.
1521        if let Some(callbacks) = self.callbacks.get(name) {
1522            for callback in callbacks {
1523                (callback)(self);
1524            }
1525        }
1526    }
1527
1528    /// Returns the system default for the [`CLUSTER`] session variable. To know the active cluster
1529    /// for the current session, you must check the [`SessionVars`].
1530    pub fn default_cluster(&self) -> String {
1531        self.expect_value::<String>(&CLUSTER).to_owned()
1532    }
1533
1534    /// Returns the value of the `max_kafka_connections` configuration parameter.
1535    pub fn max_kafka_connections(&self) -> u32 {
1536        *self.expect_value(&MAX_KAFKA_CONNECTIONS)
1537    }
1538
1539    /// Returns the value of the `max_postgres_connections` configuration parameter.
1540    pub fn max_postgres_connections(&self) -> u32 {
1541        *self.expect_value(&MAX_POSTGRES_CONNECTIONS)
1542    }
1543
1544    /// Returns the value of the `max_mysql_connections` configuration parameter.
1545    pub fn max_mysql_connections(&self) -> u32 {
1546        *self.expect_value(&MAX_MYSQL_CONNECTIONS)
1547    }
1548
1549    /// Returns the value of the `max_sql_server_connections` configuration parameter.
1550    pub fn max_sql_server_connections(&self) -> u32 {
1551        *self.expect_value(&MAX_SQL_SERVER_CONNECTIONS)
1552    }
1553
1554    /// Returns the value of the `max_aws_privatelink_connections` configuration parameter.
1555    pub fn max_aws_privatelink_connections(&self) -> u32 {
1556        *self.expect_value(&MAX_AWS_PRIVATELINK_CONNECTIONS)
1557    }
1558
1559    /// Returns the value of the `max_tables` configuration parameter.
1560    pub fn max_tables(&self) -> u32 {
1561        *self.expect_value(&MAX_TABLES)
1562    }
1563
1564    /// Returns the value of the `max_sources` configuration parameter.
1565    pub fn max_sources(&self) -> u32 {
1566        *self.expect_value(&MAX_SOURCES)
1567    }
1568
1569    /// Returns the value of the `max_sinks` configuration parameter.
1570    pub fn max_sinks(&self) -> u32 {
1571        *self.expect_value(&MAX_SINKS)
1572    }
1573
1574    /// Returns the value of the `max_materialized_views` configuration parameter.
1575    pub fn max_materialized_views(&self) -> u32 {
1576        *self.expect_value(&MAX_MATERIALIZED_VIEWS)
1577    }
1578
1579    /// Returns the value of the `max_clusters` configuration parameter.
1580    pub fn max_clusters(&self) -> u32 {
1581        *self.expect_value(&MAX_CLUSTERS)
1582    }
1583
1584    /// Returns the value of the `max_replicas_per_cluster` configuration parameter.
1585    pub fn max_replicas_per_cluster(&self) -> u32 {
1586        *self.expect_value(&MAX_REPLICAS_PER_CLUSTER)
1587    }
1588
1589    /// Returns the value of the `max_credit_consumption_rate` configuration parameter.
1590    pub fn max_credit_consumption_rate(&self) -> Numeric {
1591        *self.expect_value(&MAX_CREDIT_CONSUMPTION_RATE)
1592    }
1593
1594    /// Returns the value of the `max_databases` configuration parameter.
1595    pub fn max_databases(&self) -> u32 {
1596        *self.expect_value(&MAX_DATABASES)
1597    }
1598
1599    /// Returns the value of the `max_schemas_per_database` configuration parameter.
1600    pub fn max_schemas_per_database(&self) -> u32 {
1601        *self.expect_value(&MAX_SCHEMAS_PER_DATABASE)
1602    }
1603
1604    /// Returns the value of the `max_objects_per_schema` configuration parameter.
1605    pub fn max_objects_per_schema(&self) -> u32 {
1606        *self.expect_value(&MAX_OBJECTS_PER_SCHEMA)
1607    }
1608
1609    /// Returns the value of the `max_secrets` configuration parameter.
1610    pub fn max_secrets(&self) -> u32 {
1611        *self.expect_value(&MAX_SECRETS)
1612    }
1613
1614    /// Returns the value of the `max_roles` configuration parameter.
1615    pub fn max_roles(&self) -> u32 {
1616        *self.expect_value(&MAX_ROLES)
1617    }
1618
1619    /// Returns the value of the `max_continual_tasks` configuration parameter.
1620    pub fn max_continual_tasks(&self) -> u32 {
1621        *self.expect_value(&MAX_CONTINUAL_TASKS)
1622    }
1623
1624    /// Returns the value of the `max_network_policies` configuration parameter.
1625    pub fn max_network_policies(&self) -> u32 {
1626        *self.expect_value(&MAX_NETWORK_POLICIES)
1627    }
1628
1629    /// Returns the value of the `max_network_policies` configuration parameter.
1630    pub fn max_rules_per_network_policy(&self) -> u32 {
1631        *self.expect_value(&MAX_RULES_PER_NETWORK_POLICY)
1632    }
1633
1634    /// Returns the value of the `max_result_size` configuration parameter.
1635    pub fn max_result_size(&self) -> u64 {
1636        self.expect_value::<ByteSize>(&MAX_RESULT_SIZE).as_bytes()
1637    }
1638
1639    /// Returns the value of the `max_copy_from_size` configuration parameter.
1640    pub fn max_copy_from_size(&self) -> u32 {
1641        *self.expect_value(&MAX_COPY_FROM_SIZE)
1642    }
1643
1644    /// Returns the value of the `allowed_cluster_replica_sizes` configuration parameter.
1645    pub fn allowed_cluster_replica_sizes(&self) -> Vec<String> {
1646        self.expect_value::<Vec<Ident>>(&ALLOWED_CLUSTER_REPLICA_SIZES)
1647            .into_iter()
1648            .map(|s| s.as_str().into())
1649            .collect()
1650    }
1651
1652    /// Returns the value of the `default_cluster_replication_factor` configuration parameter.
1653    pub fn default_cluster_replication_factor(&self) -> u32 {
1654        *self.expect_value::<u32>(&DEFAULT_CLUSTER_REPLICATION_FACTOR)
1655    }
1656
1657    pub fn upsert_rocksdb_compaction_style(&self) -> mz_rocksdb_types::config::CompactionStyle {
1658        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_COMPACTION_STYLE)
1659    }
1660
1661    pub fn upsert_rocksdb_optimize_compaction_memtable_budget(&self) -> usize {
1662        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_OPTIMIZE_COMPACTION_MEMTABLE_BUDGET)
1663    }
1664
1665    pub fn upsert_rocksdb_level_compaction_dynamic_level_bytes(&self) -> bool {
1666        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_LEVEL_COMPACTION_DYNAMIC_LEVEL_BYTES)
1667    }
1668
1669    pub fn upsert_rocksdb_universal_compaction_ratio(&self) -> i32 {
1670        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_UNIVERSAL_COMPACTION_RATIO)
1671    }
1672
1673    pub fn upsert_rocksdb_parallelism(&self) -> Option<i32> {
1674        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_PARALLELISM)
1675    }
1676
1677    pub fn upsert_rocksdb_compression_type(&self) -> mz_rocksdb_types::config::CompressionType {
1678        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_COMPRESSION_TYPE)
1679    }
1680
1681    pub fn upsert_rocksdb_bottommost_compression_type(
1682        &self,
1683    ) -> mz_rocksdb_types::config::CompressionType {
1684        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_BOTTOMMOST_COMPRESSION_TYPE)
1685    }
1686
1687    pub fn upsert_rocksdb_batch_size(&self) -> usize {
1688        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_BATCH_SIZE)
1689    }
1690
1691    pub fn upsert_rocksdb_retry_duration(&self) -> Duration {
1692        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_RETRY_DURATION)
1693    }
1694
1695    pub fn upsert_rocksdb_stats_log_interval_seconds(&self) -> u32 {
1696        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_STATS_LOG_INTERVAL_SECONDS)
1697    }
1698
1699    pub fn upsert_rocksdb_stats_persist_interval_seconds(&self) -> u32 {
1700        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_STATS_PERSIST_INTERVAL_SECONDS)
1701    }
1702
1703    pub fn upsert_rocksdb_point_lookup_block_cache_size_mb(&self) -> Option<u32> {
1704        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_POINT_LOOKUP_BLOCK_CACHE_SIZE_MB)
1705    }
1706
1707    pub fn upsert_rocksdb_shrink_allocated_buffers_by_ratio(&self) -> usize {
1708        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_SHRINK_ALLOCATED_BUFFERS_BY_RATIO)
1709    }
1710
1711    pub fn upsert_rocksdb_write_buffer_manager_cluster_memory_fraction(&self) -> Option<Numeric> {
1712        *self.expect_value(
1713            &upsert_rocksdb::UPSERT_ROCKSDB_WRITE_BUFFER_MANAGER_CLUSTER_MEMORY_FRACTION,
1714        )
1715    }
1716
1717    pub fn upsert_rocksdb_write_buffer_manager_memory_bytes(&self) -> Option<usize> {
1718        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_WRITE_BUFFER_MANAGER_MEMORY_BYTES)
1719    }
1720
1721    pub fn upsert_rocksdb_write_buffer_manager_allow_stall(&self) -> bool {
1722        *self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_WRITE_BUFFER_MANAGER_ALLOW_STALL)
1723    }
1724
1725    pub fn persist_fast_path_limit(&self) -> usize {
1726        *self.expect_value(&PERSIST_FAST_PATH_LIMIT)
1727    }
1728
1729    /// Returns the `pg_source_connect_timeout` configuration parameter.
1730    pub fn pg_source_connect_timeout(&self) -> Duration {
1731        *self.expect_value(&PG_SOURCE_CONNECT_TIMEOUT)
1732    }
1733
1734    /// Returns the `pg_source_tcp_keepalives_retries` configuration parameter.
1735    pub fn pg_source_tcp_keepalives_retries(&self) -> u32 {
1736        *self.expect_value(&PG_SOURCE_TCP_KEEPALIVES_RETRIES)
1737    }
1738
1739    /// Returns the `pg_source_tcp_keepalives_idle` configuration parameter.
1740    pub fn pg_source_tcp_keepalives_idle(&self) -> Duration {
1741        *self.expect_value(&PG_SOURCE_TCP_KEEPALIVES_IDLE)
1742    }
1743
1744    /// Returns the `pg_source_tcp_keepalives_interval` configuration parameter.
1745    pub fn pg_source_tcp_keepalives_interval(&self) -> Duration {
1746        *self.expect_value(&PG_SOURCE_TCP_KEEPALIVES_INTERVAL)
1747    }
1748
1749    /// Returns the `pg_source_tcp_user_timeout` configuration parameter.
1750    pub fn pg_source_tcp_user_timeout(&self) -> Duration {
1751        *self.expect_value(&PG_SOURCE_TCP_USER_TIMEOUT)
1752    }
1753
1754    /// Returns the `pg_source_tcp_configure_server` configuration parameter.
1755    pub fn pg_source_tcp_configure_server(&self) -> bool {
1756        *self.expect_value(&PG_SOURCE_TCP_CONFIGURE_SERVER)
1757    }
1758
1759    /// Returns the `pg_source_snapshot_statement_timeout` configuration parameter.
1760    pub fn pg_source_snapshot_statement_timeout(&self) -> Duration {
1761        *self.expect_value(&PG_SOURCE_SNAPSHOT_STATEMENT_TIMEOUT)
1762    }
1763
1764    /// Returns the `pg_source_wal_sender_timeout` configuration parameter.
1765    pub fn pg_source_wal_sender_timeout(&self) -> Option<Duration> {
1766        *self.expect_value(&PG_SOURCE_WAL_SENDER_TIMEOUT)
1767    }
1768
1769    /// Returns the `pg_source_snapshot_collect_strict_count` configuration parameter.
1770    pub fn pg_source_snapshot_collect_strict_count(&self) -> bool {
1771        *self.expect_value(&PG_SOURCE_SNAPSHOT_COLLECT_STRICT_COUNT)
1772    }
1773
1774    /// Returns the `mysql_source_tcp_keepalive` configuration parameter.
1775    pub fn mysql_source_tcp_keepalive(&self) -> Duration {
1776        *self.expect_value(&MYSQL_SOURCE_TCP_KEEPALIVE)
1777    }
1778
1779    /// Returns the `mysql_source_snapshot_max_execution_time` configuration parameter.
1780    pub fn mysql_source_snapshot_max_execution_time(&self) -> Duration {
1781        *self.expect_value(&MYSQL_SOURCE_SNAPSHOT_MAX_EXECUTION_TIME)
1782    }
1783
1784    /// Returns the `mysql_source_snapshot_lock_wait_timeout` configuration parameter.
1785    pub fn mysql_source_snapshot_lock_wait_timeout(&self) -> Duration {
1786        *self.expect_value(&MYSQL_SOURCE_SNAPSHOT_LOCK_WAIT_TIMEOUT)
1787    }
1788
1789    /// Returns the `mysql_source_connect_timeout` configuration parameter.
1790    pub fn mysql_source_connect_timeout(&self) -> Duration {
1791        *self.expect_value(&MYSQL_SOURCE_CONNECT_TIMEOUT)
1792    }
1793
1794    /// Returns the `ssh_check_interval` configuration parameter.
1795    pub fn ssh_check_interval(&self) -> Duration {
1796        *self.expect_value(&SSH_CHECK_INTERVAL)
1797    }
1798
1799    /// Returns the `ssh_connect_timeout` configuration parameter.
1800    pub fn ssh_connect_timeout(&self) -> Duration {
1801        *self.expect_value(&SSH_CONNECT_TIMEOUT)
1802    }
1803
1804    /// Returns the `ssh_keepalives_idle` configuration parameter.
1805    pub fn ssh_keepalives_idle(&self) -> Duration {
1806        *self.expect_value(&SSH_KEEPALIVES_IDLE)
1807    }
1808
1809    /// Returns the `kafka_socket_keepalive` configuration parameter.
1810    pub fn kafka_socket_keepalive(&self) -> bool {
1811        *self.expect_value(&KAFKA_SOCKET_KEEPALIVE)
1812    }
1813
1814    /// Returns the `kafka_socket_timeout` configuration parameter.
1815    pub fn kafka_socket_timeout(&self) -> Option<Duration> {
1816        *self.expect_value(&KAFKA_SOCKET_TIMEOUT)
1817    }
1818
1819    /// Returns the `kafka_transaction_timeout` configuration parameter.
1820    pub fn kafka_transaction_timeout(&self) -> Duration {
1821        *self.expect_value(&KAFKA_TRANSACTION_TIMEOUT)
1822    }
1823
1824    /// Returns the `kafka_socket_connection_setup_timeout` configuration parameter.
1825    pub fn kafka_socket_connection_setup_timeout(&self) -> Duration {
1826        *self.expect_value(&KAFKA_SOCKET_CONNECTION_SETUP_TIMEOUT)
1827    }
1828
1829    /// Returns the `kafka_fetch_metadata_timeout` configuration parameter.
1830    pub fn kafka_fetch_metadata_timeout(&self) -> Duration {
1831        *self.expect_value(&KAFKA_FETCH_METADATA_TIMEOUT)
1832    }
1833
1834    /// Returns the `kafka_progress_record_fetch_timeout` configuration parameter.
1835    pub fn kafka_progress_record_fetch_timeout(&self) -> Option<Duration> {
1836        *self.expect_value(&KAFKA_PROGRESS_RECORD_FETCH_TIMEOUT)
1837    }
1838
1839    /// Returns the `crdb_connect_timeout` configuration parameter.
1840    pub fn crdb_connect_timeout(&self) -> Duration {
1841        *self.expect_config_value(UncasedStr::new(
1842            mz_persist_client::cfg::CRDB_CONNECT_TIMEOUT.name(),
1843        ))
1844    }
1845
1846    /// Returns the `crdb_tcp_user_timeout` configuration parameter.
1847    pub fn crdb_tcp_user_timeout(&self) -> Duration {
1848        *self.expect_config_value(UncasedStr::new(
1849            mz_persist_client::cfg::CRDB_TCP_USER_TIMEOUT.name(),
1850        ))
1851    }
1852
1853    /// Returns the `crdb_keepalives_idle` configuration parameter.
1854    pub fn crdb_keepalives_idle(&self) -> Duration {
1855        *self.expect_config_value(UncasedStr::new(
1856            mz_persist_client::cfg::CRDB_KEEPALIVES_IDLE.name(),
1857        ))
1858    }
1859
1860    /// Returns the `crdb_keepalives_interval` configuration parameter.
1861    pub fn crdb_keepalives_interval(&self) -> Duration {
1862        *self.expect_config_value(UncasedStr::new(
1863            mz_persist_client::cfg::CRDB_KEEPALIVES_INTERVAL.name(),
1864        ))
1865    }
1866
1867    /// Returns the `crdb_keepalives_retries` configuration parameter.
1868    pub fn crdb_keepalives_retries(&self) -> u32 {
1869        *self.expect_config_value(UncasedStr::new(
1870            mz_persist_client::cfg::CRDB_KEEPALIVES_RETRIES.name(),
1871        ))
1872    }
1873
1874    /// Returns the `storage_dataflow_max_inflight_bytes` configuration parameter.
1875    pub fn storage_dataflow_max_inflight_bytes(&self) -> Option<usize> {
1876        *self.expect_value(&STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES)
1877    }
1878
1879    /// Returns the `storage_dataflow_max_inflight_bytes_to_cluster_size_fraction` configuration parameter.
1880    pub fn storage_dataflow_max_inflight_bytes_to_cluster_size_fraction(&self) -> Option<Numeric> {
1881        *self.expect_value(&STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_TO_CLUSTER_SIZE_FRACTION)
1882    }
1883
1884    /// Returns the `storage_shrink_upsert_unused_buffers_by_ratio` configuration parameter.
1885    pub fn storage_shrink_upsert_unused_buffers_by_ratio(&self) -> usize {
1886        *self.expect_value(&STORAGE_SHRINK_UPSERT_UNUSED_BUFFERS_BY_RATIO)
1887    }
1888
1889    /// Returns the `storage_dataflow_max_inflight_bytes_disk_only` configuration parameter.
1890    pub fn storage_dataflow_max_inflight_bytes_disk_only(&self) -> bool {
1891        *self.expect_value(&STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_DISK_ONLY)
1892    }
1893
1894    /// Returns the `storage_statistics_interval` configuration parameter.
1895    pub fn storage_statistics_interval(&self) -> Duration {
1896        *self.expect_value(&STORAGE_STATISTICS_INTERVAL)
1897    }
1898
1899    /// Returns the `storage_statistics_collection_interval` configuration parameter.
1900    pub fn storage_statistics_collection_interval(&self) -> Duration {
1901        *self.expect_value(&STORAGE_STATISTICS_COLLECTION_INTERVAL)
1902    }
1903
1904    /// Returns the `storage_record_source_sink_namespaced_errors` configuration parameter.
1905    pub fn storage_record_source_sink_namespaced_errors(&self) -> bool {
1906        *self.expect_value(&STORAGE_RECORD_SOURCE_SINK_NAMESPACED_ERRORS)
1907    }
1908
1909    /// Returns the `persist_stats_filter_enabled` configuration parameter.
1910    pub fn persist_stats_filter_enabled(&self) -> bool {
1911        *self.expect_config_value(UncasedStr::new(
1912            mz_persist_client::stats::STATS_FILTER_ENABLED.name(),
1913        ))
1914    }
1915
1916    pub fn scram_iterations(&self) -> NonZeroU32 {
1917        *self.expect_value(&SCRAM_ITERATIONS)
1918    }
1919
1920    pub fn dyncfg_updates(&self) -> ConfigUpdates {
1921        let mut updates = ConfigUpdates::default();
1922        for entry in self.dyncfgs.entries() {
1923            let name = UncasedStr::new(entry.name());
1924            let val = match entry.val() {
1925                ConfigVal::Bool(_) => ConfigVal::from(*self.expect_config_value::<bool>(name)),
1926                ConfigVal::U32(_) => ConfigVal::from(*self.expect_config_value::<u32>(name)),
1927                ConfigVal::Usize(_) => ConfigVal::from(*self.expect_config_value::<usize>(name)),
1928                ConfigVal::OptUsize(_) => {
1929                    ConfigVal::from(*self.expect_config_value::<Option<usize>>(name))
1930                }
1931                ConfigVal::F64(_) => ConfigVal::from(*self.expect_config_value::<f64>(name)),
1932                ConfigVal::String(_) => {
1933                    ConfigVal::from(self.expect_config_value::<String>(name).clone())
1934                }
1935                ConfigVal::Duration(_) => {
1936                    ConfigVal::from(*self.expect_config_value::<Duration>(name))
1937                }
1938                ConfigVal::Json(_) => {
1939                    ConfigVal::from(self.expect_config_value::<serde_json::Value>(name).clone())
1940                }
1941            };
1942            updates.add_dynamic(entry.name(), val);
1943        }
1944        updates.apply(&self.dyncfgs);
1945        updates
1946    }
1947
1948    /// Returns the `metrics_retention` configuration parameter.
1949    pub fn metrics_retention(&self) -> Duration {
1950        *self.expect_value(&METRICS_RETENTION)
1951    }
1952
1953    /// Returns the `unsafe_mock_audit_event_timestamp` configuration parameter.
1954    pub fn unsafe_mock_audit_event_timestamp(&self) -> Option<mz_repr::Timestamp> {
1955        *self.expect_value(&UNSAFE_MOCK_AUDIT_EVENT_TIMESTAMP)
1956    }
1957
1958    /// Returns the `enable_rbac_checks` configuration parameter.
1959    pub fn enable_rbac_checks(&self) -> bool {
1960        *self.expect_value(&ENABLE_RBAC_CHECKS)
1961    }
1962
1963    /// Returns the `max_connections` configuration parameter.
1964    pub fn max_connections(&self) -> u32 {
1965        *self.expect_value(&MAX_CONNECTIONS)
1966    }
1967
1968    pub fn default_network_policy_name(&self) -> String {
1969        self.expect_value::<String>(&NETWORK_POLICY).clone()
1970    }
1971
1972    /// Returns the `superuser_reserved_connections` configuration parameter.
1973    pub fn superuser_reserved_connections(&self) -> u32 {
1974        *self.expect_value(&SUPERUSER_RESERVED_CONNECTIONS)
1975    }
1976
1977    pub fn keep_n_source_status_history_entries(&self) -> usize {
1978        *self.expect_value(&KEEP_N_SOURCE_STATUS_HISTORY_ENTRIES)
1979    }
1980
1981    pub fn keep_n_sink_status_history_entries(&self) -> usize {
1982        *self.expect_value(&KEEP_N_SINK_STATUS_HISTORY_ENTRIES)
1983    }
1984
1985    pub fn keep_n_privatelink_status_history_entries(&self) -> usize {
1986        *self.expect_value(&KEEP_N_PRIVATELINK_STATUS_HISTORY_ENTRIES)
1987    }
1988
1989    pub fn replica_status_history_retention_window(&self) -> Duration {
1990        *self.expect_value(&REPLICA_STATUS_HISTORY_RETENTION_WINDOW)
1991    }
1992
1993    /// Returns the `enable_storage_shard_finalization` configuration parameter.
1994    pub fn enable_storage_shard_finalization(&self) -> bool {
1995        *self.expect_value(&ENABLE_STORAGE_SHARD_FINALIZATION)
1996    }
1997
1998    pub fn enable_consolidate_after_union_negate(&self) -> bool {
1999        *self.expect_value(&ENABLE_CONSOLIDATE_AFTER_UNION_NEGATE)
2000    }
2001
2002    pub fn enable_reduce_reduction(&self) -> bool {
2003        *self.expect_value(&ENABLE_REDUCE_REDUCTION)
2004    }
2005
2006    /// Returns the `enable_default_connection_validation` configuration parameter.
2007    pub fn enable_default_connection_validation(&self) -> bool {
2008        *self.expect_value(&ENABLE_DEFAULT_CONNECTION_VALIDATION)
2009    }
2010
2011    /// Returns the `min_timestamp_interval` configuration parameter.
2012    pub fn min_timestamp_interval(&self) -> Duration {
2013        *self.expect_value(&MIN_TIMESTAMP_INTERVAL)
2014    }
2015    /// Returns the `max_timestamp_interval` configuration parameter.
2016    pub fn max_timestamp_interval(&self) -> Duration {
2017        *self.expect_value(&MAX_TIMESTAMP_INTERVAL)
2018    }
2019
2020    pub fn logging_filter(&self) -> CloneableEnvFilter {
2021        self.expect_value::<CloneableEnvFilter>(&LOGGING_FILTER)
2022            .clone()
2023    }
2024
2025    pub fn opentelemetry_filter(&self) -> CloneableEnvFilter {
2026        self.expect_value::<CloneableEnvFilter>(&OPENTELEMETRY_FILTER)
2027            .clone()
2028    }
2029
2030    pub fn logging_filter_defaults(&self) -> Vec<SerializableDirective> {
2031        self.expect_value::<Vec<SerializableDirective>>(&LOGGING_FILTER_DEFAULTS)
2032            .clone()
2033    }
2034
2035    pub fn opentelemetry_filter_defaults(&self) -> Vec<SerializableDirective> {
2036        self.expect_value::<Vec<SerializableDirective>>(&OPENTELEMETRY_FILTER_DEFAULTS)
2037            .clone()
2038    }
2039
2040    pub fn sentry_filters(&self) -> Vec<SerializableDirective> {
2041        self.expect_value::<Vec<SerializableDirective>>(&SENTRY_FILTERS)
2042            .clone()
2043    }
2044
2045    pub fn webhooks_secrets_caching_ttl_secs(&self) -> usize {
2046        *self.expect_value(&WEBHOOKS_SECRETS_CACHING_TTL_SECS)
2047    }
2048
2049    pub fn coord_slow_message_warn_threshold(&self) -> Duration {
2050        *self.expect_value(&COORD_SLOW_MESSAGE_WARN_THRESHOLD)
2051    }
2052
2053    pub fn grpc_client_http2_keep_alive_interval(&self) -> Duration {
2054        *self.expect_value(&grpc_client::HTTP2_KEEP_ALIVE_INTERVAL)
2055    }
2056
2057    pub fn grpc_client_http2_keep_alive_timeout(&self) -> Duration {
2058        *self.expect_value(&grpc_client::HTTP2_KEEP_ALIVE_TIMEOUT)
2059    }
2060
2061    pub fn grpc_connect_timeout(&self) -> Duration {
2062        *self.expect_value(&grpc_client::CONNECT_TIMEOUT)
2063    }
2064
2065    pub fn cluster_multi_process_replica_az_affinity_weight(&self) -> Option<i32> {
2066        *self.expect_value(&cluster_scheduling::CLUSTER_MULTI_PROCESS_REPLICA_AZ_AFFINITY_WEIGHT)
2067    }
2068
2069    pub fn cluster_soften_replication_anti_affinity(&self) -> bool {
2070        *self.expect_value(&cluster_scheduling::CLUSTER_SOFTEN_REPLICATION_ANTI_AFFINITY)
2071    }
2072
2073    pub fn cluster_soften_replication_anti_affinity_weight(&self) -> i32 {
2074        *self.expect_value(&cluster_scheduling::CLUSTER_SOFTEN_REPLICATION_ANTI_AFFINITY_WEIGHT)
2075    }
2076
2077    pub fn cluster_enable_topology_spread(&self) -> bool {
2078        *self.expect_value(&cluster_scheduling::CLUSTER_ENABLE_TOPOLOGY_SPREAD)
2079    }
2080
2081    pub fn cluster_topology_spread_ignore_non_singular_scale(&self) -> bool {
2082        *self.expect_value(&cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_IGNORE_NON_SINGULAR_SCALE)
2083    }
2084
2085    pub fn cluster_topology_spread_max_skew(&self) -> i32 {
2086        *self.expect_value(&cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_MAX_SKEW)
2087    }
2088
2089    pub fn cluster_topology_spread_set_min_domains(&self) -> Option<i32> {
2090        *self.expect_value(&cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_MIN_DOMAINS)
2091    }
2092
2093    pub fn cluster_topology_spread_soft(&self) -> bool {
2094        *self.expect_value(&cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_SOFT)
2095    }
2096
2097    pub fn cluster_soften_az_affinity(&self) -> bool {
2098        *self.expect_value(&cluster_scheduling::CLUSTER_SOFTEN_AZ_AFFINITY)
2099    }
2100
2101    pub fn cluster_soften_az_affinity_weight(&self) -> i32 {
2102        *self.expect_value(&cluster_scheduling::CLUSTER_SOFTEN_AZ_AFFINITY_WEIGHT)
2103    }
2104
2105    pub fn cluster_alter_check_ready_interval(&self) -> Duration {
2106        *self.expect_value(&cluster_scheduling::CLUSTER_ALTER_CHECK_READY_INTERVAL)
2107    }
2108
2109    pub fn cluster_check_scheduling_policies_interval(&self) -> Duration {
2110        *self.expect_value(&cluster_scheduling::CLUSTER_CHECK_SCHEDULING_POLICIES_INTERVAL)
2111    }
2112
2113    pub fn cluster_security_context_enabled(&self) -> bool {
2114        *self.expect_value(&cluster_scheduling::CLUSTER_SECURITY_CONTEXT_ENABLED)
2115    }
2116
2117    pub fn cluster_refresh_mv_compaction_estimate(&self) -> Duration {
2118        *self.expect_value(&cluster_scheduling::CLUSTER_REFRESH_MV_COMPACTION_ESTIMATE)
2119    }
2120
2121    /// Returns the `privatelink_status_update_quota_per_minute` configuration parameter.
2122    pub fn privatelink_status_update_quota_per_minute(&self) -> u32 {
2123        *self.expect_value(&PRIVATELINK_STATUS_UPDATE_QUOTA_PER_MINUTE)
2124    }
2125
2126    pub fn statement_logging_target_data_rate(&self) -> Option<usize> {
2127        *self.expect_value(&STATEMENT_LOGGING_TARGET_DATA_RATE)
2128    }
2129
2130    pub fn statement_logging_max_data_credit(&self) -> Option<usize> {
2131        *self.expect_value(&STATEMENT_LOGGING_MAX_DATA_CREDIT)
2132    }
2133
2134    /// Returns the `statement_logging_max_sample_rate` configuration parameter.
2135    pub fn statement_logging_max_sample_rate(&self) -> Numeric {
2136        *self.expect_value(&STATEMENT_LOGGING_MAX_SAMPLE_RATE)
2137    }
2138
2139    /// Returns the `statement_logging_default_sample_rate` configuration parameter.
2140    pub fn statement_logging_default_sample_rate(&self) -> Numeric {
2141        *self.expect_value(&STATEMENT_LOGGING_DEFAULT_SAMPLE_RATE)
2142    }
2143
2144    /// Returns the `enable_internal_statement_logging` configuration parameter.
2145    pub fn enable_internal_statement_logging(&self) -> bool {
2146        *self.expect_value(&ENABLE_INTERNAL_STATEMENT_LOGGING)
2147    }
2148
2149    /// Returns the `optimizer_stats_timeout` configuration parameter.
2150    pub fn optimizer_stats_timeout(&self) -> Duration {
2151        *self.expect_value(&OPTIMIZER_STATS_TIMEOUT)
2152    }
2153
2154    /// Returns the `optimizer_oneshot_stats_timeout` configuration parameter.
2155    pub fn optimizer_oneshot_stats_timeout(&self) -> Duration {
2156        *self.expect_value(&OPTIMIZER_ONESHOT_STATS_TIMEOUT)
2157    }
2158
2159    /// Returns the `webhook_concurrent_request_limit` configuration parameter.
2160    pub fn webhook_concurrent_request_limit(&self) -> usize {
2161        *self.expect_value(&WEBHOOK_CONCURRENT_REQUEST_LIMIT)
2162    }
2163
2164    /// Returns the `pg_timestamp_oracle_connection_pool_max_size` configuration parameter.
2165    pub fn pg_timestamp_oracle_connection_pool_max_size(&self) -> usize {
2166        *self.expect_value(&PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_SIZE)
2167    }
2168
2169    /// Returns the `pg_timestamp_oracle_connection_pool_max_wait` configuration parameter.
2170    pub fn pg_timestamp_oracle_connection_pool_max_wait(&self) -> Option<Duration> {
2171        *self.expect_value(&PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_WAIT)
2172    }
2173
2174    /// Returns the `pg_timestamp_oracle_connection_pool_ttl` configuration parameter.
2175    pub fn pg_timestamp_oracle_connection_pool_ttl(&self) -> Duration {
2176        *self.expect_value(&PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL)
2177    }
2178
2179    /// Returns the `pg_timestamp_oracle_connection_pool_ttl_stagger` configuration parameter.
2180    pub fn pg_timestamp_oracle_connection_pool_ttl_stagger(&self) -> Duration {
2181        *self.expect_value(&PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL_STAGGER)
2182    }
2183
2184    /// Returns the `user_storage_managed_collections_batch_duration` configuration parameter.
2185    pub fn user_storage_managed_collections_batch_duration(&self) -> Duration {
2186        *self.expect_value(&USER_STORAGE_MANAGED_COLLECTIONS_BATCH_DURATION)
2187    }
2188
2189    pub fn force_source_table_syntax(&self) -> bool {
2190        *self.expect_value(&FORCE_SOURCE_TABLE_SYNTAX)
2191    }
2192
2193    pub fn optimizer_e2e_latency_warning_threshold(&self) -> Duration {
2194        *self.expect_value(&OPTIMIZER_E2E_LATENCY_WARNING_THRESHOLD)
2195    }
2196
2197    /// Returns whether the named variable is a controller configuration parameter.
2198    pub fn is_controller_config_var(&self, name: &str) -> bool {
2199        self.is_dyncfg_var(name)
2200    }
2201
2202    /// Returns whether the named variable is a compute configuration parameter
2203    /// (things that go in `ComputeParameters` and are sent to replicas via `UpdateConfiguration`
2204    /// commands).
2205    pub fn is_compute_config_var(&self, name: &str) -> bool {
2206        name == MAX_RESULT_SIZE.name() || self.is_dyncfg_var(name) || is_tracing_var(name)
2207    }
2208
2209    /// Returns whether the named variable is a metrics configuration parameter
2210    pub fn is_metrics_config_var(&self, name: &str) -> bool {
2211        self.is_dyncfg_var(name)
2212    }
2213
2214    /// Returns whether the named variable is a storage configuration parameter.
2215    pub fn is_storage_config_var(&self, name: &str) -> bool {
2216        name == PG_SOURCE_CONNECT_TIMEOUT.name()
2217            || name == PG_SOURCE_TCP_KEEPALIVES_IDLE.name()
2218            || name == PG_SOURCE_TCP_KEEPALIVES_INTERVAL.name()
2219            || name == PG_SOURCE_TCP_KEEPALIVES_RETRIES.name()
2220            || name == PG_SOURCE_TCP_USER_TIMEOUT.name()
2221            || name == PG_SOURCE_TCP_CONFIGURE_SERVER.name()
2222            || name == PG_SOURCE_SNAPSHOT_STATEMENT_TIMEOUT.name()
2223            || name == PG_SOURCE_WAL_SENDER_TIMEOUT.name()
2224            || name == PG_SOURCE_SNAPSHOT_COLLECT_STRICT_COUNT.name()
2225            || name == MYSQL_SOURCE_TCP_KEEPALIVE.name()
2226            || name == MYSQL_SOURCE_SNAPSHOT_MAX_EXECUTION_TIME.name()
2227            || name == MYSQL_SOURCE_SNAPSHOT_LOCK_WAIT_TIMEOUT.name()
2228            || name == MYSQL_SOURCE_CONNECT_TIMEOUT.name()
2229            || name == ENABLE_STORAGE_SHARD_FINALIZATION.name()
2230            || name == SSH_CHECK_INTERVAL.name()
2231            || name == SSH_CONNECT_TIMEOUT.name()
2232            || name == SSH_KEEPALIVES_IDLE.name()
2233            || name == KAFKA_SOCKET_KEEPALIVE.name()
2234            || name == KAFKA_SOCKET_TIMEOUT.name()
2235            || name == KAFKA_TRANSACTION_TIMEOUT.name()
2236            || name == KAFKA_SOCKET_CONNECTION_SETUP_TIMEOUT.name()
2237            || name == KAFKA_FETCH_METADATA_TIMEOUT.name()
2238            || name == KAFKA_PROGRESS_RECORD_FETCH_TIMEOUT.name()
2239            || name == STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES.name()
2240            || name == STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_TO_CLUSTER_SIZE_FRACTION.name()
2241            || name == STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_DISK_ONLY.name()
2242            || name == STORAGE_SHRINK_UPSERT_UNUSED_BUFFERS_BY_RATIO.name()
2243            || name == STORAGE_RECORD_SOURCE_SINK_NAMESPACED_ERRORS.name()
2244            || name == STORAGE_STATISTICS_INTERVAL.name()
2245            || name == STORAGE_STATISTICS_COLLECTION_INTERVAL.name()
2246            || name == USER_STORAGE_MANAGED_COLLECTIONS_BATCH_DURATION.name()
2247            || is_upsert_rocksdb_config_var(name)
2248            || self.is_dyncfg_var(name)
2249            || is_tracing_var(name)
2250    }
2251
2252    /// Returns whether the named variable is a dyncfg configuration parameter.
2253    fn is_dyncfg_var(&self, name: &str) -> bool {
2254        self.dyncfgs.entries().any(|e| name == e.name())
2255    }
2256}
2257
2258pub fn is_tracing_var(name: &str) -> bool {
2259    name == LOGGING_FILTER.name()
2260        || name == LOGGING_FILTER_DEFAULTS.name()
2261        || name == OPENTELEMETRY_FILTER.name()
2262        || name == OPENTELEMETRY_FILTER_DEFAULTS.name()
2263        || name == SENTRY_FILTERS.name()
2264}
2265
2266/// Returns whether the named variable is a caching configuration parameter.
2267pub fn is_secrets_caching_var(name: &str) -> bool {
2268    name == WEBHOOKS_SECRETS_CACHING_TTL_SECS.name()
2269}
2270
2271fn is_upsert_rocksdb_config_var(name: &str) -> bool {
2272    name == upsert_rocksdb::UPSERT_ROCKSDB_COMPACTION_STYLE.name()
2273        || name == upsert_rocksdb::UPSERT_ROCKSDB_OPTIMIZE_COMPACTION_MEMTABLE_BUDGET.name()
2274        || name == upsert_rocksdb::UPSERT_ROCKSDB_LEVEL_COMPACTION_DYNAMIC_LEVEL_BYTES.name()
2275        || name == upsert_rocksdb::UPSERT_ROCKSDB_UNIVERSAL_COMPACTION_RATIO.name()
2276        || name == upsert_rocksdb::UPSERT_ROCKSDB_PARALLELISM.name()
2277        || name == upsert_rocksdb::UPSERT_ROCKSDB_COMPRESSION_TYPE.name()
2278        || name == upsert_rocksdb::UPSERT_ROCKSDB_BOTTOMMOST_COMPRESSION_TYPE.name()
2279        || name == upsert_rocksdb::UPSERT_ROCKSDB_BATCH_SIZE.name()
2280        || name == upsert_rocksdb::UPSERT_ROCKSDB_STATS_LOG_INTERVAL_SECONDS.name()
2281        || name == upsert_rocksdb::UPSERT_ROCKSDB_STATS_PERSIST_INTERVAL_SECONDS.name()
2282        || name == upsert_rocksdb::UPSERT_ROCKSDB_POINT_LOOKUP_BLOCK_CACHE_SIZE_MB.name()
2283        || name == upsert_rocksdb::UPSERT_ROCKSDB_SHRINK_ALLOCATED_BUFFERS_BY_RATIO.name()
2284}
2285
2286/// Returns whether the named variable is a (Postgres/CRDB) timestamp oracle
2287/// configuration parameter.
2288pub fn is_timestamp_oracle_config_var(name: &str) -> bool {
2289    name == PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_SIZE.name()
2290        || name == PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_WAIT.name()
2291        || name == PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL.name()
2292        || name == PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL_STAGGER.name()
2293        || name == CRDB_CONNECT_TIMEOUT.name()
2294        || name == CRDB_TCP_USER_TIMEOUT.name()
2295        || name == CRDB_KEEPALIVES_IDLE.name()
2296        || name == CRDB_KEEPALIVES_INTERVAL.name()
2297        || name == CRDB_KEEPALIVES_RETRIES.name()
2298}
2299
2300/// Returns whether the named variable is a cluster scheduling config
2301pub fn is_cluster_scheduling_var(name: &str) -> bool {
2302    name == cluster_scheduling::CLUSTER_MULTI_PROCESS_REPLICA_AZ_AFFINITY_WEIGHT.name()
2303        || name == cluster_scheduling::CLUSTER_SOFTEN_REPLICATION_ANTI_AFFINITY.name()
2304        || name == cluster_scheduling::CLUSTER_SOFTEN_REPLICATION_ANTI_AFFINITY_WEIGHT.name()
2305        || name == cluster_scheduling::CLUSTER_ENABLE_TOPOLOGY_SPREAD.name()
2306        || name == cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_IGNORE_NON_SINGULAR_SCALE.name()
2307        || name == cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_MAX_SKEW.name()
2308        || name == cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_SOFT.name()
2309        || name == cluster_scheduling::CLUSTER_SOFTEN_AZ_AFFINITY.name()
2310        || name == cluster_scheduling::CLUSTER_SOFTEN_AZ_AFFINITY_WEIGHT.name()
2311}
2312
2313/// Returns whether the named variable is an HTTP server related config var.
2314pub fn is_http_config_var(name: &str) -> bool {
2315    name == WEBHOOK_CONCURRENT_REQUEST_LIMIT.name()
2316}
2317
2318/// Set of [`SystemVar`]s that can also get set at a per-Session level.
2319///
2320/// TODO(parkmycar): Instead of a separate list, make this a field on VarDefinition.
2321static SESSION_SYSTEM_VARS: LazyLock<BTreeMap<&'static UncasedStr, &'static VarDefinition>> =
2322    LazyLock::new(|| {
2323        [
2324            &APPLICATION_NAME,
2325            &CLIENT_ENCODING,
2326            &CLIENT_MIN_MESSAGES,
2327            &CLUSTER,
2328            &CLUSTER_REPLICA,
2329            &DEFAULT_CLUSTER_REPLICATION_FACTOR,
2330            &CURRENT_OBJECT_MISSING_WARNINGS,
2331            &DATABASE,
2332            &DATE_STYLE,
2333            &EXTRA_FLOAT_DIGITS,
2334            &INTEGER_DATETIMES,
2335            &INTERVAL_STYLE,
2336            &REAL_TIME_RECENCY_TIMEOUT,
2337            &SEARCH_PATH,
2338            &STANDARD_CONFORMING_STRINGS,
2339            &STATEMENT_TIMEOUT,
2340            &IDLE_IN_TRANSACTION_SESSION_TIMEOUT,
2341            &TIMEZONE,
2342            &TRANSACTION_ISOLATION,
2343            &MAX_QUERY_RESULT_SIZE,
2344        ]
2345        .into_iter()
2346        .map(|var| (UncasedStr::new(var.name()), var))
2347        .collect()
2348    });
2349
2350// Provides a wrapper to express that a particular `ServerVar` is meant to be used as a feature
2351/// flag.
2352#[derive(Debug)]
2353pub struct FeatureFlag {
2354    pub flag: &'static VarDefinition,
2355    pub feature_desc: &'static str,
2356}
2357
2358impl FeatureFlag {
2359    /// Returns an error unless the feature flag is enabled in the provided
2360    /// `system_vars`.
2361    pub fn require(&'static self, system_vars: &SystemVars) -> Result<(), VarError> {
2362        match *system_vars.expect_value::<bool>(self.flag) {
2363            true => Ok(()),
2364            false => Err(VarError::RequiresFeatureFlag { feature_flag: self }),
2365        }
2366    }
2367}
2368
2369impl PartialEq for FeatureFlag {
2370    fn eq(&self, other: &FeatureFlag) -> bool {
2371        self.flag.name() == other.flag.name()
2372    }
2373}
2374
2375impl Eq for FeatureFlag {}
2376
2377impl Var for MzVersion {
2378    fn name(&self) -> &'static str {
2379        MZ_VERSION_NAME.as_str()
2380    }
2381
2382    fn value(&self) -> String {
2383        self.build_info
2384            .human_version(self.helm_chart_version.clone())
2385    }
2386
2387    fn description(&self) -> &'static str {
2388        "Shows the Materialize server version (Materialize)."
2389    }
2390
2391    fn type_name(&self) -> Cow<'static, str> {
2392        String::type_name()
2393    }
2394
2395    fn visible(&self, _: &User, _: &SystemVars) -> Result<(), VarError> {
2396        Ok(())
2397    }
2398}
2399
2400impl Var for User {
2401    fn name(&self) -> &'static str {
2402        IS_SUPERUSER_NAME.as_str()
2403    }
2404
2405    fn value(&self) -> String {
2406        self.is_superuser().format()
2407    }
2408
2409    fn description(&self) -> &'static str {
2410        "Reports whether the current session is a superuser (PostgreSQL)."
2411    }
2412
2413    fn type_name(&self) -> Cow<'static, str> {
2414        bool::type_name()
2415    }
2416
2417    fn visible(&self, _: &User, _: &SystemVars) -> Result<(), VarError> {
2418        Ok(())
2419    }
2420}