DMS Schema Conversion の変換ルール

変換ルールを使用すると、DMS Schema Conversion がデータベースオブジェクトを変換する方法をカスタマイズし、デフォルトの命名とデータ型マッピングを上書きできます。これらのルールは、データベース、スキーマ、テーブル、ビュー、列、関数戻り値、ルーチンパラメータ、ローカル変数に適用できます。

例えば、test_TABLE_NAME という名前のソーススキーマにテーブルがあるとします。ターゲットスキーマ内にあるプレフィックス test_ をプレフィックス demo_ に変更するルールを設定できます。

変換ルールを作成して、次のとおりのタスクを実行できます。

プレフィックスの追加、削除、または置換
サフィックスの追加、削除、または置換
列、関数戻り値、ルーチンパラメータ、またはローカル変数のデータ型を変更する
オブジェクト名を小文字または大文字に変換する
オブジェクトの名前を変更する

変換ルールの作成

移行プロジェクトの一環として、DMS Schema Conversion は変換ルールを保存します。変換ルールを定義するには、移行プロジェクトを作成または変更するときに、それらをrules配列を持つオブジェクトを含む JSON 文字列として渡します。配列内の各要素は、個別のルールオブジェクトを表します。移行プロジェクトは、最大 512 の変換ルール (最大 128 KB) をサポートします。

変換ルールを含む配列の構造は次のとおりです。


{
  "rules": [
    {
      Rule object 1
    },
    {
      Rule object 2
    },
    ...
    {
      Rule object N
    }
  ]
}

プロジェクトには複数の変換ルールを追加できます。DMS Schema Conversion は変換中に、変換ルールが追加された順番通りにルールを適用します。

複数のルールが同じオブジェクトを対象とする場合、動作はアクションタイプによって異なります。アクションタイプが異なるルールはすべて有効になります。たとえば、 add-prefixルールと add-suffixルールの両方が適用されます。同じアクションタイプのルールは互いに上書きされ、最後のアクションタイプのみが有効になります。

変換ルールを作成するには、次のいずれかの方法を使用します。

AWS Management Console

コンソールを使用して変換ルールを作成するには

[移行プロジェクトの作成] ページで、[変換ルールの追加] をクリックします。詳細については、「移行プロジェクトの作成」を参照してください。
ルールターゲットで、このルールが適用されるデータベースオブジェクトのタイプを選択します。コンソールウィザードは、schema、table、および columnターゲットをサポートします。database やなどの他のターゲットを使用するにはview、コンソールまたは CLI で JSON AWS エディタを使用します。
[ソーススキーマ] では、[スキーマの入力] を選択します。次に、このルールが適用されるソーススキーマ、テーブル、列を指定します。正確な名前を使用して 1 つのオブジェクトを選択するか、パーセント記号 (%) のパターンをワイルドカードとして使用して任意の文字数に一致させることができます。
[アクション] では、実行するタスクを選択します。
ルールアクションに応じて、追加の値を入力します。
- add-prefix または add-suffix – 追加するテキストを入力します。
- remove-prefix または remove-suffix – 削除するテキストを入力します。
- replace-prefix または replace-suffix – 既存のテキストと置換テキストを入力します。
- rename – オブジェクトの新しい名前を入力します。
- convert-uppercase または convert-lowercase – 追加の値は必要ありません。
- change-data-type – ターゲットデータ型名を入力し、必要に応じて精度、スケール、または長さを入力します。
[変換ルールの追加] をクリックすると、別の変換ルールを追加できます。

ルールの追加が完了したら、[移行プロジェクトを作成] をクリックします。

AWS CLI

CLI を使用して変換ルールを追加するには、次のいずれかのコマンドで AWS --transformation-rulesパラメータを使用します。

create-migration-project – 新しい移行プロジェクトを作成する場合。
modify-migration-project – 既存の移行プロジェクト用。

次の例では、既存の移行プロジェクトに変換ルールを追加します。


aws dms modify-migration-project \
  --migration-project-identifier migration_project_arn \
  --transformation-rules 'json_rules'

特定の AWS リージョンでこのコマンドを実行するには、などの --regionパラメータを追加します--region us-west-2。

既存の変換ルールを編集、複製、または削除するには、「」を参照してください変換ルールの編集。

変換ルールの取得

AWS マネジメントコンソールまたは AWS CLI を使用して、既存の DMS Schema Conversion 移行プロジェクトから変換ルールを取得できます。

変換ルールの編集

移行プロジェクトの変換ルールを編集、追加、または削除するには、次のいずれかの方法を使用します。

AWS Management Console

変換ルールを編集するには

