gcloud metastore federations update

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 namemy-metastore-federation in locationus-central withtwo backendsdpms1 anddpms2, 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 theproject attribute:

  • provide the argumentfederation on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

FEDERATION
ID of the federation or fully qualified identifier for the federation.

To set thefederation attribute:

  • provide the argumentfederation on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--location=LOCATION
The location of the Dataproc Metastore service.

If not specified, will usedefault metastore/location.To set thelocation attribute:

  • provide the argumentfederation on the command line with a fullyspecified name;
  • provide the argument--location on the command line;
  • set the propertymetastore/location.
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 ofRANK=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 toresolve database name collisions.BACKEND is specified asMETASTORE_TYPE:METASTORE_NAME whereMETASTORE_TYPE isthe type of backend metastore andMETASTORE_NAME is 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-backends must be usedwith--update-backends.
--remove-backends=RANK
Comma-separated list of metastore backend keys to remove with the formRANK1,RANK2. The Key represents the rank of the backend metastoreand is used to resolve database name collisions. If aRANK does notexist then it is sliently ignored. If--update-backends is alsospecified, then--remove-backends is applied first.
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-labels is also specified then--clear-labels is applied first.

For example, to remove all labels:

gcloudmetastorefederationsupdate--clear-labels

To remove all existing labels and create two new labels,foo andbaz:

gcloudmetastorefederationsupdate--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-labels is also specified then--update-labels is 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 help for details.

API REFERENCE
This command uses themetastore/v1 API. The full documentation forthis API can be found at:https://cloud.google.com/dataproc-metastore/docs
NOTES
These variants are also available:
gcloudalphametastorefederationsupdate
gcloudbetametastorefederationsupdate

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.