gcloud alpha metastore federations update - update a Dataproc Metastore federation
gcloud alpha metastore federations update (FEDERATION : --location=LOCATION) (--update-backends=RANK=BACKEND --clear-backends | --remove-backends=RANK) [--async] [--update-labels=[KEY=VALUE,...]] [--clear-labels | --remove-labels=[KEY,...]] [GCLOUD_WIDE_FLAG ...]
(ALPHA) Update the metadata and/or configuration parameters of a Dataproc Metastore federation.
If run asynchronously with --async, exits after printing one operation name that can be used to poll the status of the update via:
gcloud metastore operations describe
To update a Dataproc Metastore federation with the name my-metastore-federation in location us-central with two backends dpms1 and dpms2, run:
$ gcloud alpha metastore federations update \ my-metastore-federation --location=us-central1 \ --update-backends=1=dpms:dpms1,2=dpms:projects/my-project/\ locations/us-central1/services/dpms2
- Federation resource - Arguments and flags that specify the Dataproc Metastore
federation you want to update. The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways. To set the project attribute:
- —
provide the argument federation on the command line with a fully specified name;
- —
set the property core/project;
- —
provide the argument --project on the command line.
This must be specified.
- FEDERATION
ID of the federation or fully qualified identifier for the federation. To set the federation attribute:
provide the argument federation on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
- --location=LOCATION
The location of the Dataproc Metastore service.
If not specified, will use default metastore/location.
To set the location attribute:
provide the argument federation on the command line with a fully specified name;
provide the argument --location on the command line;
set the property metastore/location.
- Update the backend metastores by passing key-value pairs in through the flags.
At least one of these must be specified:
- --update-backends=RANK=BACKEND
Comma-separated list of metastore backends specified as a list of RANK=BACKEND pairs. For example: 1=dpms:dpms1,2=dpms:projects/my-project/locations/us-central1/services/dpms2. RANK represents the rank of the backend metastore and is used to resolve database name collisions. BACKEND is specified as METASTORE_TYPE:METASTORE_NAME where METASTORE_TYPE is the type of backend metastore and METASTORE_NAME is the relative resource name of the metastore. If only the name of the metastore is specified (e.g. dpms1), project and location will be inferred from the project and location used to create the federation.
- At most one of these can be specified:
- --clear-backends
Clear existing metastore backends. --clear-backends must be used with --update-backends.
- --remove-backends=RANK
Comma-separated list of metastore backend keys to remove with the form RANK1,RANK2. The Key represents the rank of the backend metastore and is used to resolve database name collisions. If a RANK does not exist then it is sliently ignored. If --update-backends is also specified, then --remove-backends is applied first.
- --async
Return immediately, without waiting for the operation in progress to complete.
- --update-labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to update. If a label exists, its value is modified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.
- At most one of these can be specified:
- --clear-labels
Remove all labels. If --update-labels is also specified then --clear-labels is applied first.
For example, to remove all labels:
$ gcloud alpha metastore federations update --clear-labels
To remove all existing labels and create two new labels, foo and baz:
$ gcloud alpha metastore federations update --clear-labels \ --update-labels foo=bar,baz=qux
- --remove-labels=[KEY,...]
List of label keys to remove. If a label does not exist it is silently ignored. If --update-labels is also specified then --update-labels is applied first.
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
This command uses the metastore/v1alpha API. The full documentation for this API can be found at: https://cloud.google.com/dataproc-metastore/docs
This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. These variants are also available:
$ gcloud metastore federations update
$ gcloud beta metastore federations update