[移行プロジェクト] を選択して、編集する移行プロジェクトを選択します。
変更を選択して移行プロジェクト設定を編集します。
[変換ルール] で、次のいずれかのアクションを選択します。
- 変換ルールの追加 を選択して、新しい変換ルールを追加します。
- 重複を選択して既存の変換ルールを複製し、リストの最後に追加します。
- 既存の変換ルールを削除するには、[削除] を選択する。
- 編集するには、既存の変換ルールを選択する。
ルールの編集を完了した後、[変更を保存] を選択します。

AWS CLI

AWS CLI を使用して変換ルールを更新するには、 --transformation-rulesパラメータを指定して modify-migration-project コマンドを使用します。更新されたルールの完全なセットを JSON 文字列として渡します。


aws dms modify-migration-project \
  --migration-project-identifier migration_project_arn \
  --transformation-rules 'json_rules'

変換ルールの形式

変換ルールは JSON オブジェクトフィールドを使用して、ソースオブジェクトを同等のターゲットに変換する方法を定義します。各ルールタイプは、特定のフィールドのセットを使用します。タスクに適用されるフィールドのみを含めます。

次の JSON オブジェクトは、DMS Schema Conversion 変換ルールを記述します。


{
  "rule-type": "transformation",
  "rule-id": rule_id,
  "rule-name": "rule_name",
  "rule-action": "rule_action",
  "rule-target": "rule_target",
  "object-locator": {
    [ "database-name": "database_name", ]
    [ "schema-name": "schema_name", ]
    [ "table-name": "table_name", ]
    [ "column-name": "column_name", ]
    [ "parent": "parent_name", ]
    [ "function-name": "function_name", ]
    [ "procedure-name": "procedure_name", ]
    [ "parameter-name": "parameter_name", ]
    [ "local-variable-name": "local_variable_name", ]
    [ "type": "source_data_type", ]
    [ "precision": source_precision, ]
    [ "scale": source_scale, ]
    [ "length": source_length ]
  },
  [ "value": "rule_value", ]
  [ "old-value": "rule_old_value", ]
  [ "data-type": {
    "type": "data_type_name",
    [ "precision": data_type_precision, ]
    [ "scale": data_type_scale, ]
    [ "length": data_type_length ]
  } ]
}

次の表に、各パラメータを示します。

