HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/396/help/man/man1/gcloud_alpha_metastore_federations_create.1
.TH "GCLOUD_ALPHA_METASTORE_FEDERATIONS_CREATE" 1



.SH "NAME"
.HP
gcloud alpha metastore federations create \- create a Dataproc Metastore federation



.SH "SYNOPSIS"
.HP
\f5gcloud alpha metastore federations create\fR (\fIFEDERATION\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) \fB\-\-backends\fR=\fIRANK\fR=\fIBACKEND\fR [\fB\-\-async\fR] [\fB\-\-hive\-metastore\-version\fR=\fIHIVE_METASTORE_VERSION\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-tags\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

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

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

.RS 2m
gcloud metastore operations describe
.RE



.SH "EXAMPLES"

To create a Dataproc Metastore federation with the name
\f5my\-metastore\-federation\fR in location \f5us\-central\fR with two backends
\f5dpms1\fR and \f5dpms2\fR, run:

.RS 2m
$ gcloud alpha metastore federations create \e
  my\-metastore\-federation \-\-location=us\-central1 \e
  \-\-backends=1=dpms:dpms1,2=dpms:projects/my\-project/locations/\e
us\-central1/services/dpms2
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5federation\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIFEDERATION\fR

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

To set the \f5federation\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5federation\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

The location of the Dataproc Metastore service.

If not specified, will use \f5default\fR metastore/location.


To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5federation\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5metastore/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-backends\fR=\fIRANK\fR=\fIBACKEND\fR

Backends from which the federation service serves metadata at query time. The
backends are specified as a comma\-separated list of \f5RANK=BACKEND\fR pairs.
For example:
\f51=dpms:dpms1,2=dpms:projects/my\-project/locations/us\-central1/services/dpms2\fR.
\f5RANK\fR represents the rank of the backend metastore and is used to resolve
database name collisions. \f5BACKEND\fR is specified as
\f5METASTORE_TYPE:METASTORE_NAME\fR where \f5METASTORE_TYPE\fR is the type of
backend metastore and \f5METASTORE_NAME\fR is the relative resource name of the
metastore. If only the name of the metastore is specified (e.g. \f5dpms1\fR),
project and location will be inferred from the project and location used to
create the federation.


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

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

.TP 2m
\fB\-\-hive\-metastore\-version\fR=\fIHIVE_METASTORE_VERSION\fR

Hive metastore schema version of the Metastore federation.
\fIHIVE_METASTORE_VERSION\fR must be one of: \fB2.3.6\fR, \fB3.1.2\fR.

.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m
\fB\-\-tags\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of tag KEY=VALUE pairs to add.


.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBmetastore/v1alpha\fR API. The full documentation for
this API can be found at: https://cloud.google.com/dataproc\-metastore/docs



.SH "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:

.RS 2m
$ gcloud metastore federations create
.RE

.RS 2m
$ gcloud beta metastore federations create
.RE