NAME

gcloud alpha metastore federations create - create a Dataproc Metastore federation

SYNOPSIS

gcloud alpha metastore federations create (FEDERATION : --location=LOCATION) --backends=RANK=BACKEND [--async] [--hive-metastore-version=HIVE_METASTORE_VERSION] [--labels=[KEY=VALUE,...]] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) Create a new Dataproc Metastore federation with the given name and configurations.

If run asynchronously with --async, exits after printing one operation name that can be used to poll the status of the creation via:

gcloud metastore operations describe

EXAMPLES

To create 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 create \ my-metastore-federation --location=us-central1 \ --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 create. 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.

REQUIRED FLAGS

--backends=RANK=BACKEND

Backends from which the federation service serves metadata at query time. The backends are specified as a comma-separated 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.

OPTIONAL FLAGS

--async

Return immediately, without waiting for the operation in progress to complete.

--hive-metastore-version=HIVE_METASTORE_VERSION

Hive metastore schema version of the Metastore federation. HIVE_METASTORE_VERSION must be one of: 2.3.6, 3.1.2.

--labels=[KEY=VALUE,...]

List of label KEY=VALUE pairs to add.

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.

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 the metastore/v1alpha API. The full documentation for this API can be found at: https://cloud.google.com/dataproc-metastore/docs

NOTES

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 create

$ gcloud beta metastore federations create