conversion_workspaces

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

Overview

Name	conversion_workspaces
Type	Resource
Id	google.datamigration.conversion_workspaces

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
createTime	string (google-datetime)	Output only. The timestamp when the workspace resource was created.
destination	object	Required. The destination engine details. (id: DatabaseEngineInfo)
destinationProvider	string	Optional. The provider for the destination database. (DATABASE_PROVIDER_UNSPECIFIED, CLOUDSQL, RDS, AURORA, ALLOYDB, AZURE_DATABASE)
displayName	string	Optional. The display name for the workspace.
globalSettings	object	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
hasUncommittedChanges	boolean	Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed).
latestCommitId	string	Output only. The latest commit ID.
latestCommitTime	string (google-datetime)	Output only. The timestamp when the workspace was committed.
source	object	Required. The source engine details. (id: DatabaseEngineInfo)
sourceProvider	string	Optional. The provider for the source database. (DATABASE_PROVIDER_UNSPECIFIED, CLOUDSQL, RDS, AURORA, ALLOYDB, AZURE_DATABASE)
updateTime	string (google-datetime)	Output only. The timestamp when the workspace resource was last updated.

list

Name	Datatype	Description
name	string	Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
createTime	string (google-datetime)	Output only. The timestamp when the workspace resource was created.
destination	object	Required. The destination engine details. (id: DatabaseEngineInfo)
destinationProvider	string	Optional. The provider for the destination database. (DATABASE_PROVIDER_UNSPECIFIED, CLOUDSQL, RDS, AURORA, ALLOYDB, AZURE_DATABASE)
displayName	string	Optional. The display name for the workspace.
globalSettings	object	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
hasUncommittedChanges	boolean	Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed).
latestCommitId	string	Output only. The latest commit ID.
latestCommitTime	string (google-datetime)	Output only. The timestamp when the workspace was committed.
source	object	Required. The source engine details. (id: DatabaseEngineInfo)
sourceProvider	string	Optional. The provider for the source database. (DATABASE_PROVIDER_UNSPECIFIED, CLOUDSQL, RDS, AURORA, ALLOYDB, AZURE_DATABASE)
updateTime	string (google-datetime)	Output only. The timestamp when the workspace resource was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, conversionWorkspacesId		Gets details of a single conversion workspace.
list	select	projectsId, locationsId	filter, pageSize, pageToken	Lists conversion workspaces in a given project and location.
create	insert	projectsId, locationsId	conversionWorkspaceId, requestId	Creates a new conversion workspace in a given project and location.
patch	update	projectsId, locationsId, conversionWorkspacesId	requestId, updateMask	Updates the parameters of a single conversion workspace.
delete	delete	projectsId, locationsId, conversionWorkspacesId	force, requestId	Deletes a single conversion workspace.
apply	exec	projectsId, locationsId, conversionWorkspacesId		Applies draft tree onto a specific destination database.
commit	exec	projectsId, locationsId, conversionWorkspacesId		Marks all the data in the conversion workspace as committed.
convert	exec	projectsId, locationsId, conversionWorkspacesId		Creates a draft tree schema for the destination database.
describe_conversion_workspace_revisions	exec	projectsId, locationsId, conversionWorkspacesId	commitId	Retrieves a list of committed revisions of a specific conversion workspace.
describe_database_entities	exec	projectsId, locationsId, conversionWorkspacesId	commitId, filter, pageSize, pageToken, tree, uncommitted, view	Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.
rollback	exec	projectsId, locationsId, conversionWorkspacesId		Rolls back a conversion workspace to the last committed snapshot.
search_background_jobs	exec	projectsId, locationsId, conversionWorkspacesId	completedUntilTime, maxSize, returnMostRecentPerJobType	Searches/lists the background jobs for a specific conversion workspace. The background jobs are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are a way to expose the data plane jobs log.
seed	exec	projectsId, locationsId, conversionWorkspacesId		Imports a snapshot of the source database into the conversion workspace.

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
conversionWorkspacesId	string
locationsId	string
projectsId	string
commitId	string
completedUntilTime	string (google-datetime)
conversionWorkspaceId	string
filter	string
force	boolean
maxSize	integer (int32)
pageSize	integer (int32)
pageToken	string
requestId	string
returnMostRecentPerJobType	boolean
tree	string
uncommitted	boolean
updateMask	string (google-fieldmask)
view	string

SELECT examples

get

Gets details of a single conversion workspace.

SELECT
name,
createTime,
destination,
destinationProvider,
displayName,
globalSettings,
hasUncommittedChanges,
latestCommitId,
latestCommitTime,
source,
sourceProvider,
updateTime
FROM google.datamigration.conversion_workspaces
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND conversionWorkspacesId = '{{ conversionWorkspacesId }}' -- required
;

list

Lists conversion workspaces in a given project and location.

SELECT
name,
createTime,
destination,
destinationProvider,
displayName,
globalSettings,
hasUncommittedChanges,
latestCommitId,
latestCommitTime,
source,
sourceProvider,
updateTime
FROM google.datamigration.conversion_workspaces
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a new conversion workspace in a given project and location.

