Index
MigrationService
(interface)AzureSynapseDialect
(message)BigQueryDialect
(message)CreateMigrationWorkflowRequest
(message)DeleteMigrationWorkflowRequest
(message)Dialect
(message)ErrorDetail
(message)ErrorLocation
(message)GetMigrationSubtaskRequest
(message)GetMigrationWorkflowRequest
(message)HiveQLDialect
(message)ListMigrationSubtasksRequest
(message)ListMigrationSubtasksResponse
(message)ListMigrationWorkflowsRequest
(message)ListMigrationWorkflowsResponse
(message)MigrationSubtask
(message)MigrationSubtask.State
(enum)MigrationTask
(message)MigrationTask.State
(enum)MigrationWorkflow
(message)MigrationWorkflow.State
(enum)MySQLDialect
(message)NameMappingKey
(message)NameMappingKey.Type
(enum)NameMappingValue
(message)NetezzaDialect
(message)ObjectNameMapping
(message)ObjectNameMappingList
(message)OracleDialect
(message)Point
(message)PostgresqlDialect
(message)PrestoDialect
(message)RedshiftDialect
(message)ResourceErrorDetail
(message)SQLServerDialect
(message)SnowflakeDialect
(message)SourceEnv
(message)SparkSQLDialect
(message)StartMigrationWorkflowRequest
(message)TeradataDialect
(message)TeradataDialect.Mode
(enum)TimeInterval
(message)TimeSeries
(message)TranslationConfigDetails
(message)TypedValue
(message)VerticaDialect
(message)
MigrationService
Service to handle EDW migrations.
CreateMigrationWorkflow |
---|
Creates a migration workflow.
|
DeleteMigrationWorkflow |
---|
Deletes a migration workflow by name.
|
GetMigrationSubtask |
---|
Gets a previously created migration subtask.
|
GetMigrationWorkflow |
---|
Gets a previously created migration workflow.
|
ListMigrationSubtasks |
---|
Lists previously created migration subtasks.
|
ListMigrationWorkflows |
---|
Lists previously created migration workflow.
|
StartMigrationWorkflow |
---|
Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING.
|
SqlTranslationService
Provides other SQL dialects to GoogleSQL translation operations.
TranslateQuery |
---|
Translates input queries from source dialects to GoogleSQL.
|
AzureSynapseDialect
The dialect definition for Azure Synapse.
BigQueryDialect
The dialect definition for BigQuery.
CreateMigrationWorkflowRequest
Request to create a migration workflow resource.
Fields | |
---|---|
parent |
Required. The name of the project to which this migration workflow belongs. Example: |
migration_workflow |
Required. The migration workflow to create. |
DeleteMigrationWorkflowRequest
A request to delete a previously created migration workflow.
Fields | |
---|---|
name |
Required. The unique identifier for the migration workflow. Example: |
Dialect
The possible dialect options for translation.
Fields | |
---|---|
Union field dialect_value . The possible dialect options that this message represents. dialect_value can be only one of the following: |
|
bigquery_dialect |
The BigQuery dialect |
hiveql_dialect |
The HiveQL dialect |
redshift_dialect |
The Redshift dialect |
teradata_dialect |
The Teradata dialect |
oracle_dialect |
The Oracle dialect |
sparksql_dialect |
The SparkSQL dialect |
snowflake_dialect |
The Snowflake dialect |
netezza_dialect |
The Netezza dialect |
azure_synapse_dialect |
The Azure Synapse dialect |
vertica_dialect |
The Vertica dialect |
sql_server_dialect |
The SQL Server dialect |
postgresql_dialect |
The Postgresql dialect |
presto_dialect |
The Presto dialect |
mysql_dialect |
The MySQL dialect |
ErrorDetail
Provides details for errors, e.g. issues that where encountered when processing a subtask.
Fields | |
---|---|
location |
Optional. The exact location within the resource (if applicable). |
error_info |
Required. Describes the cause of the error with structured detail. |
ErrorLocation
Holds information about where the error is located.
Fields | |
---|---|
line |
Optional. If applicable, denotes the line where the error occurred. A zero value means that there is no line information. |
column |
Optional. If applicable, denotes the column where the error occurred. A zero value means that there is no columns information. |
GetMigrationSubtaskRequest
A request to get a previously created migration subtasks.
Fields | |
---|---|
name |
Required. The unique identifier for the migration subtask. Example: |
read_mask |
Optional. The list of fields to be retrieved. |
GetMigrationWorkflowRequest
A request to get a previously created migration workflow.
Fields | |
---|---|
name |
Required. The unique identifier for the migration workflow. Example: |
read_mask |
The list of fields to be retrieved. |
HiveQLDialect
The dialect definition for HiveQL.
ListMigrationSubtasksRequest
A request to list previously created migration subtasks.
Fields | |
---|---|
parent |
Required. The migration task of the subtasks to list. Example: |
read_mask |
Optional. The list of fields to be retrieved. |
page_size |
Optional. The maximum number of migration tasks to return. The service may return fewer than this number. |
page_token |
Optional. A page token, received from previous When paginating, all other parameters provided to |
filter |
Optional. The filter to apply. This can be used to get the subtasks of a specific tasks in a workflow, e.g. |
ListMigrationSubtasksResponse
Response object for a ListMigrationSubtasks
call.
Fields | |
---|---|
migration_subtasks[] |
The migration subtasks for the specified task. |
next_page_token |
A token, which can be sent as |
ListMigrationWorkflowsRequest
A request to list previously created migration workflows.
Fields | |
---|---|
parent |
Required. The project and location of the migration workflows to list. Example: |
read_mask |
The list of fields to be retrieved. |
page_size |
The maximum number of migration workflows to return. The service may return fewer than this number. |
page_token |
A page token, received from previous When paginating, all other parameters provided to |
ListMigrationWorkflowsResponse
Response object for a ListMigrationWorkflows
call.
Fields | |
---|---|
migration_workflows[] |
The migration workflows for the specified project / location. |
next_page_token |
A token, which can be sent as |
MigrationSubtask
A subtask for a migration which carries details about the configuration of the subtask. The content of the details should not matter to the end user, but is a contract between the subtask creator and subtask worker.
Fields | |
---|---|
name |
Output only. Immutable. The resource name for the migration subtask. The ID is server-generated. Example: |
task_id |
The unique ID of the task to which this subtask belongs. |
type |
The type of the Subtask. The migration service does not check whether this is a known type. It is up to the task creator (i.e. orchestrator or worker) to ensure it only creates subtasks for which there are compatible workers polling for Subtasks. |
state |
Output only. The current state of the subtask. |
processing_error |
Output only. An explanation that may be populated when the task is in FAILED state. |
resource_error_details[] |
Output only. Provides details to errors and issues encountered while processing the subtask. Presence of error details does not mean that the subtask failed. |
resource_error_count |
The number or resources with errors. Note: This is not the total number of errors as each resource can have more than one error. This is used to indicate truncation by having a |
create_time |
Time when the subtask was created. |
last_update_time |
Time when the subtask was last updated. |
metrics[] |
The metrics for the subtask. |
State
Possible states of a migration subtask.
Enums | |
---|---|
STATE_UNSPECIFIED |
The state is unspecified. |
ACTIVE |
The subtask is ready, i.e. it is ready for execution. |
RUNNING |
The subtask is running, i.e. it is assigned to a worker for execution. |
SUCCEEDED |
The subtask finished successfully. |
FAILED |
The subtask finished unsuccessfully. |
PAUSED |
The subtask is paused, i.e., it will not be scheduled. If it was already assigned,it might still finish but no new lease renewals will be granted. |
MigrationTask
A single task for a migration which has details about the configuration of the task.
Fields | |
---|---|
id |
Output only. Immutable. The unique identifier for the migration task. The ID is server-generated. |
type |
The type of the task. This must be one of the supported task types: Translation_Teradata2BQ, Translation_Redshift2BQ, Translation_Bteq2BQ, Translation_Oracle2BQ, Translation_HiveQL2BQ, Translation_SparkSQL2BQ, Translation_Snowflake2BQ, Translation_Netezza2BQ, Translation_AzureSynapse2BQ, Translation_Vertica2BQ, Translation_SQLServer2BQ, Translation_Presto2BQ, Translation_MySQL2BQ, Translation_Postgresql2BQ. |
state |
Output only. The current state of the task. |
processing_error |
Output only. An explanation that may be populated when the task is in FAILED state. |
create_time |
Time when the task was created. |
last_update_time |
Time when the task was last updated. |
translation_config_details |
Task configuration for CW Batch/Offline SQL Translation. |
State
Possible states of a migration task.
Enums | |
---|---|
STATE_UNSPECIFIED |
The state is unspecified. |
PENDING |
The task is waiting for orchestration. |
ORCHESTRATING |
The task is assigned to an orchestrator. |
RUNNING |
The task is running, i.e. its subtasks are ready for execution. |
PAUSED |
Tha task is paused. Assigned subtasks can continue, but no new subtasks will be scheduled. |
SUCCEEDED |
The task finished successfully. |
FAILED |
The task finished unsuccessfully. |
MigrationWorkflow
A migration workflow which specifies what needs to be done for an EDW migration.
Fields | |
---|---|
name |
Output only. Immutable. The unique identifier for the migration workflow. The ID is server-generated. Example: |
display_name |
The display name of the workflow. This can be set to give a workflow a descriptive name. There is no guarantee or enforcement of uniqueness. |
tasks |
The tasks in a workflow in a named map. The name (i.e. key) has no meaning and is merely a convenient way to address a specific task in a workflow. |
state |
Output only. That status of the workflow. |
create_time |
Time when the workflow was created. |
last_update_time |
Time when the workflow was last updated. |
State
Possible migration workflow states.
Enums | |
---|---|
STATE_UNSPECIFIED |
Workflow state is unspecified. |
DRAFT |
Workflow is in draft status, i.e. tasks are not yet eligible for execution. |
RUNNING |
Workflow is running (i.e. tasks are eligible for execution). |
PAUSED |
Workflow is paused. Tasks currently in progress may continue, but no further tasks will be scheduled. |
COMPLETED |
Workflow is complete. There should not be any task in a non-terminal state, but if they are (e.g. forced termination), they will not be scheduled. |
MySQLDialect
The dialect definition for MySQL.
NameMappingKey
The potential components of a full name mapping that will be mapped during translation in the source data warehouse.
Fields | |
---|---|
type |
The type of object that is being mapped. |
database |
The database name (BigQuery project ID equivalent in the source data warehouse). |
schema |
The schema name (BigQuery dataset equivalent in the source data warehouse). |
relation |
The relation name (BigQuery table or view equivalent in the source data warehouse). |
attribute |
The attribute name (BigQuery column equivalent in the source data warehouse). |
Type
The type of the object that is being mapped.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Unspecified name mapping type. |
DATABASE |
The object being mapped is a database. |
SCHEMA |
The object being mapped is a schema. |
RELATION |
The object being mapped is a relation. |
ATTRIBUTE |
The object being mapped is an attribute. |
RELATION_ALIAS |
The object being mapped is a relation alias. |
ATTRIBUTE_ALIAS |
The object being mapped is a an attribute alias. |
FUNCTION |
The object being mapped is a function. |
NameMappingValue
The potential components of a full name mapping that will be mapped during translation in the target data warehouse.
Fields | |
---|---|
database |
The database name (BigQuery project ID equivalent in the target data warehouse). |
schema |
The schema name (BigQuery dataset equivalent in the target data warehouse). |
relation |
The relation name (BigQuery table or view equivalent in the target data warehouse). |
attribute |
The attribute name (BigQuery column equivalent in the target data warehouse). |
NetezzaDialect
The dialect definition for Netezza.
ObjectNameMapping
Represents a key-value pair of NameMappingKey to NameMappingValue to represent the mapping of SQL names from the input value to desired output.
Fields | |
---|---|
source |
The name of the object in source that is being mapped. |
target |
<