.TH "GCLOUD_ALPHA_METASTORE_SERVICES_MIGRATIONS_START" 1



.SH "NAME"
.HP
gcloud alpha metastore services migrations start \- start the migration on a Dataproc Metastore service



.SH "SYNOPSIS"
.HP
\f5gcloud alpha metastore services migrations start\fR (\fISERVICE\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) ((\fB\-\-cdc\-password\fR=\fICDC_PASSWORD\fR\ \fB\-\-cdc\-username\fR=\fICDC_USERNAME\fR\ \fB\-\-reverse\-proxy\-subnet\fR=\fIREVERSE_PROXY_SUBNET\fR\ \fB\-\-subnet\-ip\-range\fR=\fISUBNET_IP_RANGE\fR\ \fB\-\-vpc\-network\fR=\fIVPC_NETWORK\fR\ :\ \fB\-\-bucket\fR=\fIBUCKET\fR\ \fB\-\-root\-path\fR=\fIROOT_PATH\fR;\ default="/migration")\ (\fB\-\-connection\-password\fR=\fICONNECTION_PASSWORD\fR\ \fB\-\-connection\-username\fR=\fICONNECTION_USERNAME\fR\ \fB\-\-hive\-database\-name\fR=\fIHIVE_DATABASE_NAME\fR\ \fB\-\-instance\-connection\-name\fR=\fIINSTANCE_CONNECTION_NAME\fR\ \fB\-\-ip\-address\fR=\fIIP_ADDRESS\fR\ \fB\-\-nat\-subnet\fR=\fINAT_SUBNET\fR\ \fB\-\-port\fR=\fIPORT\fR\ \fB\-\-proxy\-subnet\fR=\fIPROXY_SUBNET\fR)) [\fB\-\-async\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Start the migration on a Dataproc Metastore service.

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

.RS 2m
gcloud metastore operations describe
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Service resource \- The Dataproc Metastore service to start the migration on.
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 \f5service\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
\fISERVICE\fR

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

To set the \f5service\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5service\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 \f5service\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

Configuration information required by Dataproc Metastore to start the migration.


This must be specified.


.RS 2m
.TP 2m

Configuration information specific to migrating from "Self\-Managed Hive
Metastore on Google Cloud Platform with Cloud SQL as the backend database" to a
Dataproc Metastore service.



.RS 2m
.TP 2m

Configuration information required to start the Change Data Capture (CDC)
streams from customer's Cloud SQL database to backend database of Dataproc
Metastore.


This must be specified.


.RS 2m
.TP 2m
\fB\-\-cdc\-password\fR=\fICDC_PASSWORD\fR

The password for the user that Datastream service should use for the MySQL
connection.

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

.TP 2m
\fB\-\-cdc\-username\fR=\fICDC_USERNAME\fR

The username that the Datastream service should use for the MySQL connection.

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

.TP 2m
\fB\-\-reverse\-proxy\-subnet\fR=\fIREVERSE_PROXY_SUBNET\fR

The URL of the subnetwork resource to create the VM instance hosting the reverse
proxy in. More context in
https://cloud.google.com/datastream/docs/private\-connectivity#reverse\-csql\-proxy
The subnetwork should reside in the network provided in the request that
Datastream will peer to and should be in the same region as Datastream, in the
following format.
"projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id}""

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

.TP 2m
\fB\-\-subnet\-ip\-range\fR=\fISUBNET_IP_RANGE\fR

A "/29" CIDR IP range for peering with datastream

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

.TP 2m
\fB\-\-vpc\-network\fR=\fIVPC_NETWORK\fR

Fully qualified name of the Cloud SQL instance's VPC network or the shared VPC
network that Datastream will peer to, in the following format:
"projects/{project_id}/locations/global/networks/{network_id}". More context in
https://cloud.google.com/datastream/docs/network\-connectivity\-options#privateconnectivity

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

.TP 2m
\fB\-\-bucket\fR=\fIBUCKET\fR

The bucket to write the intermediate stream event data in. The bucket name must
be without any prefix like "gs://". This field is optional. If not set, the
Artifacts Cloud Storage bucket is used.

.TP 2m
\fB\-\-root\-path\fR=\fIROOT_PATH\fR; default="/migration"

The root path inside the Cloud Storage bucket. The stream event data will be
written to this path. The default value is "/migration".

.RE
.sp
.TP 2m

Configuration information required for Dataproc Metastore to establish customer
database connection before the cutover phase of migration.


This must be specified.


.RS 2m
.TP 2m
\fB\-\-connection\-password\fR=\fICONNECTION_PASSWORD\fR

The password for the user that Dataproc Metastore service should use to connect
to the database.

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

.TP 2m
\fB\-\-connection\-username\fR=\fICONNECTION_USERNAME\fR

The username that Dataproc Metastore service should use to connect to the
database.

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

.TP 2m
\fB\-\-hive\-database\-name\fR=\fIHIVE_DATABASE_NAME\fR

The name of the hive metastore database.

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

.TP 2m
\fB\-\-instance\-connection\-name\fR=\fIINSTANCE_CONNECTION_NAME\fR

The Cloud SQL database connection name, in the format,
"project_id:region:instance_name"

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

.TP 2m
\fB\-\-ip\-address\fR=\fIIP_ADDRESS\fR

The private IP address of the Cloud SQL instance.

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

.TP 2m
\fB\-\-nat\-subnet\fR=\fINAT_SUBNET\fR

The relative resource name of the subnetwork to be used for Private Service
Connect. Note that this cannot be a regular subnet and is used only for NAT.
More context in
https://cloud.google.com/vpc/docs/about\-vpc\-hosted\-services#psc\-subnets.
This subnet is used to publish the SOCKS5 proxy service. The subnet size must be
at least \f5/29\fR and it should reside in a network through which the Cloud SQL
instance is accessible. The resource name should be in the format,
"projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id}"

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

.TP 2m
\fB\-\-port\fR=\fIPORT\fR

The network port of the database.

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

.TP 2m
\fB\-\-proxy\-subnet\fR=\fIPROXY_SUBNET\fR

The relative resource name of the subnetwork to deploy the SOCKS5 proxy service
in. The subnetwork should reside in a network through which the Cloud SQL
instance is accessible. The resource name should be in the format,
"projects/{project_id}/regions/{region_id}/subnetworks/{subnetwork_id}"

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


.RE
.RE
.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

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

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


.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. This variant is also available:

.RS 2m
$ gcloud beta metastore services migrations start
.RE