- NAME
-
- gcloud metastore services create - create a Dataproc Metastore service
- SYNOPSIS
-
-
gcloud metastore services create(SERVICE:--location=LOCATION) [--async] [--data-catalog-sync] [--database-type=DATABASE_TYPE; default="mysql"] [--encryption-kms-key=ENCRYPTION_KMS_KEY] [--endpoint-protocol=ENDPOINT_PROTOCOL; default="thrift"] [--hive-metastore-version=HIVE_METASTORE_VERSION] [--labels=[KEY=VALUE,…]] [--port=PORT; default=9083] [--release-channel=RELEASE_CHANNEL; default="stable"] [--auxiliary-versions=[AUXILIARY_VERSIONS,…] |--auxiliary-versions-from-file=AUXILIARY_VERSIONS_FROM_FILE] [--consumer-subnetworks=[CONSUMER_SUBNETWORKS,…] |--network=NETWORK|--network-config-from-file=NETWORK_CONFIG_FROM_FILE] [--hive-metastore-configs=[KEY=VALUE,…] |--hive-metastore-configs-from-file=HIVE_METASTORE_CONFIGS_FROM_FILE] [--instance-size=INSTANCE_SIZE|--scaling-factor=SCALING_FACTOR|--tier=TIER] [--kerberos-principal=KERBEROS_PRINCIPAL--keytab=KEYTAB--krb5-config=KRB5_CONFIG] [--maintenance-window-day=MAINTENANCE_WINDOW_DAY--maintenance-window-hour=MAINTENANCE_WINDOW_HOUR] [--scheduled-backup-configs-from-file=SCHEDULED_BACKUP_CONFIGS_FROM_FILE|--enable-scheduled-backup--scheduled-backup-cron=SCHEDULED_BACKUP_CRON--scheduled-backup-location=SCHEDULED_BACKUP_LOCATION] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
Create a new Dataproc Metastore service 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 service with the name
my-metastore-servicein locationus-centralusing a non default port 9090, run:gcloud metastore services create my-metastore-service --location=us-central1 --port=9090To create a Dataproc Metastore service with the name
my-metastore-servicein locationus-centralusing a non default network foo, run:gcloud metastore services create my-metastore-service --location=us-central1 --network=foo - POSITIONAL ARGUMENTS
-
-
Service resource - Arguments and flags that specify the Dataproc Metastore
service 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
projectattribute:-
provide the argument
serviceon the command line with a fully specified name; -
set the property
core/project; -
provide the argument
--projecton the command line.
This must be specified.
SERVICE-
ID of the service or fully qualified identifier for the service.
To set the
serviceattribute:-
provide the argument
serviceon 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
serviceon 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
-
Service resource - Arguments and flags that specify the Dataproc Metastore
service 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.
- FLAGS
-
--async- Return immediately, without waiting for the operation in progress to complete.
--data-catalog-sync-
A boolean flag to determine whether Dataproc Metastore metadata sync to Data
Catalog should be enabled, false if unspecified. Mutually exclusive with flag
--encryption-kms-key. --database-type=DATABASE_TYPE; default="mysql"-
The type of database the Dataproc Metastore service will store data in.
DATABASE_TYPEmust be one of:mysql-
MYSQLdatabase type is a Dataproc Metastore service backed by MySQL CloudSQL. spanner-
SPANNERdatabase type is a Dataproc Metastore service backed by Cloud Spanner.
--encryption-kms-key=ENCRYPTION_KMS_KEY-
The name of the Cloud KMS key to use for customer data encryption. Cannot be
changed once the service is created. Mutually exclusive with flag
--data-catalog-sync. This can be provided as a fully-qualified URL, or a relative name in the formprojects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}. --endpoint-protocol=ENDPOINT_PROTOCOL; default="thrift"-
The protocol to use for the metastore service endpoint. If unspecified, defaults
to
THRIFT.ENDPOINT_PROTOCOLmust be one of:grpc-
The modernized
GRPCprotocol. thrift-
The legacy Apache
THRIFTprotocol.
--hive-metastore-version=HIVE_METASTORE_VERSION-
The Hive metastore schema version. The supported versions of a location are
listed via:
gcloud metastore locations describe
If unspecified, the default version chosen by the server will be used.
--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. --port=PORT; default=9083- The TCP port on which the Metastore service will listen. If unspecified, the default port 9083 will be used.
--release-channel=RELEASE_CHANNEL; default="stable"-
The release channel of the service.
RELEASE_CHANNELmust be one of:canary-
The
CANARYrelease channel contains the newest features, which may be unstable and subject to unresolved issues with no known workarounds. Services using theCANARYrelease channel are not subject to any SLAs. stable-
The
STABLErelease channel contains features that are considered stable and have been validated for production use.
-
Auxiliary versions configuration for the Dataproc Metastore service. When
specified, a secondary Hive metastore service is created along with the primary
service.
At most one of these can be specified:
--auxiliary-versions=[AUXILIARY_VERSIONS,…]- Comma-separated list of auxiliary Hive metastore versions to deploy. Auxiliary Hive metastore versions must be less than the primary Hive metastore service's version.
--auxiliary-versions-from-file=AUXILIARY_VERSIONS_FROM_FILE-
Path to a YAML file containing the auxiliary versions configuration for Dataproc
Metastore instance. The file should contain a unique auxiliary service name and
auxiliary version that is lower than the primary service version. The primary
version's Hive metastore configs are applied to the auxiliary version.
Additional Hive metastore configs can be specified for the auxiliary version
using "config_overrides". If a specified config property has already been
overridden in the primary Hive metastore version's configs, the auxiliary
version's override takes precedence. The contents of the file should be
structured as follows:
YAML:
- name: aux-service1 version: x.y.z config_overrides: key1: value1 key2: value2 … - name: aux-service2 version: x.y.z config_overrides: key1: value1 key2: value2 … …
-
Network configuration for the metastore service.
At most one of these can be specified:
--consumer-subnetworks=[CONSUMER_SUBNETWORKS,…]-
The list of subnetworks from which the service can be accessed. This can be the
subnetwork's ID, fully-qualified URL, or relative name in the form
projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork}. --network=NETWORK-
The name of the network on which the service can be accessed. This can be the
network's ID, fully-qualified URL, or relative name in the form
projects/{project_id}/global/networks/{network}. If "network", "consumer-subnetworks" and "network-config" are unspecified, the "default" network will be used. --network-config-from-file=NETWORK_CONFIG_FROM_FILE-
Path to a YAML file containing the network configuration for Dataproc Metastore
instance. The contents of the file should be structured as follows:
YAML: consumers:
- subnetwork: projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id}
- subnetwork: projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id} …
-
Configuration properties specific to running Hive metastore software as the
metastore service.
At most one of these can be specified:
--hive-metastore-configs=[KEY=VALUE,…]- A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore.
--hive-metastore-configs-from-file=HIVE_METASTORE_CONFIGS_FROM_FILE-
Path to a XML file containing a mapping of Hive metastore configuration
key-value pairs to apply to the Hive metastore.
For example:
hive-site.xml <configuration> <property> <name>hive.metastore.warehouse.dir</name> <value>${test.warehouse.dir}</value> <description></description> </property> </configuration>
-
The instance size of the Dataproc Metastore instance.
At most one of these can be specified:
--instance-size=INSTANCE_SIZE-
The instance size of the service.
INSTANCE_SIZEmust be one of:extra-large- Extra large instance size, maps to a scaling factor of 6.0.
extra-small- Extra small instance size, maps to a scaling factor of 0.1.
large- Large instance size, maps to a scaling factor of 3.0.
medium- Medium instance size, maps to a scaling factor of 1.0.
small- Small instance size, maps to a scaling factor of 0.5.
--scaling-factor=SCALING_FACTOR- The scaling factor of the service. Can be one of [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0].
--tier=TIER-
The tier of the service.
TIERmust be one of:developer- The developer tier provides limited scalability and no fault tolerance. Good for low-cost proof-of-concept.
enterprise- The enterprise tier provides multi-zone high availability, and sufficient scalability for enterprise-level Dataproc Metastore workloads.
-
Information used to configure the Hive metastore service as a service principal
in a Kerberos realm.
--kerberos-principal=KERBEROS_PRINCIPAL-
A Kerberos principal that exists in the KDC to authenticate as. A typical
principal is of the form "primary/instance@REALM", but there is no exact format.
This flag argument must be specified if any of the other arguments in this group are specified.
--keytab=KEYTAB-
A Kerberos keytab file that can be used to authenticate a service principal with
a Kerberos Key Distribution Center. This is a Secret Manager secret version, and
can be fully-qualified URL, or relative name in the form
projects/{project_id}/secrets/{secret_id}/versions/{version_id}.This flag argument must be specified if any of the other arguments in this group are specified.
--krb5-config=KRB5_CONFIG-
A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the
form gs://{bucket_name}/path/krb5.conf, although the file does not need to be
named krb5.conf explicitly.
This flag argument must be specified if any of the other arguments in this group are specified.
-
The one hour maintenance window that specifies when Dataproc Metastore may
perform system maintenance operation to the service, in UTC time.
--maintenance-window-day=MAINTENANCE_WINDOW_DAY-
The day of week when the window starts, e.g.,
sun.MAINTENANCE_WINDOW_DAYmust be one of:fri,mon,sat,sun,thu,tue,wed.This flag argument must be specified if any of the other arguments in this group are specified.
--maintenance-window-hour=MAINTENANCE_WINDOW_HOUR-
The hour of day (0-23) when the window starts.
This flag argument must be specified if any of the other arguments in this group are specified.
-
Scheduled backup configurations to enable a scheduled backup of the metastore
service.
At most one of these can be specified:
--scheduled-backup-configs-from-file=SCHEDULED_BACKUP_CONFIGS_FROM_FILE-
Path to a JSON file containing a mapping of scheduled backup configurations
key-value pairs to apply to the scheduled backup.
For example:
backup_configs.json { "enabled": true, "cron_schedule": "0 * * * *", "backup_location": "gs://example-bucket", "time_zone": "UTC" } -
Scheduled backup configurations to enable a scheduled backup of the metastore
service.
--enable-scheduled-backup- Enable or disable scheduled backups for the Metastore service.
--scheduled-backup-cron=SCHEDULED_BACKUP_CRON- Specify the frequency of a scheduled backup of the metastore service.
--scheduled-backup-location=SCHEDULED_BACKUP_LOCATION- Set the Cloud Storage URI to store the scheduled backups of the metastore service.
- 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 for this API can be found at: https://cloud.google.com/dataproc-metastore/docs - NOTES
-
These variants are also available:
gcloud alpha metastore services creategcloud beta metastore services create
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 2024-04-16 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]