Struct mz_storage_types::connections::ConnectionContext

pub struct ConnectionContext {
    pub environment_id: String,
    pub librdkafka_log_level: Level,
    pub aws_external_id_prefix: Option<AwsExternalIdPrefix>,
    pub aws_connection_role_arn: Option<String>,
    pub secrets_reader: Arc<dyn SecretsReader>,
    pub cloud_resource_reader: Option<Arc<dyn CloudResourceReader>>,
    pub ssh_tunnel_manager: SshTunnelManager,
}

Extra context to pass through when instantiating a connection for a source or sink.

Should be kept cheaply cloneable.

Fields

environment_id: String

An opaque identifier for the environment in which this process is running.

The storage layer is intentionally unaware of the structure within this identifier. Higher layers of the stack can make use of that structure, but the storage layer should be oblivious to it.

librdkafka_log_level: Level

The level for librdkafka’s logs.

aws_external_id_prefix: Option<AwsExternalIdPrefix>

A prefix for an external ID to use for all AWS AssumeRole operations.

aws_connection_role_arn: Option<String>

The ARN for a Materialize-controlled role to assume before assuming a customer’s requested role for an AWS connection.

secrets_reader: Arc<dyn SecretsReader>

A secrets reader.

cloud_resource_reader: Option<Arc<dyn CloudResourceReader>>

A cloud resource reader, if supported in this configuration.

ssh_tunnel_manager: SshTunnelManager

A manager for SSH tunnels.

Implementations

impl ConnectionContext

pub fn from_cli_args( environment_id: String, startup_log_level: &CloneableEnvFilter, aws_external_id_prefix: Option<AwsExternalIdPrefix>, aws_connection_role_arn: Option<String>, secrets_reader: Arc<dyn SecretsReader>, cloud_resource_reader: Option<Arc<dyn CloudResourceReader>> ) -> ConnectionContext

Constructs a new connection context from command line arguments.

WARNING: it is critical for security that the aws_external_id be provided by the operator of the Materialize service (i.e., via a CLI argument or environment variable) and not the end user of Materialize (e.g., via a configuration option in a SQL statement). See AwsExternalIdPrefix for details.

pub fn for_tests(secrets_reader: Arc<dyn SecretsReader>) -> ConnectionContext

Constructs a new connection context for usage in tests.

Trait Implementations

impl Clone for ConnectionContext

fn clone(&self) -> ConnectionContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionContext

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

Formats the value using the given formatter.