mz region

The mz region command manages regions in your organization.

enable

Enable a region.

mz region enable [options...]
WARNING! You cannot disable a region with mz. To disable a region, contact support.

Arguments

Argument Environment variables Description
--region=<REGION> MZ_REGION Use the specified region.
--profile=<PROFILE> MZ_PROFILE Use the specified authentication profile.

Examples

Enable the aws/us-east-1 region:

$ mz region enable --region=aws/us-east-1
Region enabled.

list, ls

List all regions.

mz region {list,ls}

Arguments

Argument Environment variables Description
--profile=<PROFILE> MZ_PROFILE Use the specified authentication profile.

Examples

$ mz region list
Region                  | Status
------------------------|---------
aws/us-east-1           | enabled
aws/eu-west-1           | enabled

show

Show detailed status for a region.

mz region show [options...]

Arguments

Argument Environment variables Description
--region=<REGION> MZ_REGION Use the specified region.
--profile=<PROFILE> MZ_PROFILE Use the specified authentication profile.

Examples

Show the status of the aws/us-east-1 region:

$ mz region show --region=aws/us-east-1
Healthy:      yes
SQL address:  2358g2t42.us-east-1.aws.materialize.cloud:6875
HTTP URL:     https://2358g2t42.us-east-1.aws.materialize.cloud

Global flags

Argument Environment variables Description
‑‑config MZ_CONFIG Set the configuration file.
Default: $HOME/.config/materialize/mz.toml.
‑f, ‑‑format MZ_FORMAT Set the output format: text , json, or csv.
Default: text.
‑‑no‑color NO_COLOR, MZ_NO_COLOR Disable color output.
‑‑help Display help and exit.
‑‑version Display version and exit.
Back to top ↑