INSERT INTO google.datamigration.conversion_workspaces (
data__destination,
data__destinationProvider,
data__displayName,
data__globalSettings,
data__name,
data__source,
data__sourceProvider,
projectsId,
locationsId,
conversionWorkspaceId,
requestId
)
SELECT 
'{{ destination }}',
'{{ destinationProvider }}',
'{{ displayName }}',
'{{ globalSettings }}',
'{{ name }}',
'{{ source }}',
'{{ sourceProvider }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ conversionWorkspaceId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: conversion_workspaces
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the conversion_workspaces resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the conversion_workspaces resource.
  - name: destination
    description: |
      Required. The destination engine details.
    value:
      engine: "{{ engine }}"
      version: "{{ version }}"
  - name: destinationProvider
    value: "{{ destinationProvider }}"
    description: |
      Optional. The provider for the destination database.
    valid_values: ['DATABASE_PROVIDER_UNSPECIFIED', 'CLOUDSQL', 'RDS', 'AURORA', 'ALLOYDB', 'AZURE_DATABASE']
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Optional. The display name for the workspace.
  - name: globalSettings
    value: "{{ globalSettings }}"
    description: |
      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: name
    value: "{{ name }}"
    description: |
      Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
  - name: source
    description: |
      Required. The source engine details.
    value:
      engine: "{{ engine }}"
      version: "{{ version }}"
  - name: sourceProvider
    value: "{{ sourceProvider }}"
    description: |
      Optional. The provider for the source database.
    valid_values: ['DATABASE_PROVIDER_UNSPECIFIED', 'CLOUDSQL', 'RDS', 'AURORA', 'ALLOYDB', 'AZURE_DATABASE']
  - name: conversionWorkspaceId
    value: "{{ conversionWorkspaceId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the parameters of a single conversion workspace.

UPDATE google.datamigration.conversion_workspaces
SET 
data__destination = '{{ destination }}',
data__destinationProvider = '{{ destinationProvider }}',
data__displayName = '{{ displayName }}',
data__globalSettings = '{{ globalSettings }}',
data__name = '{{ name }}',
data__source = '{{ source }}',
data__sourceProvider = '{{ sourceProvider }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND conversionWorkspacesId = '{{ conversionWorkspacesId }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single conversion workspace.

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

Lifecycle Methods

apply

Applies draft tree onto a specific destination database.

EXEC google.datamigration.conversion_workspaces.apply 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@conversionWorkspacesId='{{ conversionWorkspacesId }}' --required 
@@json=
'{
"autoCommit": {{ autoCommit }}, 
"connectionProfile": "{{ connectionProfile }}", 
"dryRun": {{ dryRun }}, 
"filter": "{{ filter }}"
}'
;

commit

Marks all the data in the conversion workspace as committed.

EXEC google.datamigration.conversion_workspaces.commit 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@conversionWorkspacesId='{{ conversionWorkspacesId }}' --required 
@@json=
'{
"commitName": "{{ commitName }}"
}'
;

convert

Creates a draft tree schema for the destination database.

EXEC google.datamigration.conversion_workspaces.convert 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@conversionWorkspacesId='{{ conversionWorkspacesId }}' --required 
@@json=
'{
"autoCommit": {{ autoCommit }}, 
"convertFullPath": {{ convertFullPath }}, 
"filter": "{{ filter }}"
}'
;

describe_conversion_workspace_revisions

Retrieves a list of committed revisions of a specific conversion workspace.

EXEC google.datamigration.conversion_workspaces.describe_conversion_workspace_revisions 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@conversionWorkspacesId='{{ conversionWorkspacesId }}' --required, 
@commitId='{{ commitId }}'
;

describe_database_entities

Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.

EXEC google.datamigration.conversion_workspaces.describe_database_entities 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@conversionWorkspacesId='{{ conversionWorkspacesId }}' --required, 
@commitId='{{ commitId }}', 
@filter='{{ filter }}', 
@pageSize='{{ pageSize }}', 
@pageToken='{{ pageToken }}', 
@tree='{{ tree }}', 
@uncommitted={{ uncommitted }}, 
@view='{{ view }}'
;

rollback

Rolls back a conversion workspace to the last committed snapshot.

EXEC google.datamigration.conversion_workspaces.rollback 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@conversionWorkspacesId='{{ conversionWorkspacesId }}' --required
;

search_background_jobs

Searches/lists the background jobs for a specific conversion workspace. The background jobs are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are a way to expose the data plane jobs log.

EXEC google.datamigration.conversion_workspaces.search_background_jobs 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@conversionWorkspacesId='{{ conversionWorkspacesId }}' --required, 
@completedUntilTime='{{ completedUntilTime }}', 
@maxSize='{{ maxSize }}', 
@returnMostRecentPerJobType={{ returnMostRecentPerJobType }}
;

seed

Imports a snapshot of the source database into the conversion workspace.

EXEC google.datamigration.conversion_workspaces.seed 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@conversionWorkspacesId='{{ conversionWorkspacesId }}' --required 
@@json=
'{
"autoCommit": {{ autoCommit }}, 
"destinationConnectionProfile": "{{ destinationConnectionProfile }}", 
"sourceConnectionProfile": "{{ sourceConnectionProfile }}"
}'
;