Gcp/datamigration
@swamp/gcp/datamigrationv2026.05.20.1
01README
Google Cloud datamigration infrastructure models
02Release Notes
- Updated: migrationjobs
03Models
@swamp/gcp/datamigration/connectionprofilesv2026.05.19.2connectionprofiles.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| alloydb? | object | Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. |
| cloudsql? | object | Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. |
| displayName? | string | The connection profile display name. |
| error? | object | The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). |
| labels? | record | The resource labels for connection profile 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" }`. |
| mysql? | object | Specifies connection parameters required specifically for MySQL databases. |
| name? | string | The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. |
| oracle? | object | Specifies connection parameters required specifically for Oracle databases. |
| postgresql? | object | Specifies connection parameters required specifically for PostgreSQL databases. |
| provider? | enum | The database provider. |
| role? | enum | Optional. The connection profile role. |
| sqlserver? | object | Specifies connection parameters required specifically for SQL Server databases. |
| state? | enum | The current connection profile state (e.g. DRAFT, READY, or FAILED). |
| connectionProfileId? | string | Required. The connection profile identifier. |
| requestId? | string | Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
| skipValidation? | string | Optional. Create the connection profile without validating it. The default is false. Only supported for Oracle connection profiles. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a connectionProfiles
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a connectionProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the connectionProfiles |
fn update(waitForReady?: boolean)
Update connectionProfiles attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the connectionProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the connectionProfiles |
fn sync()
Sync connectionProfiles state from GCP
Resources
state(infinite)— A connection profile definition.
@swamp/gcp/datamigration/conversionworkspacesv2026.05.19.2conversionworkspaces.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| destination? | object | The type and version of a source or destination database. |
| destinationProvider? | enum | Optional. The provider for the destination database. |
| displayName? | string | Optional. The display name for the workspace. |
| globalSettings? | record | Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true |
| name? | string | Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. |
| source? | object | The type and version of a source or destination database. |
| sourceProvider? | enum | Optional. The provider for the source database. |
| conversionWorkspaceId? | string | Required. The ID of the conversion workspace to create. |
| requestId? | string | Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a conversionWorkspaces
fn get(identifier: string)
Get a conversionWorkspaces
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversionWorkspaces |
fn update()
Update conversionWorkspaces attributes
fn delete(identifier: string)
Delete the conversionWorkspaces
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversionWorkspaces |
fn sync()
Sync conversionWorkspaces state from GCP
fn apply(autoCommit?: any, connectionProfile?: any, dryRun?: any, filter?: any)
apply
| Argument | Type | Description |
|---|---|---|
| autoCommit? | any | |
| connectionProfile? | any | |
| dryRun? | any | |
| filter? | any |
fn commit(commitName?: any)
commit
| Argument | Type | Description |
|---|---|---|
| commitName? | any |
fn convert(autoCommit?: any, convertFullPath?: any, filter?: any)
convert
| Argument | Type | Description |
|---|---|---|
| autoCommit? | any | |
| convertFullPath? | any | |
| filter? | any |
fn describe_conversion_workspace_revisions()
describe conversion workspace revisions
fn describe_database_entities()
describe database entities
fn rollback()
rollback
fn search_background_jobs()
search background jobs
fn seed(autoCommit?: any, destinationConnectionProfile?: any, sourceConnectionProfile?: any)
seed
| Argument | Type | Description |
|---|---|---|
| autoCommit? | any | |
| destinationConnectionProfile? | any | |
| sourceConnectionProfile? | any |
Resources
state(infinite)— The main conversion workspace resource entity.
@swamp/gcp/datamigration/conversionworkspaces-mappingrulesv2026.05.19.2conversionworkspaces_mappingrules.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| conditionalColumnSetValue? | object | Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated. The rule filter field can refer to one or more entities. The rule scope can be one of: Column. |
| convertRowidColumn? | object | Options to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property. The rule filter field can refer to one or more entities. The rule scope can be one of: Table. This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined. |
| displayName? | string | Optional. A human readable name |
| entityMove? | object | Options to configure rule type EntityMove. The rule is used to move an entity to a new schema. The rule filter field can refer to one or more entities. The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT |
| filter? | object | A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields. |
| filterTableColumns? | object | Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table. The rule filter field can refer to one entity. The rule scope can be: Table Only one of the two lists can be specified for the rule. |
| multiColumnDataTypeChange? | object | Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once. The rule filter field can refer to one or more entities. The rule scope can be one of:Column. This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which |
| multiEntityRename? | object | Options to configure rule type MultiEntityRename. The rule is used to rename multiple entities. The rule filter field can refer to one or more entities. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT |
| name? | string | Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}. |
| ruleOrder? | string | Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden. |
| ruleScope? | enum | Required. The rule scope |
| setTablePrimaryKey? | object | Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. |
| singleColumnChange? | object | Options to configure rule type SingleColumnChange. The rule is used to change the properties of a column. The rule filter field can refer to one entity. The rule scope can be one of: Column. When using this rule, if a field is not specified than the destination column's configuration will be the same as the one in the source column.. |
| singleEntityRename? | object | Options to configure rule type SingleEntityRename. The rule is used to rename an entity. The rule filter field can refer to only one entity. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym |
| singlePackageChange? | object | Options to configure rule type SinglePackageChange. The rule is used to alter the sql code for a package entities. The rule filter field can refer to one entity. The rule scope can be: Package |
| sourceSqlChange? | object | Options to configure rule type SourceSqlChange. The rule is used to alter the sql code for database entities. The rule filter field can refer to one entity. The rule scope can be: StoredProcedure, Function, Trigger, View |
| state? | enum | Optional. The mapping rule state |
| mappingRuleId? | string | Required. The ID of the rule to create. |
| requestId? | string | Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a mappingRules
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a mappingRules
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the mappingRules |
fn delete(identifier: string)
Delete the mappingRules
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the mappingRules |
fn sync()
Sync mappingRules state from GCP
fn import(autoCommit?: any, rulesFiles?: any, rulesFormat?: any)
import
| Argument | Type | Description |
|---|---|---|
| autoCommit? | any | |
| rulesFiles? | any | |
| rulesFormat? | any |
Resources
state(infinite)— Definition of a transformation that is to be applied to a group of entities i...
@swamp/gcp/datamigration/locationsv2026.05.19.2locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync()
Sync locations state from GCP
fn fetch_static_ips()
fetch static ips
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/datamigration/migrationjobsv2026.05.20.1migrationjobs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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/[R |
| conversionWorkspace? | object | A conversion workspace's version. |
| destination? | string | Required. The resource name (URI) of the destination connection profile. |
| destinationDatabase? | object | A message defining the database engine and provider. |
| displayName? | string | The migration job display name. |
| dumpFlags? | object | Dump flags definition. |
| 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? | enum | Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only. |
| error? | object | The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 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? | record | 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? | string | The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. |
| objectsConfig? | object | Configuration for the objects to be migrated. |
| oracleToPostgresConfig? | object | Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations. |
| originalMigrationName? | string | Optional. A failback replication pointer to the resource name (URI) of the original migration job. |
| performanceConfig? | object | Performance configuration definition. |
| postgresHomogeneousConfig? | object | Configuration for PostgreSQL to PostgreSQL migrations. |
| postgresToSqlserverConfig? | object | Configuration for heterogeneous failback migrations from **PostgreSQL to SQL Server**. |
| reverseSshConnectivity? | object | The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. |
| source? | string | Required. The resource name (URI) of the source connection profile. |
| sourceDatabase? | object | A message defining the database engine and provider. |
| sqlserverHomogeneousMigrationJobConfig? | object | Configuration for homogeneous migration to Cloud SQL for SQL Server. |
| sqlserverToPostgresConfig? | object | Configuration for heterogeneous **SQL Server to Cloud SQL for PostgreSQL** migrations. |
| state? | enum | The current migration job state. |
| staticIpConnectivity? | object | The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. |
| type? | enum | Required. The migration job type. |
| vpcPeeringConnectivity? | object | The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. |
| migrationJobId? | string | Required. The ID of the instance to create. |
| requestId? | string | Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a migrationJobs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a migrationJobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the migrationJobs |
fn update(waitForReady?: boolean)
Update migrationJobs attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the migrationJobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the migrationJobs |
fn sync()
Sync migrationJobs state from GCP
fn demote_destination()
demote destination
fn fetch_source_objects()
fetch source objects
fn generate_ssh_script(vm?: any, vmCreationConfig?: any, vmPort?: any, vmSelectionConfig?: any)
generate ssh script
| Argument | Type | Description |
|---|---|---|
| vm? | any | |
| vmCreationConfig? | any | |
| vmPort? | any | |
| vmSelectionConfig? | any |
fn generate_tcp_proxy_script(vmMachineType?: any, vmName?: any, vmSubnet?: any, vmZone?: any)
generate tcp proxy script
| Argument | Type | Description |
|---|---|---|
| vmMachineType? | any | |
| vmName? | any | |
| vmSubnet? | any | |
| vmZone? | any |
fn promote(objectsFilter?: any)
promote
| Argument | Type | Description |
|---|---|---|
| objectsFilter? | any |
fn restart(objectsFilter?: any, restartFailedObjects?: any, skipValidation?: any)
restart
| Argument | Type | Description |
|---|---|---|
| objectsFilter? | any | |
| restartFailedObjects? | any | |
| skipValidation? | any |
fn resume(skipValidation?: any)
resume
| Argument | Type | Description |
|---|---|---|
| skipValidation? | any |
fn start(objectsFilter?: any, restartFailedObjects?: any, skipValidation?: any)
start
| Argument | Type | Description |
|---|---|---|
| objectsFilter? | any | |
| restartFailedObjects? | any | |
| skipValidation? | any |
fn stop()
stop
fn verify(migrationJob?: any, updateMask?: any)
verify
| Argument | Type | Description |
|---|---|---|
| migrationJob? | any | |
| updateMask? | any |
Resources
state(infinite)— Represents a Database Migration Service migration job object.
@swamp/gcp/datamigration/migrationjobs-objectsv2026.05.19.2migrationjobs_objects.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a objects
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the objects |
fn sync()
Sync objects state from GCP
fn lookup(sourceObjectIdentifier?: any)
lookup
| Argument | Type | Description |
|---|---|---|
| sourceObjectIdentifier? | any |
Resources
state(infinite)— A specific Migration Job Object (e.g. a specifc DB Table)
@swamp/gcp/datamigration/privateconnectionsv2026.05.19.2privateconnections.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| displayName? | string | The private connection display name. |
| error? | object | The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). |
| labels? | record | The resource labels for private connections 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? | string | The name of the resource. |
| pscInterfaceConfig? | object | The PSC Interface configuration is used to create PSC Interface between DMS's internal VPC and the consumer's PSC. |
| vpcPeeringConfig? | object | The VPC peering configuration is used to create VPC peering with the consumer's VPC. |
| privateConnectionId? | string | Required. The private connection identifier. |
| requestId? | string | Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
| skipValidation? | string | Optional. If set to true, will skip validations. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a privateConnections
fn get(identifier: string)
Get a privateConnections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the privateConnections |
fn delete(identifier: string)
Delete the privateConnections
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the privateConnections |
fn sync()
Sync privateConnections state from GCP
Resources
state(infinite)— The PrivateConnection resource is used to establish private connectivity with...
04Previous Versions
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.05.18.2May 18, 2026
2026.05.06.1May 6, 2026
- Updated: migrationjobs
2026.04.23.1Apr 23, 2026
2026.04.04.1Apr 4, 2026
- Updated: connectionprofiles, migrationjobs
2026.04.03.3Apr 3, 2026
- Updated: locations, connectionprofiles, conversionworkspaces, conversionworkspaces_mappingrules, migrationjobs, migrationjobs_objects, privateconnections
2026.04.03.1Apr 3, 2026
- Updated: locations, connectionprofiles, conversionworkspaces, conversionworkspaces_mappingrules, migrationjobs, migrationjobs_objects, privateconnections
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: locations, connectionprofiles, conversionworkspaces, conversionworkspaces_mappingrules, migrationjobs, migrationjobs_objects, privateconnections
05Stats
A
100 / 100
Downloads
0
Archive size
115.5 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels