migration_jobs

Creates, updates, deletes, gets or lists a migration_jobs resource.

Overview

Name	`migration_jobs`
Type	Resource
Id	`google.datamigration.migration_jobs`

Fields

The following fields are returned by SELECT queries:

get
list

Successful response

Name	Datatype	Description
`name`	`string`	The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
`cmekKeyName`	`string`	The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
`conversionWorkspace`	`object`	The conversion workspace used by the migration. (id: ConversionWorkspaceInfo)
`createTime`	`string (google-datetime)`	Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
`destination`	`string`	Required. The resource name (URI) of the destination connection profile.
`destinationDatabase`	`object`	The database engine type and provider of the destination. (id: DatabaseType)
`displayName`	`string`	The migration job display name.
`dumpFlags`	`object`	The initial dump flags. This field and the "dump_path" field are mutually exclusive. (id: DumpFlags)
`dumpPath`	`string`	The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.
`dumpType`	`string`	Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.
`duration`	`string (google-duration)`	Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
`endTime`	`string (google-datetime)`	Output only. If the migration job is completed, the time when it was completed.
`error`	`object`	Output only. The error details in case of state FAILED. (id: Status)
`filter`	`string`	This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
`labels`	`object`	The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`objectsConfig`	`object`	Optional. The objects that need to be migrated. (id: MigrationJobObjectsConfig)
`oracleToPostgresConfig`	`object`	Configuration for heterogeneous Oracle to Cloud SQL for PostgreSQL and Oracle to AlloyDB for PostgreSQL migrations. (id: OracleToPostgresConfig)
`performanceConfig`	`object`	Optional. Data dump parallelism settings used by the migration. (id: PerformanceConfig)
`phase`	`string`	Output only. The current migration job phase.
`reverseSshConnectivity`	`object`	The details needed to communicate to the source over Reverse SSH tunnel connectivity. (id: ReverseSshConnectivity)
`satisfiesPzi`	`boolean`	Output only. Reserved for future use.
`satisfiesPzs`	`boolean`	Output only. Reserved for future use.
`source`	`string`	Required. The resource name (URI) of the source connection profile.
`sourceDatabase`	`object`	The database engine type and provider of the source. (id: DatabaseType)
`sqlserverHomogeneousMigrationJobConfig`	`object`	Optional. Configuration for SQL Server homogeneous migration. (id: SqlServerHomogeneousMigrationJobConfig)
`sqlserverToPostgresConfig`	`object`	Configuration for heterogeneous SQL Server to Cloud SQL for PostgreSQL migrations. (id: SqlServerToPostgresConfig)
`state`	`string`	The current migration job state.
`staticIpConnectivity`	`object`	static ip connectivity data (default, no additional details needed). (id: StaticIpConnectivity)
`type`	`string`	Required. The migration job type.
`updateTime`	`string (google-datetime)`	Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
`vpcPeeringConnectivity`	`object`	The details of the VPC network that the source database is located in. (id: VpcPeeringConnectivity)

Successful response

