gcloud metastore federations update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud metastore federations update - update a Dataproc Metastore federation
- SYNOPSIS
gcloud 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
- Update the metadata and/or configuration parameters of a Dataproc Metastorefederation.
If run asynchronously with
--async, exits after printing oneoperation name that can be used to poll the status of the update via:gcloudmetastoreoperationsdescribe
- EXAMPLES
- To update a Dataproc Metastore federation with the name
my-metastore-federationin locationus-centralwithtwo backendsdpms1anddpms2, run:gcloudmetastorefederationsupdatemy-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 Metastorefederation you want to update. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
federationon the command line with a fullyspecified 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 thisgroup 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 fullyspecified 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 Metastorefederation you want to update. The arguments in this group can be used tospecify the attributes of this resource. (NOTE) Some attributes are not givenarguments 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 toresolve database name collisions.BACKENDis specified asMETASTORE_TYPE:METASTORE_NAMEwhereMETASTORE_TYPEisthe type of backend metastore andMETASTORE_NAMEis the relativeresource name of the metastore. If only the name of the metastore is specified(e.g.dpms1), project and location will be inferred from theproject and location used to create the federation. - At most one of these can be specified:
--clear-backends- Clear existing metastore backends.
--clear-backendsmust be usedwith--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 metastoreand is used to resolve database name collisions. If aRANKdoes notexist then it is sliently ignored. If--update-backendsis alsospecified, 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 ismodified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens(
-), underscores (_), lowercase characters, andnumbers. 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:
gcloudmetastorefederationsupdate--clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloudmetastorefederationsupdate--clear-labels--update-labelsfoo=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/v1API. The full documentation forthis API can be found at:https://cloud.google.com/dataproc-metastore/docs - NOTES
- These variants are also available:
gcloudalphametastorefederationsupdategcloudbetametastorefederationsupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-22 UTC.