Expand description
Configuration loading for profiles and project settings.
Loads connection profiles from profiles.toml (resolved via --profiles-dir,
MZ_DEPLOY_PROFILES_DIR, or ~/.mz/ default) and project settings
from project.toml. Key types:
Profile— Resolved connection details (host, port, credentials).ProfilesConfig— All profiles loaded from a singleprofiles.toml.ProjectSettings— Per-project config: active profile name, optional Materialize version / Docker image override, and an optionaldependenciesarray of fully qualifieddatabase.schema.objectnames that this project reads from but does not own.
Passwords can be pulled from the environment via an inline ${VAR} in the
password field, or via MZ_PROFILE_<NAME>_PASSWORD (see
ProfilesConfig::expand_env_vars for details).
Structs§
- Profile
- Resolved connection details for a Materialize region.
- Profile
Config - Per-profile configuration from
project.toml. - Profiles
Config - All connection profiles loaded from a
profiles.tomlfile. - Project
Settings - Parsed contents of
project.toml. - Security
Config - Security-related settings for a profile (e.g., AWS credentials for secret resolution).
- Settings
- Resolved settings for an mz-deploy execution.
Enums§
- Config
Error - Errors that can occur when loading or resolving configuration from
profiles.tomlandproject.toml. - SslMode
- TLS mode selection for a profile, matching libpq’s
sslmodevocabulary
Constants§
- EMULATOR_
PROFILE_ NAME - Name of the built-in profile that targets a local Materialize emulator.
- MZPROFILE_
FILENAME - Filename of the per-project default-profile pointer.
Functions§
- default_
docker_ image - The Docker image used when no
mz_versionis configured. - read_
mzprofile - Read the default profile name from
<project_directory>/.mzprofile. - write_
mzprofile - Write
profile_nameto<project_directory>/.mzprofile, replacing any existing content.