パラメータ	使用できる値:	説明
`rule-type`	`transformation`	オブジェクトロケーターで指定された各オブジェクトにルールを適用する値。すべての変換ルールで、これをに設定します`transformation`。必須パラメータ。
`rule-id`	数値 (整数）。	ルールを識別する一意の数値。必須パラメータ。
`rule-name`	英数字値。	ルールを特定する一意な名前。必須パラメータ。
`rule-action`	`add-prefix`, `remove-prefix`, `replace-prefix`, `add-suffix`, `remove-suffix`, `replace-suffix`, `convert-uppercase`, `convert-lowercase`, `rename`, `change-data-type`	オブジェクトに適用する変換。すべて変換ルールアクションでは、大文字と小文字が区別されます。プレフィックスオペレーション: `add-prefix` – 指定されたテキストを名前の先頭に追加します。 `remove-prefix` – 名前の先頭から指定されたテキストを削除します。 `replace-prefix` – 既存のプレフィックスを新しいプレフィックスに置き換えます。サフィックスオペレーション: `add-suffix` – 指定されたテキストを名前の末尾に追加します。 `remove-suffix` – 名前の末尾から指定されたテキストを削除します。 `replace-suffix` – 既存のサフィックスを新しいサフィックスに置き換えます。ケース変換: `convert-uppercase` – 名前内のすべての文字を大文字に変換します。 `convert-lowercase` – 名前内のすべての文字を小文字に変換します。直接変更: `rename` – 名前をまったく新しい指定された値に変更します。 `change-data-type` – 列またはローカル変数のデータ型を別のデータ型に変更します。スコープ: プレフィックス、サフィックス、名前変更、大文字と小文字の変換オペレーションをスキーマ、テーブル、列に適用できます。 `change-data-type` オペレーションは、列、関数戻り値、ルーチンパラメータ、ローカル変数にのみ適用されます。必須パラメータ。
`rule-target`	`database`, `schema`, `table`, `view`, `column`, `function result`, `routine parameter`, `local variable`	ルールが適用されるオブジェクトのタイプ。 `database` – データベース。 `schema` – データベーススキーマ。 `table` – データベーステーブル。 `view` – データベースビュー。 `column` – データベーステーブルまたはビュー列。 `function result` – 関数の戻り値。 `routine parameter` – ストアドプロシージャまたは関数パラメータ。 `local variable` – ストアドプロシージャまたは関数内のローカル変数。必須パラメータ。
`object-locator`	JSON オブジェクト。	ルールが適用されるソースデータベースオブジェクトを識別するオブジェクト。パーセント記号 (`%`) は、各`object-locator`オブジェクトフィールドの値の全部または一部のワイルドカードとして使用できます。オブジェクトには、次の文字列フィールドが含まれます。 `database-name` `schema-name` `table-name` `column-name` `parent` `function-name` `procedure-name` `parameter-name` `local-variable-name` `type` `precision` `scale` `length` 変換ルールでは、テーブル名や列名など、すべてのオブジェクト名で大文字と小文字が区別されます。以下のセクションでは、各オブジェクトフィールドについて説明します。必須パラメータ。
`object-locator \| database-name`	ソースデータベースの命名規則に従う英数字の値。	ソースデータベースの名前。データベースアーキテクチャがオブジェクトの最上位コンテナとしてデータベースから発信されるデータベースベンダーに適用されます。例: Microsoft SQL Server、SAP ASE。オプションの JSON オブジェクトフィールド。
`object-locator \| schema-name`	ソースデータベースの命名規則に従う英数字の値。	ソースデータベーススキーマの名前。オプションの JSON オブジェクトフィールド。
`object-locator \| table-name`	ソースデータベースの命名規則に従う英数字の値。	ソースデータベーステーブルの名前。オプションの JSON オブジェクトフィールド。
`object-locator \| column-name`	ソースデータベースの命名規則に従う英数字の値。	ソースデータベーステーブル列の名前。オプションの JSON オブジェクトフィールド。
`object-locator \| parent`	ソースデータベースの命名規則に従う英数字の値。	またはなど、指定されたオブジェクトの親であるソースデータベースオブジェクトの名前`function-nameprocedure-name`。一部のベンダーのデータベースでは、ルールが適用されるオブジェクトが下位であり、親の指定が必要になる場合があります。たとえば、Oracle のパッケージ化された関数です。親はパッケージ名です。オプションの JSON オブジェクトフィールド。
`object-locator \| function-name`	ソースデータベースの命名規則に従う英数字の値。	ソースデータベース関数の名前。オプションの JSON オブジェクトフィールド。
`object-locator \| procedure-name`	ソースデータベースの命名規則に従う英数字の値。	ソースデータベースプロシージャの名前。オプションの JSON オブジェクトフィールド。
`object-locator \| parameter-name`	ソースデータベースの命名規則に従う英数字の値。	ソースデータベース関数またはプロシージャパラメータの名前。オプションの JSON オブジェクトフィールド。
`object-locator \| local-variable-name`	ソースデータベースの命名規則に従う英数字の値。	ソースデータベース関数またはプロシージャ内のローカル変数の名前。オプションの JSON オブジェクトフィールド。
`object-locator \| type`	英数字値。	一致するソースデータ型名。このフィールドを使用して、特定のデータ型のオブジェクトにのみルールを適用します。オプションの JSON オブジェクトフィールド。
`object-locator \| precision`	数値 (整数）。	一致するソースデータ型の精度。オプションの JSON オブジェクトフィールド。
`object-locator \| scale`	数値 (整数）。	一致するソースデータ型のスケール。オプションの JSON オブジェクトフィールド。
`object-locator \| length`	数値 (整数）。	一致するソースデータ型の長さ。オプションの JSON オブジェクトフィールド。
`value`	ターゲットデータベースの命名規則に従う英数字の値。	変換アクションで使用されるテキスト値。`add-prefix` およびの場合`add-suffix`、追加するテキストを指定します。`remove-prefix` との場合`remove-suffix`、削除するテキストを指定します。`replace-prefix` とでは`replace-suffix`、置換テキストを指定します。では`rename`、新しい名前を指定します。 `convert-uppercase`、、`convert-lowercase`およびを除くすべてのアクションに必要です`change-data-type`。
`old-value`	ソースデータベースの命名規則に従う英数字の値。	オブジェクト名で検索して置き換える既存の値。`replace-prefix` やなどのアクションに必要です`replace-suffix`。オプションのパラメータ。
`data-type`	JSON オブジェクト。	`rule-action` がの場合に置換データ型のプロパティを記述するオブジェクト`change-data-type`。オブジェクトには、以下のフィールドが含まれています。 `type` : 文字列 `precision` : 数値 `scale` : 数値 `length` : 数値以下のセクションでは、各オブジェクトフィールドについて説明します。オプションのパラメータ。
`data-type \| type`	英数字値。	`rule-action` がの場合、ターゲットデータベース列の置き換えデータ型の名前`change-data-type`。有効なターゲットデータベースデータ型である必要があります。必須の JSON オブジェクトフィールド。
`data-type \| precision`	数値 (整数）。	がの場合のターゲットデータベースの置換データ型の精度`rule-actionchange-data-type`。オプションの JSON オブジェクトフィールド。
`data-type \| scale`	数値 (整数）。	`rule-action` がの場合、ターゲットデータベースの置き換えデータ型のスケール`change-data-type`。オプションの JSON オブジェクトフィールド。
`data-type \| length`	数値 (整数）。	`rule-action` がの場合、ターゲットデータベースの置き換えデータ型の長さ`change-data-type`。オプションの JSON オブジェクトフィールド。