Name	Datatype	Description
`name`	`string`	The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
`cmekKeyName`	`string`	The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
`conversionWorkspace`	`object`	The conversion workspace used by the migration. (id: ConversionWorkspaceInfo)
`createTime`	`string (google-datetime)`	Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
`destination`	`string`	Required. The resource name (URI) of the destination connection profile.
`destinationDatabase`	`object`	The database engine type and provider of the destination. (id: DatabaseType)
`displayName`	`string`	The migration job display name.
`dumpFlags`	`object`	The initial dump flags. This field and the "dump_path" field are mutually exclusive. (id: DumpFlags)
`dumpPath`	`string`	The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.
`dumpType`	`string`	Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.
`duration`	`string (google-duration)`	Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
`endTime`	`string (google-datetime)`	Output only. If the migration job is completed, the time when it was completed.
`error`	`object`	Output only. The error details in case of state FAILED. (id: Status)
`filter`	`string`	This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
`labels`	`object`	The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`objectsConfig`	`object`	Optional. The objects that need to be migrated. (id: MigrationJobObjectsConfig)
`oracleToPostgresConfig`	`object`	Configuration for heterogeneous Oracle to Cloud SQL for PostgreSQL and Oracle to AlloyDB for PostgreSQL migrations. (id: OracleToPostgresConfig)
`performanceConfig`	`object`	Optional. Data dump parallelism settings used by the migration. (id: PerformanceConfig)
`phase`	`string`	Output only. The current migration job phase.
`reverseSshConnectivity`	`object`	The details needed to communicate to the source over Reverse SSH tunnel connectivity. (id: ReverseSshConnectivity)
`satisfiesPzi`	`boolean`	Output only. Reserved for future use.
`satisfiesPzs`	`boolean`	Output only. Reserved for future use.
`source`	`string`	Required. The resource name (URI) of the source connection profile.
`sourceDatabase`	`object`	The database engine type and provider of the source. (id: DatabaseType)
`sqlserverHomogeneousMigrationJobConfig`	`object`	Optional. Configuration for SQL Server homogeneous migration. (id: SqlServerHomogeneousMigrationJobConfig)
`sqlserverToPostgresConfig`	`object`	Configuration for heterogeneous SQL Server to Cloud SQL for PostgreSQL migrations. (id: SqlServerToPostgresConfig)
`state`	`string`	The current migration job state.
`staticIpConnectivity`	`object`	static ip connectivity data (default, no additional details needed). (id: StaticIpConnectivity)
`type`	`string`	Required. The migration job type.
`updateTime`	`string (google-datetime)`	Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
`vpcPeeringConnectivity`	`object`	The details of the VPC network that the source database is located in. (id: VpcPeeringConnectivity)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `migrationJobsId`		Gets details of a single migration job.
`list`	`select`	`projectsId`, `locationsId`	`pageSize`, `pageToken`, `filter`, `orderBy`	Lists migration jobs in a given project and location.
`create`	`insert`	`projectsId`, `locationsId`	`migrationJobId`, `requestId`	Creates a new migration job in a given project and location.
`patch`	`update`	`projectsId`, `locationsId`, `migrationJobsId`	`updateMask`, `requestId`	Updates the parameters of a single migration job.
`delete`	`delete`	`projectsId`, `locationsId`, `migrationJobsId`	`requestId`, `force`	Deletes a single migration job.
`start`	`exec`	`projectsId`, `locationsId`, `migrationJobsId`		Start an already created migration job.
`stop`	`exec`	`projectsId`, `locationsId`, `migrationJobsId`		Stops a running migration job.
`resume`	`exec`	`projectsId`, `locationsId`, `migrationJobsId`		Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
`promote`	`exec`	`projectsId`, `locationsId`, `migrationJobsId`		Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.
`demote_destination`	`exec`	`projectsId`, `locationsId`, `migrationJobsId`		Demotes the destination database to become a read replica of the source. This is applicable for the following migrations: 1. MySQL to Cloud SQL for MySQL 2. PostgreSQL to Cloud SQL for PostgreSQL 3. PostgreSQL to AlloyDB for PostgreSQL.
`verify`	`exec`	`projectsId`, `locationsId`, `migrationJobsId`		Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.
`restart`	`exec`	`projectsId`, `locationsId`, `migrationJobsId`		Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.
`generate_ssh_script`	`exec`	`projectsId`, `locationsId`, `migrationJobsId`		Generate a SSH configuration script to configure the reverse SSH connectivity.
`generate_tcp_proxy_script`	`exec`	`projectsId`, `locationsId`, `migrationJobsId`		Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.
`fetch_source_objects`	`exec`	`projectsId`, `locationsId`, `migrationJobsId`		Retrieves objects from the source database that can be selected for data migration. This is applicable for the following migrations: 1. PostgreSQL to Cloud SQL for PostgreSQL 2. PostgreSQL to AlloyDB for PostgreSQL.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`locationsId`	`string`
`migrationJobsId`	`string`
`projectsId`	`string`
`filter`	`string`
`force`	`boolean`
`migrationJobId`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`requestId`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Gets details of a single migration job.

SELECT
name,
cmekKeyName,
conversionWorkspace,
createTime,
destination,
destinationDatabase,
displayName,
dumpFlags,
dumpPath,
dumpType,
duration,
endTime,
error,
filter,
labels,
objectsConfig,
oracleToPostgresConfig,
performanceConfig,
phase,
reverseSshConnectivity,
satisfiesPzi,
satisfiesPzs,
source,
sourceDatabase,
sqlserverHomogeneousMigrationJobConfig,
sqlserverToPostgresConfig,
state,
staticIpConnectivity,
type,
updateTime,
vpcPeeringConnectivity
FROM google.datamigration.migration_jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND migrationJobsId = '{{ migrationJobsId }}' -- required;

Lists migration jobs in a given project and location.

SELECT
name,
cmekKeyName,
conversionWorkspace,
createTime,
destination,
destinationDatabase,
displayName,
dumpFlags,
dumpPath,
dumpType,
duration,
endTime,
error,
filter,
labels,
objectsConfig,
oracleToPostgresConfig,
performanceConfig,
phase,
reverseSshConnectivity,
satisfiesPzi,
satisfiesPzs,
source,
sourceDatabase,
sqlserverHomogeneousMigrationJobConfig,
sqlserverToPostgresConfig,
state,
staticIpConnectivity,
type,
updateTime,
vpcPeeringConnectivity
FROM google.datamigration.migration_jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

