- リソース: MigrationWorkflow
- MigrationTask
- AssessmentTaskDetails
- TranslationTaskDetails
- TeradataOptions
- BteqOptions
- DatasetReference
- TranslationFileMapping
- FileEncoding
- IdentifierSettings
- IdentifierCase
- IdentifierRewriteMode
- TokenType
- フィルタ
- TranslationConfigDetails
- 言語
- BigQueryDialect
- HiveQLDialect
- RedshiftDialect
- TeradataDialect
- モード
- OracleDialect
- SparkSQLDialect
- SnowflakeDialect
- NetezzaDialect
- AzureSynapseDialect
- VerticaDialect
- SQLServerDialect
- PostgresqlDialect
- PrestoDialect
- MySQLDialect
- SourceEnv
- SourceTargetLocationMapping
- SourceLocation
- TargetLocation
- TranslationDetails
- SourceTargetMapping
- SourceSpec
- リテラル
- TargetSpec
- 状態
- MigrationTaskOrchestrationResult
- AssessmentOrchestrationResultDetails
- TranslationTaskResult
- GcsReportLogMessage
- 状態
- メソッド
リソース: MigrationWorkflow
EDW 移行に必要な作業を指定する移行ワークフロー。
JSON 表現 |
---|
{ "name": string, "displayName": string, "tasks": { string: { object ( |
フィールド | |
---|---|
name |
出力専用。変更不可。ID。移行ワークフローの固有識別子。ID はサーバーによって生成されます。 例: |
displayName |
ワークフローの表示名。ワークフローにわかりやすい名前を付けるために設定できます。一意性の保証も、強制適用もありません。 |
tasks |
名前付きマップにあるワークフロー内のタスク。名前(キーなど)に意味はなく、ワークフローの特定のタスクを処理するための便利な方法にすぎません。 |
state |
出力専用。ワークフローのステータス。 |
createTime |
ワークフローが作成された時刻。 |
lastUpdateTime |
ワークフローが最後に更新された時刻。 |
MigrationTask
移行用の単一のタスク。タスクの構成に関する詳細が含まれます。
JSON 表現 |
---|
{ "id": string, "type": string, "details": { "@type": string, field1: ..., ... }, "state": enum ( |
フィールド | |
---|---|
id |
出力専用。変更不可。移行タスクの固有識別子。ID はサーバーによって生成されます。 |
type |
タスクのタイプ。サポートされているタスクタイプ(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)のいずれかにする必要があります。 |
details |
非推奨。以下のいずれかの task_details を使用します。タスクの詳細。タイプ URL は、サポートされているタスクの詳細メッセージのいずれかであり、タスクのタイプに対応している必要があります。 |
state |
出力専用。タスクの現在の状態。 |
processingError |
出力専用。タスクが FAILED 状態のときに表示される説明。 |
createTime |
タスクが作成された時刻。 |
lastUpdateTime |
タスクが最後に更新された時刻。 |
orchestrationResult |
出力専用。オーケストレーションに関する追加情報。 |
resourceErrorDetails[] |
出力専用。タスクの処理中に発生したエラーと問題の詳細を提供します。エラーの詳細が存在しても、タスクが失敗したわけではありません。 |
resourceErrorCount |
エラーのあるリソースの数。注: 各リソースに複数のエラーがある可能性があるため、これはエラーの総数ではありません。これは、 |
metrics[] |
タスクの指標。 |
共用体フィールド task_details 。タスクの詳細。task_details は次のいずれかになります。 |
|
assessmentTaskDetails |
評価のタスク構成。 |
translationTaskDetails |
バッチ SQL 変換のタスク構成。 |
translationConfigDetails |
CW バッチ / オフライン SQL 変換のタスク構成。 |
translationDetails |
統合 SQL 変換のタスクの詳細。 |
AssessmentTaskDetails
評価タスクの構成。
JSON 表現 |
---|
{ "inputPath": string, "outputDataset": string, "querylogsPath": string, "dataSource": string } |
フィールド | |
---|---|
inputPath |
必須。評価入力ファイルの Cloud Storage パス。 |
outputDataset |
必須。出力用の BigQuery データセット。 |
querylogsPath |
省略可。クエリログを書き込む Cloud Storage パス(変換タスクの入力パスとして使用されます)。省略可能です。 |
dataSource |
必須。入力データが抽出されるデータソースまたはデータ ウェアハウスのタイプ(TERADATA / REDSHIFT など)。 |
TranslationTaskDetails
変換タスクとサブタスクに必要な設定をキャプチャする変換タスクの構成。
JSON 表現 |
---|
{ "inputPath": string, "outputPath": string, "filePaths": [ { object ( |
フィールド | |
---|---|
inputPath |
変換の入力ファイルの Cloud Storage パス。 |
outputPath |
変換の出力ファイル用の Cloud Storage パス。 |
filePaths[] |
変換処理の対象となる Cloud Storage ファイル。 |
schemaPath |
セマンティック変換を支援するテーブル スキーマとしての DDL ファイルへの Cloud Storage パス。 |
fileEncoding |
ファイルのエンコード タイプ。 |
identifierSettings |
SQL 識別子の設定。 |
specialTokenMap |
変換時に置き換えられる特殊なトークンをキャプチャするマップ。キーは文字列内の特殊なトークンです。値はトークンのデータ型です。これは、特殊なトークンをプレースホルダとして含む SQL クエリ テンプレートを変換するために使用されます。特殊なトークンが存在すると、クエリが解析できなくなります。このマップは、これらの特殊トークンにアノテーションとしてタイプを適用します。このタイプ情報により、パーサーは適切な構造に解析する方法を特定できます。 |
filter |
変換の詳細に適用されたフィルタ。 |
translationExceptionTable |
元の変換エラーの表示に使用される BigQuery テーブルの正確な名前(dataset.table)を指定します。テーブルが存在しない場合は、新規に作成されます。すでに存在し、スキーマが同じであれば、再利用されます。テーブルが存在し、スキーマが異なる場合は、エラーがスローされます。 |
共用体フィールド language_options 。変換タスクの言語固有の設定。language_options は次のいずれかになります。 |
|
teradataOptions |
変換タスクの Teradata SQL 固有の設定。 |
bteqOptions |
変換タスクの BTEQ 固有の設定。 |
TeradataOptions
この型にはフィールドがありません。
Teradata SQL 固有の変換タスク関連の設定。
BteqOptions
BTEQ 変換タスク関連の設定。
JSON 表現 |
---|
{
"projectDataset": {
object ( |
フィールド | |
---|---|
projectDataset |
変換中に外部テーブルの作成に使用される BigQuery のプロジェクトとデータセットを指定します。 |
defaultPathUri |
ファイル置換マップで指定されていないファイルのデフォルトパスとして使用される Cloud Storage ロケーション。 |
fileReplacementMap |
BTEQ スクリプトで使用されるローカルパス(キー)を Cloud Storage のパス(値)にマッピングします。 |
DatasetReference
BigQuery データセットへの参照。
JSON 表現 |
---|
{ "datasetId": string, "projectId": string, "datasetIdAlternative": [ string ], "projectIdAlternative": [ string ] } |
フィールド | |
---|---|
datasetId |
このデータセットの一意の ID(プロジェクト名は含みません)。ID には、英字(a~z、A~Z)、数字(0~9)、アンダースコア(_)のみを使用できます。最大長は 1,024 文字です。 |
TranslationFileMapping
サブタスクで変換する入力ファイルと出力ファイルのマッピング。
JSON 表現 |
---|
{ "inputPath": string, "outputPath": string } |
フィールド | |
---|---|
inputPath |
サブタスクで変換するファイルの Cloud Storage パス。 |
outputPath |
対応する入力ファイルを書き戻す Cloud Storage のパス。 |
FileEncoding
ファイルのエンコード タイプ。
列挙型 | |
---|---|
FILE_ENCODING_UNSPECIFIED |
ファイルのエンコード設定が指定されていません。 |
UTF_8 |
ファイルのエンコードは UTF_8 です。 |
ISO_8859_1 |
ファイルのエンコードは ISO_8859_1 です。 |
US_ASCII |
ファイルのエンコードは US_ASCII です。 |
UTF_16 |
ファイルのエンコードは UTF_16 です。 |
UTF_16LE |
ファイルのエンコードは UTF_16LE です。 |
UTF_16BE |
ファイルのエンコードは UTF_16BE です。 |
IdentifierSettings
SQL 識別子に関連する設定。
JSON 表現 |
---|
{ "outputIdentifierCase": enum ( |
フィールド | |
---|---|
outputIdentifierCase |
出力クエリの識別子の大文字 / 小文字を制御する設定。 |
identifierRewriteMode |
SQL 識別子の書き換えモードを指定します。 |
IdentifierCase
識別子の大文字 / 小文字。
列挙型 | |
---|---|
IDENTIFIER_CASE_UNSPECIFIED |
識別子の大文字 / 小文字が指定されていません。 |
ORIGINAL |
元の識別子の大文字 / 小文字が維持されます。 |
UPPER |
識別子は大文字になります。 |
LOWER |
識別子は小文字になります。 |
IdentifierRewriteMode
SQL 識別子の書き換えモード。
列挙型 | |
---|---|
IDENTIFIER_REWRITE_MODE_UNSPECIFIED |
SQL 識別子の書き換えモードが指定されていません。 |
NONE |
SQL 識別子は書き換えられません。 |
REWRITE_ALL |
すべての SQL 識別子が書き換えられます。 |
TokenType
特殊なトークンのデータ型。
列挙型 | |
---|---|
TOKEN_TYPE_UNSPECIFIED |
トークンの型が指定されていません。 |
STRING |
文字列型のトークン。 |
INT64 |
整数型のトークン。 |
NUMERIC |
数値型のトークン。 |
BOOL |
ブール値型のトークン。 |
FLOAT64 |
浮動小数点型のトークン。 |
DATE |
日付型のトークン。 |
TIMESTAMP |
タイムスタンプ型のトークン。 |
フィルタ
変換の詳細フィールドに適用されるフィルタ。
JSON 表現 |
---|
{ "inputFileExclusionPrefixes": [ string ] } |
フィールド | |
---|---|
inputFileExclusionPrefixes[] |
入力ファイルの処理の除外に使用される接頭辞のリスト。 |
TranslationConfigDetails
変換タスクとサブタスクに必要な設定をキャプチャする変換構成。
JSON 表現 |
---|
{ "sourceDialect": { object ( |
フィールド | |
---|---|
sourceDialect |
入力ファイルの言語。 |
targetDialect |
エンジンが入力を変換するターゲット言語。 |
sourceEnv |
変換のデフォルトのソース環境の値。 |
sourceTargetLocationMapping[] |
ソースのロケーション パスからターゲット ロケーション パスへのマッピング。 |
requestSource |
変換リクエストの開始元を示すインジケーター。 |
共用体フィールド source_location 。入力ファイルのソースの場所として選択したパス。source_location は次のいずれかになります。 |
|
gcsSourcePath |
タスクで変換するファイルが存在するディレクトリの Cloud Storage パス。 |
共用体フィールド target_location 。出力ファイルの場所として選択したパス。target_location は次のいずれかになります。 |
|
gcsTargetPath |
対応する入力ファイルを書き戻す Cloud Storage パス。 |
言語
変換に使用できる言語のオプション。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド dialect_value 。このメッセージが表す可能な言語オプション。dialect_value は次のいずれかになります。 |
|
bigqueryDialect |
BigQuery 言語 |
hiveqlDialect |
HiveQL 言語 |
redshiftDialect |
Redshift 言語 |
teradataDialect |
Teradata 言語 |
oracleDialect |
Oracle 言語 |
sparksqlDialect |
SparkSQL 言語 |
snowflakeDialect |
Snowflake 言語 |
netezzaDialect |
Netezza 言語 |
azureSynapseDialect |
Azure Synapse 言語 |
verticaDialect |
Vertica 言語 |
sqlServerDialect |
SQL Server 言語 |
postgresqlDialect |
Postgresql 言語 |
prestoDialect |
Presto 言語 |
mysqlDialect |
MySQL 言語 |
BigQueryDialect
この型にはフィールドがありません。
BigQuery の言語定義。
HiveQLDialect
この型にはフィールドがありません。
HiveQL の言語定義。
RedshiftDialect
この型にはフィールドがありません。
Redshift の言語定義。
TeradataDialect
Teradata の言語定義。
JSON 表現 |
---|
{
"mode": enum ( |
フィールド | |
---|---|
mode |
ユーザーが指定する Teradata サブ言語モード。 |
モード
Teradata のサブ言語のオプション。
列挙型 | |
---|---|
MODE_UNSPECIFIED |
モードが指定されていません。 |
SQL |
Teradata SQL モード。 |
BTEQ |
BTEQ モード(SQL を含む)。 |
OracleDialect
この型にはフィールドがありません。
Oracle の言語定義。
SparkSQLDialect
この型にはフィールドがありません。
SparkSQL の言語定義。
SnowflakeDialect
この型にはフィールドがありません。
Snowflake の言語定義。
NetezzaDialect
この型にはフィールドがありません。
Netezza の言語定義。
AzureSynapseDialect
この型にはフィールドがありません。
Azure Synapse の言語定義。
VerticaDialect
この型にはフィールドがありません。
Vertica の言語定義。
SQLServerDialect
この型にはフィールドがありません。
SQL Server の言語定義。
PostgresqlDialect
この型にはフィールドがありません。
Postgresql の言語定義。
PrestoDialect
この型にはフィールドがありません。
Presto の言語定義。
MySQLDialect
この型にはフィールドがありません。
MySQL の言語定義。
SourceTargetLocationMapping
ソースのロケーション パスからターゲット ロケーション パス(省略可)への 1 つのマッピングを表します。
JSON 表現 |
---|
{ "sourceLocation": { object ( |
フィールド | |
---|---|
sourceLocation |
ソースデータの場所のパス。 |
targetLocation |
ターゲット データの場所のパス。 |
SourceLocation
ソースデータを保持する場所 1 つのパスを表します。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド location 。ソースデータの場所。location は次のいずれかになります。 |
|
gcsPath |
ファイルのディレクトリの Cloud Storage パス。 |
TargetLocation
// ターゲット データを保持する場所の 1 つのパスを表します。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド location 。ターゲット データの場所。location は次のいずれかになります。 |
|
gcsPath |
ファイルのディレクトリの Cloud Storage パス。 |
TranslationDetails
変換ジョブに必要な設定をキャプチャするための変換の詳細。
JSON 表現 |
---|
{ "sourceTargetMapping": [ { object ( |
フィールド | |
---|---|
sourceTargetMapping[] |
ソース SQL からターゲット SQL へのマッピング。 |
targetBaseUri |
永続ストレージに対するすべての書き込みのベース URI。 |
sourceEnvironment |
変換のデフォルトのソース環境の値。 |
targetReturnLiterals[] |
レスポンスに直接返されるリテラル ターゲットのリスト。各エントリは、ベースパスを除く、構築されたパスで構成されます。targetBaseUri を指定しない場合、永続ストレージへの書き込みは行われません。 |
targetTypes[] |
生成する出力のタイプ(sql、sqlx、lineage、analysis など)。指定しない場合、デフォルトのターゲット セットが生成されます。一部のターゲット タイプは生成に時間がかかります。使用可能なターゲット タイプについては、ドキュメントをご覧ください。 |
SourceTargetMapping
ソース SQL からターゲット SQL への 1 つのマッピングを表します。
JSON 表現 |
---|
{ "sourceSpec": { object ( |
フィールド | |
---|---|
sourceSpec |
ソース SQL またはそのパス。 |
targetSpec |
ターゲット SQL またはそのパス。 |
SourceSpec
ソースデータを保持する場所 1 つのパスを表します。
JSON 表現 |
---|
{ "encoding": string, // Union field |
フィールド | |
---|---|
encoding |
省略可。SQL バイトのエンコードを指定するためのオプション フィールド。 |
共用体フィールド source 。特定のソース SQL。source は次のいずれかになります。 |
|
baseUri |
変換元として読み取られるすべてのファイルのベース URI。 |
literal |
ソースリテラル。 |
リテラル
リテラルデータ。
JSON 表現 |
---|
{ "relativePath": string, // Union field |
フィールド | |
---|---|
relativePath |
必須。リテラル エントリの識別子。 |
共用体フィールド literal_data 。リテラル SQL のコンテンツ。literal_data は次のいずれかになります。 |
|
literalString |
リテラル文字列データ。 |
literalBytes |
リテラル バイトデータ。 |
TargetSpec
ターゲット データを保持するロケーションの 1 つのパスを表します。
JSON 表現 |
---|
{ "relativePath": string } |
フィールド | |
---|---|
relativePath |
ターゲット データの相対パス。ソースファイル |
SourceEnvironment
変換のデフォルトのソース環境の値を表します。
JSON 表現 |
---|
{ "defaultDatabase": string, "schemaSearchPath": [ string ], "metadataStoreDataset": string } |
フィールド | |
---|---|
defaultDatabase |
データベース名がない場合の SQL オブジェクトの完全修飾に使用するデフォルトのデータベース名。 |
schemaSearchPath[] |
スキーマの検索パス。SQL オブジェクトにスキーマ名がない場合は、変換エンジンがこのリストを検索して値を見つけます。 |
metadataStoreDataset |
省略可。有効な BigQuery データセット ID が必要です(例: project-123.metadata_store_123)。指定すると、このデータセットのメタデータ ストアから必要なスキーマ情報が読み取られます。メタデータ ストアが存在しない場合は、メタデータ ファイルが解析され、スキーマ情報がデータセットの一時テーブルにアップロードされます。これにより、以降の変換ジョブの速度が向上します。 |
状態
移行タスクの取り得る状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
状態は指定されていません。 |
PENDING |
タスクはオーケストレーションを待っています。 |
ORCHESTRATING |
タスクはオーケストレーターに割り当てられます。 |
RUNNING |
タスクが実行中です(サブタスクの実行準備が完了しています)。 |
PAUSED |
タスクは一時停止されます。割り当てられたサブタスクは継続できますが、新しいサブタスクはスケジュールされません。 |
SUCCEEDED |
タスクが正常に完了しました。 |
FAILED |
タスクが正常に終了しませんでした。 |
MigrationTaskOrchestrationResult
タスク オーケストレーションが完了したときにオーケストレーターから追加される情報。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド details 。タスクタイプに固有の詳細。details は次のいずれかになります。 |
|
assessmentDetails |
評価タスクのタイプに固有の詳細。 |
translationTaskResult |
変換タスクのタイプに固有の詳細。 |
AssessmentOrchestrationResultDetails
評価タスク オーケストレーションの結果の詳細。
JSON 表現 |
---|
{ "outputTablesSchemaVersion": string, "reportUri": string } |
フィールド | |
---|---|
outputTablesSchemaVersion |
省略可。出力テーブル スキーマに使用されるバージョン。 |
reportUri |
省略可。データポータル レポートの URI。 |
TranslationTaskResult
移行タスクからの変換に固有の結果の詳細。
JSON 表現 |
---|
{ "translatedLiterals": [ { object ( |
フィールド | |
---|---|
translatedLiterals[] |
変換されたリテラルのリスト。 |
reportLogMessages[] |
移行ワークフローの集計 CSV レポートのレコード。 |
GcsReportLogMessage
移行ワークフローの集計 CSV レポートのレコード
JSON 表現 |
---|
{ "severity": string, "category": string, "filePath": string, "filename": string, "sourceScriptLine": integer, "sourceScriptColumn": integer, "message": string, "scriptContext": string, "action": string, "effect": string, "objectName": string } |
フィールド | |
---|---|
severity |
変換レコードの重大度。 |
category |
エラーまたは警告のカテゴリ。例: SyntaxError |
filePath |
エラーが発生したファイルパス |
filename |
エラーが発生したファイル名 |
sourceScriptLine |
エラーが発生したソーステキストの行を指定します。0 から始まります。行の場所がないメッセージは -1 になります。例: 2 |
sourceScriptColumn |
エラーが発生したソーステキストの列を指定します。0 から始まります。列の位置がないメッセージは -1 になります。例: 6 |
message |
レコードの詳細メッセージ。 |
scriptContext |
エラーが発生したスクリプト コンテキスト(難読化) |
action |
エラーまたは警告のカテゴリ。例: SyntaxError |
effect |
エラーまたは警告のカテゴリ。例: SyntaxError |
objectName |
ログ メッセージで影響を受けるオブジェクトの名前。 |
状態
移行ワークフローの状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
ワークフローの状態が指定されていません。 |
DRAFT |
ワークフローがドラフト ステータスです。つまり、タスクはまだ実行できません。 |
RUNNING |
ワークフローが実行中です(タスクが実行可能な状態です)。 |
PAUSED |
ワークフローは一時停止しています。現在進行中のタスクは続行されますが、それ以降のタスクはスケジュールされません。 |
COMPLETED |
ワークフローが完了しました。終了以外の状態のタスクは存在しないはずですが、存在する場合(強制終了など)はスケジュールされません。 |
メソッド |
|
---|---|
|
移行ワークフローを作成します。 |
|
移行ワークフローを名前で削除します。 |
|
以前に作成された移行ワークフローを取得します。 |
|
以前に作成された移行ワークフローを一覧表示します。 |
|
以前に作成した移行ワークフローを開始します。 |