- NAME
-
- gcloud beta metastore federations update - update a Dataproc Metastore federation
- SYNOPSIS
-
-
gcloud beta 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 …]
-
- DESCRIPTION
-
(BETA)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
- EXAMPLES
-
To update a Dataproc Metastore federation with the name
my-metastore-federationin locationus-centralwith two backendsdpms1anddpms2, run:gcloud beta metastore federations update my-metastore-federation --location=us-central1 --update-backends=1=dpms:dpms1,2=dpms:projects/my-project/locations/us-central1/services/dpms2 - POSITIONAL ARGUMENTS
-
-
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
projectattribute:-
provide the argument
federationon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
FEDERATION-
ID of the federation or fully qualified identifier for the federation.
To set the
federationattribute:-
provide the argument
federationon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location=LOCATION-
The location of the Dataproc Metastore service.
If not specified, will use
defaultmetastore/location. To set thelocationattribute:-
provide the argument
federationon the command line with a fully specified name; -
provide the argument
--locationon the command line; -
set the property
metastore/location.
-
provide the argument
-
provide the argument
-
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.
- REQUIRED FLAGS
-
-
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=BACKENDpairs. For example:1=dpms:dpms1,2=dpms:projects/my-project/locations/us-central1/services/dpms2.RANKrepresents the rank of the backend metastore and is used to resolve database name collisions.BACKENDis specified asMETASTORE_TYPE:METASTORE_NAMEwhereMETASTORE_TYPEis the type of backend metastore andMETASTORE_NAMEis 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-backendsmust 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 aRANKdoes not exist then it is sliently ignored. If--update-backendsis also specified, then--remove-backendsis applied first.
-
Update the backend metastores by passing key-value pairs in through the flags.
At least one of these must be specified:
- OPTIONAL FLAGS
-
--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-labelsis also specified then--clear-labelsis applied first.For example, to remove all labels:
gcloud beta metastore federations update --clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloud beta 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-labelsis also specified then--update-labelsis applied first.
- GCLOUD WIDE FLAGS
-
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 helpfor details. - API REFERENCE
-
This command uses the
metastore/v1betaAPI. The full documentation for this API can be found at: https://cloud.google.com/dataproc-metastore/docs - NOTES
-
This command is currently in beta and might change without notice. These
variants are also available:
gcloud metastore federations updategcloud alpha metastore federations update
gcloud beta metastore federations update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-22 UTC.