`INSERT` examples

create
Manifest

Creates a new migration job in a given project and location.

INSERT INTO google.datamigration.migration_jobs (
data__name,
data__labels,
data__displayName,
data__state,
data__type,
data__dumpPath,
data__dumpFlags,
data__source,
data__destination,
data__reverseSshConnectivity,
data__vpcPeeringConnectivity,
data__staticIpConnectivity,
data__sourceDatabase,
data__destinationDatabase,
data__conversionWorkspace,
data__filter,
data__cmekKeyName,
data__performanceConfig,
data__sqlserverHomogeneousMigrationJobConfig,
data__dumpType,
data__oracleToPostgresConfig,
data__sqlserverToPostgresConfig,
data__objectsConfig,
projectsId,
locationsId,
migrationJobId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ displayName }}',
'{{ state }}',
'{{ type }}',
'{{ dumpPath }}',
'{{ dumpFlags }}',
'{{ source }}',
'{{ destination }}',
'{{ reverseSshConnectivity }}',
'{{ vpcPeeringConnectivity }}',
'{{ staticIpConnectivity }}',
'{{ sourceDatabase }}',
'{{ destinationDatabase }}',
'{{ conversionWorkspace }}',
'{{ filter }}',
'{{ cmekKeyName }}',
'{{ performanceConfig }}',
'{{ sqlserverHomogeneousMigrationJobConfig }}',
'{{ dumpType }}',
'{{ oracleToPostgresConfig }}',
'{{ sqlserverToPostgresConfig }}',
'{{ objectsConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ migrationJobId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: migration_jobs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the migration_jobs resource.
    - name: locationsId
      value: string
      description: Required parameter for the migration_jobs resource.
    - name: name
      value: string
      description: >
        The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
        
    - name: labels
      value: object
      description: >
        The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
        
    - name: displayName
      value: string
      description: >
        The migration job display name.
        
    - name: state
      value: string
      description: >
        The current migration job state.
        
      valid_values: ['STATE_UNSPECIFIED', 'MAINTENANCE', 'DRAFT', 'CREATING', 'NOT_STARTED', 'RUNNING', 'FAILED', 'COMPLETED', 'DELETING', 'STOPPING', 'STOPPED', 'DELETED', 'UPDATING', 'STARTING', 'RESTARTING', 'RESUMING']
    - name: type
      value: string
      description: >
        Required. The migration job type.
        
      valid_values: ['TYPE_UNSPECIFIED', 'ONE_TIME', 'CONTINUOUS']
    - name: dumpPath
      value: string
      description: >
        The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.
        
    - name: dumpFlags
      value: object
      description: >
        The initial dump flags. This field and the "dump_path" field are mutually exclusive.
        
    - name: source
      value: string
      description: >
        Required. The resource name (URI) of the source connection profile.
        
    - name: destination
      value: string
      description: >
        Required. The resource name (URI) of the destination connection profile.
        
    - name: reverseSshConnectivity
      value: object
      description: >
        The details needed to communicate to the source over Reverse SSH tunnel connectivity.
        
    - name: vpcPeeringConnectivity
      value: object
      description: >
        The details of the VPC network that the source database is located in.
        
    - name: staticIpConnectivity
      value: object
      description: >
        static ip connectivity data (default, no additional details needed).
        
    - name: sourceDatabase
      value: object
      description: >
        The database engine type and provider of the source.
        
    - name: destinationDatabase
      value: object
      description: >
        The database engine type and provider of the destination.
        
    - name: conversionWorkspace
      value: object
      description: >
        The conversion workspace used by the migration.
        
    - name: filter
      value: string
      description: >
        This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
        
    - name: cmekKeyName
      value: string
      description: >
        The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
        
    - name: performanceConfig
      value: object
      description: >
        Optional. Data dump parallelism settings used by the migration.
        
    - name: sqlserverHomogeneousMigrationJobConfig
      value: object
      description: >
        Optional. Configuration for SQL Server homogeneous migration.
        
    - name: dumpType
      value: string
      description: >
        Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.
        
      valid_values: ['DUMP_TYPE_UNSPECIFIED', 'LOGICAL', 'PHYSICAL']
    - name: oracleToPostgresConfig
      value: object
      description: >
        Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations.
        
    - name: sqlserverToPostgresConfig
      value: object
      description: >
        Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations.
        
    - name: objectsConfig
      value: object
      description: >
        Optional. The objects that need to be migrated.
        
    - name: migrationJobId
      value: string
    - name: requestId
      value: string

