- NAME
-
- gcloud alpha database-migration migration-jobs create - create a Database Migration Service migration job
- SYNOPSIS
-
-
gcloud alpha database-migration migration-jobs create
(MIGRATION_JOB
:--region
=REGION
)--destination
=DESTINATION
--source
=SOURCE
--type
=TYPE
[--no-async
] [--display-name
=DISPLAY_NAME
] [--dump-path
=DUMP_PATH
] [--labels
=[KEY
=VALUE
,…]] [--peer-vpc
=PEER_VPC
|--static-ip
| [--vm-ip
=VM_IP
--vm-port
=VM_PORT
--vpc
=VPC
:--vm
=VM
]] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
Create a Database Migration Service migration job. Recommended steps before creating the migration job:- Create a source connection profile. See prerequisites here.
- Create a destination connection profile. For migrating to Cloud SQL for MySQL or Cloud SQL for PostgreSQL, use the cloudsql connection profile for DMS to create the CloudSQL replica for you.
- Configure the connectivity method. See prerequisites here.
- EXAMPLES
-
To create a continuous migration job with IP allowlist connectivity:
gcloud alpha database-migration migration-jobs create my-migration-job --region=us-central1 --type=CONTINUOUS --source=cp1 --destination=cp2
To create a continuous migration job with VPC peering connectivity:
gcloud alpha database-migration migration-jobs create my-migration-job --region=us-central1 --type=CONTINUOUS --source=cp1 --destination=cp2 --peer-vpc=projects/my-project/global/networks/my-network
To create a one-time migration job with reverse-SSH tunnel connectivity:
gcloud alpha database-migration migration-jobs create my-migration-job --region=us-central1 --type=ONE_TIME --source=cp1 --destination=cp2 --vm=vm1 --vm-ip=1.1.1.1 --vm-port=1111 --vpc=projects/my-project/global/networks/my-network
- POSITIONAL ARGUMENTS
-
-
Migration job resource - The migration job 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
migration_job
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
This must be specified.
MIGRATION_JOB
-
ID of the migration_job or fully qualified identifier for the migration_job.
To set the
migration_job
attribute:-
provide the argument
migration_job
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--region
=REGION
-
The Cloud region for the migration_job.
To set the
region
attribute:-
provide the argument
migration_job
on the command line with a fully specified name; -
provide the argument
--region
on the command line.
-
provide the argument
-
provide the argument
-
Migration job resource - The migration job 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.
- REQUIRED FLAGS
-
-
Connection profile resource - ID of the destination connection profile,
representing the destination database. This represents a Cloud 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
--destination
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
To set the
region
attribute:-
provide the argument
--destination
on the command line with a fully specified name; -
provide the argument
--region
on the command line.
This must be specified.
--destination
=DESTINATION
-
ID of the connection_profile or fully qualified identifier for the
connection_profile.
To set the
connection_profile
attribute:-
provide the argument
--destination
on the command line.
-
provide the argument
-
provide the argument
-
Connection profile resource - ID of the source connection profile, representing
the source database. This represents a Cloud 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
--source
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
To set the
region
attribute:-
provide the argument
--source
on the command line with a fully specified name; -
provide the argument
--region
on the command line.
This must be specified.
--source
=SOURCE
-
ID of the connection_profile or fully qualified identifier for the
connection_profile.
To set the
connection_profile
attribute:-
provide the argument
--source
on the command line.
-
provide the argument
-
provide the argument
--type
=TYPE
-
Type of the migration job.
TYPE
must be one of:ONE_TIME
,CONTINUOUS
.
-
Connection profile resource - ID of the destination connection profile,
representing the destination database. This represents a Cloud resource. (NOTE)
Some attributes are not given arguments in this group but can be set in other
ways.
- OPTIONAL FLAGS
-
--no-async
- Waits for the operation in progress to complete before returning.
--display-name
=DISPLAY_NAME
- A user-friendly name for the migration job. The display name can include letters, numbers, spaces, and hyphens, and must start with a letter.
--dump-path
=DUMP_PATH
-
Path to the dump file in Google Cloud Storage, in the format:
gs://[BUCKET_NAME]/[OBJECT_NAME]
. --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. -
The connectivity method used by the migration job. If a connectivity method
isn't specified, then it isn't added to the migration job.
At most one of these can be specified:
--peer-vpc
=PEER_VPC
- Name of the VPC network to peer with the Cloud SQL private network.
--static-ip
- Use the default IP allowlist method. This method creates a public IP that will be used with the destination Cloud SQL database. The method works by configuring the source database server to accept connections from the outgoing IP of the Cloud SQL instance.
-
Parameters for the reverse-SSH tunnel connectivity method.
--vm-ip
=VM_IP
-
Bastion Virtual Machine IP.
This flag argument must be specified if any of the other arguments in this group are specified.
--vm-port
=VM_PORT
-
Forwarding port for the SSH tunnel.
This flag argument must be specified if any of the other arguments in this group are specified.
--vpc
=VPC
-
Name of the VPC network where the VM is hosted.
This flag argument must be specified if any of the other arguments in this group are specified.
--vm
=VM
- Name of VM that will host the SSH tunnel bastion.
- 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. - 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:
gcloud database-migration migration-jobs 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-02-06 UTC.