migration_executions

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

Overview

Name	migration_executions
Type	Resource
Id	google.metastore.migration_executions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. The relative resource name of the migration execution, in the following form: projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}
cloudSqlMigrationConfig	object	Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information specific to migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. (id: CloudSQLMigrationConfig)
createTime	string (google-datetime)	Output only. The time when the migration execution was started.
endTime	string (google-datetime)	Output only. The time when the migration execution finished.
phase	string	Output only. Deprecated: Phase was designed for incoming migrations to Dataproc Metastore, not applicable when migrating away from it. The current phase of the migration execution. (PHASE_UNSPECIFIED, REPLICATION, CUTOVER)
state	string	Output only. The current state of the migration execution. (STATE_UNSPECIFIED, STARTING, RUNNING, CANCELLING, AWAITING_USER_ACTION, SUCCEEDED, FAILED, CANCELLED, DELETING, ROLLED_BACK)
stateMessage	string	Output only. Additional information about the current state of the migration execution.

list

Name	Datatype	Description
name	string	Output only. The relative resource name of the migration execution, in the following form: projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}
cloudSqlMigrationConfig	object	Deprecated: Migrations to Dataproc Metastore are no longer supported. Use BigLake Metastore migration instead. Configuration information specific to migrating from self-managed hive metastore on Google Cloud using Cloud SQL as the backend database to Dataproc Metastore. (id: CloudSQLMigrationConfig)
createTime	string (google-datetime)	Output only. The time when the migration execution was started.
endTime	string (google-datetime)	Output only. The time when the migration execution finished.
phase	string	Output only. Deprecated: Phase was designed for incoming migrations to Dataproc Metastore, not applicable when migrating away from it. The current phase of the migration execution. (PHASE_UNSPECIFIED, REPLICATION, CUTOVER)
state	string	Output only. The current state of the migration execution. (STATE_UNSPECIFIED, STARTING, RUNNING, CANCELLING, AWAITING_USER_ACTION, SUCCEEDED, FAILED, CANCELLED, DELETING, ROLLED_BACK)
stateMessage	string	Output only. Additional information about the current state of the migration execution.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, servicesId, migrationExecutionsId		Gets details of a single migration execution.
list	select	projectsId, locationsId, servicesId	filter, orderBy, pageSize, pageToken	Lists migration executions on a service.
delete	delete	projectsId, locationsId, servicesId, migrationExecutionsId	requestId	Deletes a single migration execution.

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
migrationExecutionsId	string
projectsId	string
servicesId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single migration execution.

SELECT
name,
cloudSqlMigrationConfig,
createTime,
endTime,
phase,
state,
stateMessage
FROM google.metastore.migration_executions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND servicesId = '{{ servicesId }}' -- required
AND migrationExecutionsId = '{{ migrationExecutionsId }}' -- required
;

list

Lists migration executions on a service.

SELECT
name,
cloudSqlMigrationConfig,
createTime,
endTime,
phase,
state,
stateMessage
FROM google.metastore.migration_executions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND servicesId = '{{ servicesId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

DELETE examples

delete

Deletes a single migration execution.

DELETE FROM google.metastore.migration_executions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND servicesId = '{{ servicesId }}' --required
AND migrationExecutionsId = '{{ migrationExecutionsId }}' --required
AND requestId = '{{ requestId }}'
;