`UPDATE` examples

patch

Updates the parameters of a single migration job.

UPDATE google.datamigration.migration_jobs
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__displayName = '{{ displayName }}',
data__state = '{{ state }}',
data__type = '{{ type }}',
data__dumpPath = '{{ dumpPath }}',
data__dumpFlags = '{{ dumpFlags }}',
data__source = '{{ source }}',
data__destination = '{{ destination }}',
data__reverseSshConnectivity = '{{ reverseSshConnectivity }}',
data__vpcPeeringConnectivity = '{{ vpcPeeringConnectivity }}',
data__staticIpConnectivity = '{{ staticIpConnectivity }}',
data__sourceDatabase = '{{ sourceDatabase }}',
data__destinationDatabase = '{{ destinationDatabase }}',
data__conversionWorkspace = '{{ conversionWorkspace }}',
data__filter = '{{ filter }}',
data__cmekKeyName = '{{ cmekKeyName }}',
data__performanceConfig = '{{ performanceConfig }}',
data__sqlserverHomogeneousMigrationJobConfig = '{{ sqlserverHomogeneousMigrationJobConfig }}',
data__dumpType = '{{ dumpType }}',
data__oracleToPostgresConfig = '{{ oracleToPostgresConfig }}',
data__sqlserverToPostgresConfig = '{{ sqlserverToPostgresConfig }}',
data__objectsConfig = '{{ objectsConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND migrationJobsId = '{{ migrationJobsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

delete

Deletes a single migration job.

DELETE FROM google.datamigration.migration_jobs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND migrationJobsId = '{{ migrationJobsId }}' --required
AND requestId = '{{ requestId }}'
AND force = '{{ force }}';

Lifecycle Methods

Start an already created migration job.

EXEC google.datamigration.migration_jobs.start 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@migrationJobsId='{{ migrationJobsId }}' --required 
@@json=
'{
"skipValidation": {{ skipValidation }}
}';

Stops a running migration job.

EXEC google.datamigration.migration_jobs.stop 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@migrationJobsId='{{ migrationJobsId }}' --required;

Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).

EXEC google.datamigration.migration_jobs.resume 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@migrationJobsId='{{ migrationJobsId }}' --required 
@@json=
'{
"skipValidation": {{ skipValidation }}
}';

Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.

EXEC google.datamigration.migration_jobs.promote 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@migrationJobsId='{{ migrationJobsId }}' --required 
@@json=
'{
"objectsFilter": "{{ objectsFilter }}"
}';

Demotes the destination database to become a read replica of the source. This is applicable for the following migrations: 1. MySQL to Cloud SQL for MySQL 2. PostgreSQL to Cloud SQL for PostgreSQL 3. PostgreSQL to AlloyDB for PostgreSQL.

EXEC google.datamigration.migration_jobs.demote_destination 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@migrationJobsId='{{ migrationJobsId }}' --required;

Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

EXEC google.datamigration.migration_jobs.verify 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@migrationJobsId='{{ migrationJobsId }}' --required 
@@json=
'{
"updateMask": "{{ updateMask }}", 
"migrationJob": "{{ migrationJob }}"
}';

Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.

EXEC google.datamigration.migration_jobs.restart 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@migrationJobsId='{{ migrationJobsId }}' --required 
@@json=
'{
"skipValidation": {{ skipValidation }}, 
"objectsFilter": "{{ objectsFilter }}", 
"restartFailedObjects": {{ restartFailedObjects }}
}';

Generate a SSH configuration script to configure the reverse SSH connectivity.

EXEC google.datamigration.migration_jobs.generate_ssh_script 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@migrationJobsId='{{ migrationJobsId }}' --required 
@@json=
'{
"vm": "{{ vm }}", 
"vmCreationConfig": "{{ vmCreationConfig }}", 
"vmSelectionConfig": "{{ vmSelectionConfig }}", 
"vmPort": {{ vmPort }}
}';

Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.

EXEC google.datamigration.migration_jobs.generate_tcp_proxy_script 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@migrationJobsId='{{ migrationJobsId }}' --required 
@@json=
'{
"vmName": "{{ vmName }}", 
"vmMachineType": "{{ vmMachineType }}", 
"vmZone": "{{ vmZone }}", 
"vmSubnet": "{{ vmSubnet }}"
}';

Retrieves objects from the source database that can be selected for data migration. This is applicable for the following migrations: 1. PostgreSQL to Cloud SQL for PostgreSQL 2. PostgreSQL to AlloyDB for PostgreSQL.

EXEC google.datamigration.migration_jobs.fetch_source_objects 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@migrationJobsId='{{ migrationJobsId }}' --required;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​