すべてのプロダクト
Search
ドキュメントセンター

Data Transmission Service:Reserve パラメーターの説明

最終更新日:Dec 11, 2025

特定の API 操作を呼び出して移行、同期、または追跡タスクを設定またはクエリする場合、Reserve パラメーターを設定またはクエリする必要があります。このパラメーターは JSON 形式の文字列であり、宛先 Kafka クラスターのデータストレージ形式や Cloud Enterprise Network (CEN) インスタンスのインスタンス ID など、ソースインスタンスまたは宛先インスタンスの設定情報を補足または表示するために使用されます。このトピックでは、Reserve パラメーターのシナリオと設定手順について説明します。

注意事項

  • インスタンスのタスクタイプとデータベースの接続タイプに基づいて共通パラメーターを設定します。次に、ソースデータベースとターゲットデータベースのタイプに基づいて他のパラメーターを設定します。

  • ソースデータベースとターゲットデータベースがパラメーターを共有している場合は、一度だけ設定します。

  • 数値を指定する場合は、二重引用符 ("") で囲んで文字列に変換する必要があります。

  • コンソールでタスクを設定し、対応する OpenAPI パラメーターをプレビューできます。これにより、リクエストパラメーターを簡単に指定できます。詳細については、「OpenAPI リクエストパラメーターのプレビュー」をご参照ください。

関連 API

共通パラメーター

DTS インスタンスタイプとデータベースの接続タイプに基づいて、Reserve パラメーター内のパラメーターを設定します。

表 1. 移行または同期インスタンス

パラメーター

必須

説明

targetTableMode

はい

ターゲットデータベース内の既存のテーブルの処理モード:

  • 0:事前チェックを実行し、エラーを報告してタスクを停止します。

  • 2:エラーを無視してタスクを続行します。

dts.datamove.source.bps.max

いいえ

完全タスクまたは増分タスクで 1 秒あたりに同期または移行できる最大データ量 (バイト単位)。

説明

このパラメーターは、fullDynamicConfig または incDynamicConfig と一緒に使用する必要があります。たとえば、API を呼び出す際に、{"fullDynamicConfig": {"dts.datamove.source.bps.max":10485760},"incDynamicConfig": {"dts.datamove.source.bps.max":10485760}} を渡します。

conflict

いいえ

双方向同期タスクのグローバル競合解決ポリシー。有効値:

  • overwrite:同期中にデータ競合が発生した場合、ターゲットデータベース内の競合するレコードが上書きされます。

  • interrupt:同期中にデータ競合が発生した場合、同期タスクはエラーを報告して終了します。タスクは失敗状態になります。タスクを手動で修正する必要があります。

  • ignore:同期中にデータ競合が発生した場合、現在の同期ステートメントはスキップされ、タスクは続行されます。ターゲットデータベース内の競合するレコードが使用されます。

filterDDL

いいえ

双方向同期でフォワードタスクの DDL 操作をフィルターするかどうかを指定します。有効値:

  • true:DDL 操作を同期しません。

  • false:DDL 操作を同期します。

    重要

    リバースタスクは自動的に DDL 操作をフィルターします。

autoStartModulesAfterConfig

いいえ

タスクの起動制御パラメーター。有効値:

  • none:DTS タスクの設定後、事前チェックなどのモジュールは起動しません。タスクを手動で起動する必要があります。

  • auto:DTS タスクの設定後、事前チェックモジュールとそれに続くすべてのモジュールが自動的に起動します。

    説明

    デフォルト値は、購入優先シナリオでは auto です。このパラメーターは、設定優先シナリオでは有効ではありません。

etlOperatorCtl

いいえ

抽出、変換、ロード (ETL) 機能を設定するかどうかを指定します。有効値:

  • Y:はい、ETL 機能を設定します。

  • N:いいえ、ETL 機能を設定しません。

etlOperatorSetting

いいえ

ETL のデータ処理ステートメント。詳細については、「データ処理 DSL 構文」をご参照ください。

etlOperatorColumnReference

いいえ

T+1 サービス専用のフィールドです。これは ETL オペレーターです。

configKeyMap

いいえ

ETL オペレーターの設定情報。

syncArchitecture

いいえ

同期トポロジ。有効値:

  • oneway:一方向同期。

  • bidirectional:双方向同期。

dataCheckConfigure

いいえ

データ検証の設定。詳細については、「DataCheckConfigure パラメーターの説明」をご参照ください。

dbListCaseChangeMode

いいえ

ターゲットデータベースのオブジェクト名の大文字と小文字の区別ポリシー。有効値:

  • default:デフォルトの DTS ポリシーを使用します。

  • source:ソースデータベースと同じ大文字小文字を維持します。

  • dest_upper:ターゲットデータベースのデフォルトポリシー (大文字) に従います。

  • dest_lower:ターゲットデータベースのデフォルトポリシー (小文字) に従います。

maxRetryTime

いいえ

ネットワークエラーやロック待ちなどの予測可能な例外が発生した後、ソースまたはターゲットデータベースへの接続をリトライするまでの待機時間。値は 600 から 86,400 までの整数である必要があります。単位は秒です。デフォルト値は 720 分 (43,200 秒) です。この値を 30 分 (1,800 秒) 以上に設定してください。

retry.blind.seconds

いいえ

DDL または DML 実行例外など、ソースまたはターゲットデータベースで予期しない例外が発生した後にリトライするまでの待機時間。値は 60 から 86,340 までの整数である必要があります。単位は秒です。デフォルト値は 10 分 (600 秒) です。この値を 10 分 (600 秒) 以上に設定してください。

重要
  • retry.blind.seconds の値は maxRetryTime の値より小さくする必要があります。

  • データベースに複数の DTS インスタンスがある場合、DTS インスタンス間で設定された最短のリトライ時間が使用されます。

modulesExtraConfiguration

いいえ

モジュールの拡張設定項目。設定項目内のパラメーターについては、「パラメーターの説明」をご参照ください。

フォーマット:JSON 配列

例:

[
   {
   "module": "07",
   "name": "selectdb.reservoir.group.by.target.schema",
   "value": true
   }
]

表 2. サブスクリプションインスタンス

パラメーター

必須

説明

vpcId

はい

サブスクリプションインスタンスが存在する Virtual Private Cloud (VPC) の ID。

vswitchId

はい

サブスクリプションインスタンスの vSwitch の ID。

startTime

いいえ

データサブスクリプションの開始時刻 (UNIX タイムスタンプ、秒単位)。

endTime

いいえ

データサブスクリプションの終了時刻 (UNIX タイムスタンプ、秒単位)。

表 3. Cloud Enterprise Network (CEN) 経由で接続されたデータベースインスタンス

パラメーター

必須

説明

srcInstanceId

いいえ

ソースインスタンスの CEN インスタンスの ID。例:

{
   "srcInstanceId": "cen-9kqshqum*******"  }
説明

ソースデータベースインスタンスが CEN 経由で接続されている場合にこのパラメーターを設定します。

destInstanceId

いいえ

宛先インスタンスの CEN インスタンスの ID。例:

{
   "destInstanceId": "cen-9kqshqum*******"  }
説明

宛先データベースインスタンスが CEN 経由で接続されている場合にこのパラメーターを設定します。

ソースデータベースのパラメーター設定

ソースデータベースのタイプに基づいて、Reserve パラメーター内のパラメーターを設定します。

表 4. ソースデータベースタイプ:MySQL (RDS MySQL および自己管理 MySQL を含む)

パラメーター

設定条件

説明

privilegeMigration

ソースデータベースとターゲットデータベースの両方が RDS for MySQL の場合に適用されます。

アカウントを移行するかどうかを指定します。有効値:

  • true:アカウントを移行します。

  • false (デフォルト):アカウントを移行しません。

privilegeDbList

移行アカウントに関する情報。パラメーターの形式については、「OpenAPI リクエストパラメーターのプレビュー」をご参照ください。例:

[{\"user\":\"user1\",\"host\":\"%\",\"oldHost\":\"%\",\"is_migrate\":true},{\"user\":\"user2\",\"host\":\"%\",\"oldHost\":\"%\",\"is_migrate\":true}]

definer

データベースオブジェクトの元の definer を保持するかどうかを指定します。値は true または false です。

amp.increment.generator.logmnr.mysql.heartbeat.mode

ソースデータベースが自己管理 MySQL の場合。

フォワードタスクとリバースタスクのハートビートテーブル SQL ステートメントを削除するかどうかを指定します。有効値:

  • none:ソースデータベースにハートビート SQL 情報を書き込みません。

  • N:ソースデータベースにハートビート SQL 情報を書き込みます。

whitelist.dms.online.ddl.enable

ターゲットデータベースが MySQL (RDS for MySQL および自己管理 MySQL を含む)、PolarDB for MySQLAnalyticDB for MySQL、または AnalyticDB for PostgreSQL である同期または移行インスタンスの場合。

これら 6 つのパラメーターを一緒に使用して、オンライン DDL ツールがソーステーブルで実行されたときに生成される一時テーブルをターゲットデータベースにコピーするかどうかを制御します。

  • ソーステーブルでのオンライン DDL 変更によって作成された一時テーブルからデータをコピーするには:

    {
       "whitelist.dms.online.ddl.enable": "true",
         "sqlparser.dms.original.ddl": "false",
         "whitelist.ghost.online.ddl.enable": "true",
         "sqlparser.ghost.original.ddl": "false"
    }
  • オンライン DDL 変更によって作成された一時テーブルからデータをコピーしません。代わりに、DMS がソースデータベースで実行した元の DDL ステートメントのみを同期します:

    {
       "whitelist.dms.online.ddl.enable": "false",
         "sqlparser.dms.original.ddl": "true",
         "whitelist.ghost.online.ddl.enable": "false",
         "sqlparser.ghost.original.ddl": "false"
    }
  • オンライン DDL 変更によって作成された一時テーブルからデータをコピーしません。代わりに、gh-ost がソースデータベースで実行した元の DDL ステートメントのみを同期します:

    {
       "whitelist.dms.online.ddl.enable": "false",
         "sqlparser.dms.original.ddl": "false",
         "whitelist.ghost.online.ddl.enable": "false",
         "sqlparser.ghost.original.ddl": "true",
         "online.ddl.shadow.table.rule": "^_(.+)_(?:gho|new)$",
         "online.ddl.trash.table.rule": "^_(.+)_(?:ghc|del|old)$"
    }
    説明

    gh-ost シャドウテーブル (online.ddl.shadow.table.rule) とゴミ箱テーブル (online.ddl.trash.table.rule) には、デフォルトの正規表現を使用するか、カスタムの正規表現を設定します。

sqlparser.dms.original.ddl

whitelist.ghost.online.ddl.enable

sqlparser.ghost.original.ddl

online.ddl.shadow.table.rule

online.ddl.trash.table.rule

isAnalyzer

このパラメーターは、ソースインスタンスと宛先インスタンスの両方が MySQL データベースである場合にのみ有効です。これには、RDS MySQL と自己管理 MySQL が含まれます。

移行評価機能を有効にするかどうかを指定します。この機能は、ソースデータベースとターゲットデータベースの構造が要件を満たしているかどうかを評価します。値は true または false です。

srcSSL

接続タイプがクラウドインスタンスまたは ECS 自己管理データベースの場合に必須です。

ソースデータベースの接続メソッド。有効値:

  • 0:非暗号化接続。

  • 1:SSL 暗号化接続。

表 5. ソースデータベースタイプ:PolarDB for MySQL

パラメーター

条件

説明

amp.increment.generator.logmnr.mysql.heartbeat.mode

必須

フォワードタスクとリバースタスクのハートビートテーブル SQL ステートメントを削除するかどうかを指定します。有効値:

  • none:ソースデータベースにハートビート SQL 情報を書き込みません。

  • N:ソースデータベースにハートビート SQL 情報を書き込みます。

whitelist.dms.online.ddl.enable

同期または移行タスクで、ターゲットデータベースが MySQL (RDS for MySQL および自己管理 MySQL を含む)、PolarDB for MySQLAnalyticDB for MySQL、または AnalyticDB for PostgreSQL の場合。

これら 6 つのパラメーターを一緒に使用して、オンライン DDL ツールがソーステーブルで実行されたときに生成される一時テーブルをターゲットデータベースにレプリケーションするかどうかを制御する必要があります。

  • ソーステーブルでのオンライン DDL 変更によって生成された一時テーブルからデータをレプリケーションするには:

    {
       "whitelist.dms.online.ddl.enable": "true",
         "sqlparser.dms.original.ddl": "false",
         "whitelist.ghost.online.ddl.enable": "true",
         "sqlparser.ghost.original.ddl": "false"
    }
  • ソースデータベースで DMS によって実行された元の DDL データのみを同期し、オンライン DDL 変更によって生成された一時テーブルからデータをレプリケーションしないようにするには:

    {
       "whitelist.dms.online.ddl.enable": "false",
         "sqlparser.dms.original.ddl": "true",
         "whitelist.ghost.online.ddl.enable": "false",
         "sqlparser.ghost.original.ddl": "false"
    }
  • ソースデータベースで gh-ost によって実行された元の DDL データのみを同期し、オンライン DDL 変更によって生成された一時テーブルからデータをレプリケーションしないようにするには:

    {
       "whitelist.dms.online.ddl.enable": "false",
         "sqlparser.dms.original.ddl": "false",
         "whitelist.ghost.online.ddl.enable": "false",
         "sqlparser.ghost.original.ddl": "true",
         "online.ddl.shadow.table.rule": "^_(.+)_(?:gho|new)$",
         "online.ddl.trash.table.rule": "^_(.+)_(?:ghc|del|old)$"
    }
    説明

    gh-ost シャドウテーブル (online.ddl.shadow.table.rule) とゴミ箱テーブル (online.ddl.trash.table.rule) には、デフォルトの正規表現を使用するか、独自の正規表現を設定します。

sqlparser.dms.original.ddl

whitelist.ghost.online.ddl.enable

sqlparser.ghost.original.ddl

online.ddl.shadow.table.rule

online.ddl.trash.table.rule

表 6. ソースデータベースタイプ:RDS MariaDB

パラメーター

条件

説明

srcSSL

接続タイプがクラウドインスタンスまたは ECS 上の自己管理データベースの場合。

ソースデータベースの接続メソッド。有効値:

  • 0:非暗号化接続。

  • 1:SSL 暗号化接続。

表 7. ソースデータベースタイプ:Oracle

パラメーター

設定条件

説明

isTargetDbCaseSensitive

ターゲットデータベースが AnalyticDB for PostgreSQL の場合に必須です。

宛先オブジェクトに引用符を追加するかどうかを指定します。有効値は truefalse です。

isNeedAddRowId

ターゲットデータベースが AnalyticDB for PostgreSQL であり、同期または移行の対象オブジェクトにプライマリキーのないテーブルが含まれる場合に必須です。

プライマリキーのないすべてのテーブルに対して、ROWID をプライマリキーおよび分散キーとして設定するかどうかを指定します。有効値は truefalse です。

srcOracleType

必須

Oracle インスタンスのタイプ。有効値:

  • sid:非 RAC インスタンス。

  • serviceName:Real Application Clusters (RAC) またはプラガブルデータベース (PDB) インスタンス。

source.column.encoding

ビジネスの書き込みエンコーディングを指定するために必須です。

ビジネスの書き込みエンコーディング。サポートされているエンコーディング:

  • default (デフォルト)

  • GB 2312

  • GBK

  • GB 18030

  • UTF-8

  • UTF-16

  • UTF-32

表 8. ソースデータベースタイプ:SQL Server (ApsaraDB RDS for SQL Server および自己管理 SQL Server を含む)

パラメーター

設定条件

説明

isTargetDbCaseSensitive

ターゲットデータベースが AnalyticDB for PostgreSQL の場合。

宛先オブジェクトに引用符を追加するかどうかを指定します。有効値は truefalse です。

source.extractor.type

ターゲットデータベースが DataHub ではなく、増分タスクが設定されている場合に必須です。

SQL Server の増分同期または移行のモード。有効値は次のとおりです:

  • cdc:非ヒープテーブルの増分同期または移行にはログ解析を使用し、ヒープテーブルには変更データキャプチャ (CDC) を使用します。

  • log:ソースデータベースのログを解析して増分同期または移行を行います。

src.sqlserver.schema.mapper.mode

ターゲットデータベースが MySQL (ApsaraDB RDS for MySQL および自己管理 MySQL を含む)、PolarDB for MySQL、または AnalyticDB for MySQL の場合。

ソースデータベースとターゲットデータベース間の構造マッピングモード。有効値は次のとおりです:

  • schema.table:ソースデータベースの SchemaName.TableName を宛先テーブルの名前として使用します。

  • without.schema:ソースデータベースのテーブル名を宛先テーブルの名前として使用します。

    警告

    ソースデータベースの複数のスキーマに同じ名前のテーブルが存在する場合、データ不整合やタスクの失敗が発生する可能性があります。

表 9. ソースデータベースタイプ:Tair/Redis

説明

これには、Alibaba Cloud Tair (Redis 互換) および自己管理 Redis が含まれます。

パラメーター

設定条件

説明

srcKvStoreMode

データベースインスタンスの接続タイプが Alibaba Cloud インスタンス ではない場合に必須です。

ソースの自主管理 Redis データベースのインスタンスパターン。有効値:

  • single:Basic Edition。

  • cluster:Cluster Edition。

any.sink.redis.expire.extension.seconds

必須

キーがソースデータベースからターゲットデータベースに移行される際の、生存時間 (TTL) を延長する追加の時間 (秒単位)。データ整合性を確保するため、次のようなコマンドを使用する場合は、延長 TTL を 600 秒以上に設定します。

EXPIRE key seconds
PEXPIRE key milliseconds
EXPIREAT key timestamp
PEXPIREAT key timestampMs

any.source.redis.use.slave.node

srcKvStoreModecluster に設定されている場合に必須です。

スレーブノードからデータをプルするかどうかを指定します。有効値:

  • true:スレーブノードからデータをプルします。

  • false (デフォルト):マスターノードからデータをプルします。

表 10. ソースデータベースタイプ:MongoDB (ApsaraDB for MongoDB および自己管理 MongoDB を含む)

パラメーター

条件

説明

srcEngineArchType

必須

ソース MongoDB データベースのアーキテクチャ。有効値:

  • 0:シングルノードアーキテクチャ。

  • 1:レプリカセットアーキテクチャ。

  • 2:シャードクラスターアーキテクチャ。

sourceShardEndpointUsername

srcEngineArchType2 に設定されている場合に必須です。

ソース MongoDB データベースのシャードのユーザー名。

sourceShardEndpointPassword

ソース MongoDB データベースのシャードのパスワード。

表 11. ソースデータベースタイプ:PolarDB-X 2.0

パラメーター

設定条件

説明

amp.increment.generator.logmnr.mysql.heartbeat.mode

必須

フォワードタスクとリバースタスクのハートビート SQL ステートメントを書き込むかどうかを指定します。有効値:

  • none:ソースデータベースにハートビート SQL 情報を書き込みません。

  • N:ソースデータベースにハートビート SQL 情報を書き込みます。

表 12. ソースデータベースタイプ:PolarDB for PostgreSQL (Oracle 互換)

パラメーター

条件

説明

srcHostPortCtl

接続タイプがパブリック IP アドレスの場合。

PolarDB for PostgreSQL (Oracle 互換) に単一ソースを使用するか複数ソースを使用するかを指定します。有効値:

  • single単一のデータソース

  • multiple複数のデータソース

srcHostPorts

srcHostPortCtlmultiple に設定されている場合。

ソース PolarDB for PostgreSQL (Oracle 互換) ノードの IP アドレスとポート番号。複数の IP:Port ペアはカンマで区切ります。

表 13. ソースデータベースタイプ:TiDB

パラメーター

設定条件

説明

amp.increment.generator.logmnr.mysql.heartbeat.mode

必須

フォワードタスクとリバースタスクからハートビートテーブルの SQL を削除するかどうかを指定します:

  • none:ソースデータベースにハートビート SQL ステートメントを書き込みません。

  • N:ソースデータベースにハートビート SQL ステートメントを書き込みます。

isIncMigration

必須

増分移行を実行するかどうかを指定します。有効値は yes または no です。

重要

同期タスクは yes のみをサポートします。

srcKafka

isIncMigrationyes に設定されている場合に必須です。

TiDB の下流にある Kafka クラスターに関する情報。

taskType

Kafka クラスターのタイプ。Kafka クラスターのデプロイメント場所に基づいてタイプを選択します。有効値:

  • EXPRESS:専用線 / VPN Gateway / Smart Gateway。

  • ECS:ECS インスタンスでホストされている自己管理データベース。

bisId

  • taskTypeECS に設定されている場合、このパラメーターは ECS インスタンスの ID を指定します。

  • taskTypeEXPRESS に設定されている場合、このパラメーターはソースデータベースに接続されている VPC の ID を指定します。

port

Kafka クラスターのサービスポート。

user

Kafka クラスターのユーザー名。Kafka クラスターで認証が無効になっている場合は、この項目を空のままにします。

passwd

Kafka クラスターのパスワード。Kafka クラスターで認証が無効になっている場合は、この項目を空のままにします。

version

Kafka クラスターのバージョン。

ssl

Kafka クラスターの接続メソッド。有効値:

  • 0:プレーンテキスト接続。

  • 3:SCRAM-SHA-256 を使用した暗号化接続。

topic

移行または同期するオブジェクトを含むトピック。

host

taskTypeEXPRESS に設定されている場合に必須です。

Kafka クラスターの IP アドレス。

vpcId

taskTypeECS に設定されている場合に必須です。

ECS インスタンスが存在する VPC。

ターゲットデータベースのパラメーター設定

ターゲットデータベースのタイプに基づいて、Reserve パラメーター内のパラメーターを設定します。

表 14. ターゲットデータベースタイプ:MySQL (RDS for MySQL および自己管理 MySQL を含む)

パラメーター

設定条件

説明

privilegeMigration

ソースデータベースとターゲットデータベースの両方のタイプが RDS for MySQL の場合。詳細については、「ソースデータベースタイプは MySQL (RDS for MySQL および自己管理 MySQL を含む)」をご参照ください。

アカウントを移行するかどうかを指定します。

privilegeDbList

移行するアカウントに関する情報。

definer

データベースオブジェクトの元の definer を保持するかどうかを指定します。

whitelist.dms.online.ddl.enable

ソースデータベースタイプが MySQL (RDS for MySQL および自己管理 MySQL を含む) または PolarDB for MySQL で、インスタンスが同期または移行用の場合。詳細については、「ソースデータベースのパラメーター設定」をご参照ください。

これら 6 つのパラメーターは一緒に使用する必要があります。これらは、ソーステーブルのオンライン DDL ツールによって生成された一時テーブルをターゲットデータベースにレプリケーションするかどうかを制御します。

sqlparser.dms.original.ddl

whitelist.ghost.online.ddl.enable

sqlparser.ghost.original.ddl

online.ddl.shadow.table.rule

online.ddl.trash.table.rule

isAnalyzer

ソースインスタンスと宛先インスタンスの両方のデータベースタイプが MySQL (RDS for MySQL および自己管理 MySQL を含む) の場合。

ソースデータベースとターゲットデータベースの構造が要件を満たしているかどうかを評価するために、移行評価機能を有効にするかどうかを指定します。有効値は truefalse です。

triggerMode

必須

ソースデータベースからトリガーを移行するメソッド。有効値:

  • manual:トリガーを手動で移行します。

  • auto:トリガーを自動的に移行します。

説明

詳細については、「トリガーを同期または移行するメソッドの設定」をご参照ください。

destSSL

接続タイプがクラウドインスタンスまたは ECS ホストの自己管理データベースの場合。

ターゲットデータベースの接続メソッド。有効値:

  • 0:非暗号化接続。

  • 1:SSL セキュア接続。

src.sqlserver.schema.mapper.mode

ソースデータベースタイプが SQL Server (RDS for SQL Server および自己管理 SQL Server を含む) の場合。

ソースデータベースとターゲットデータベース間の構造マッピングモード。詳細については、「ソースデータベースタイプは SQL Server (RDS for SQL Server および自己管理 SQL Server を含む)」をご参照ください。

表 15. ターゲットデータベースタイプ:PolarDB for MySQL

パラメーター

設定条件

説明

whitelist.dms.online.ddl.enable

ソースデータベースタイプが MySQL (RDS for MySQL および自己管理 MySQL を含む) または PolarDB for MySQL で、インスタンスが同期または移行用の場合。詳細については、「ソースデータベースのパラメーター設定」をご参照ください。

これら 6 つのパラメーターは一緒に使用する必要があります。これらは、ソーステーブルのオンライン DDL ツールによって生成された一時テーブルをターゲットデータベースにレプリケーションするかどうかを制御します。

sqlparser.dms.original.ddl

whitelist.ghost.online.ddl.enable

sqlparser.ghost.original.ddl

online.ddl.shadow.table.rule

online.ddl.trash.table.rule

anySinkTableEngineType

必須

PolarDB for MySQL インスタンスのエンジンタイプ。有効値:

  • innodb:デフォルトのストレージエンジン。

  • xengine:オンライン・トランザクション・プロセッシング (OLTP) データベースストレージエンジン。

triggerMode

必須

ソースデータベースからトリガーを移行するメソッド。有効値:

  • manual:トリガーを手動で移行します。

  • auto:トリガーを自動的に移行します。

説明

詳細については、「トリガーを同期または移行するメソッドの設定」をご参照ください。

src.sqlserver.schema.mapper.mode

ソースデータベースタイプが SQL Server (RDS for SQL Server および自己管理 SQL Server を含む) の場合。

ソースデータベースとターゲットデータベース間の構造マッピングモード。詳細については、「ソースデータベースタイプは SQL Server (RDS for SQL Server および自己管理 SQL Server を含む)」をご参照ください。

表 16. ターゲットデータベースタイプ:AnalyticDB for MySQL

パラメーター

設定条件

説明

whitelist.dms.online.ddl.enable

ソースデータベースタイプが MySQL (RDS for MySQL および自己管理 MySQL を含む) または PolarDB for MySQL で、インスタンスが同期または移行用の場合。詳細については、「ソースデータベースのパラメーター設定」をご参照ください。

これら 6 つのパラメーターは一緒に使用する必要があります。これらは、ソーステーブルのオンライン DDL ツールによって生成された一時テーブルをターゲットデータベースにレプリケーションするかどうかを制御します。

sqlparser.dms.original.ddl

whitelist.ghost.online.ddl.enable

sqlparser.ghost.original.ddl

online.ddl.shadow.table.rule

online.ddl.trash.table.rule

triggerMode

必須

ソースデータベースからトリガーを移行するメソッド。有効値:

  • manual:トリガーを手動で移行します。

  • auto:トリガーを自動的に移行します。

説明

詳細については、「トリガーを同期または移行するメソッドの設定」をご参照ください。

src.sqlserver.schema.mapper.mode

ソースデータベースタイプが SQL Server (RDS for SQL Server および自己管理 SQL Server を含む) の場合。

ソースデータベースとターゲットデータベース間の構造マッピングモード。詳細については、「ソースデータベースタイプは SQL Server (RDS for SQL Server および自己管理 SQL Server を含む)」をご参照ください。

traceDatasource

必須

複数テーブルのマージを有効にするかどうかを指定します。有効値は truefalse です。

tagColumnValue

タグ列をカスタマイズするかどうかを設定する場合。

__dts_data_source タグ列をカスタマイズするかどうかを指定します。有効値:

  • tagColumnValue:タグ列をカスタマイズします。

    重要

    DbList パラメーターでタグ列の値も設定する必要があります。詳細については、「移行、同期、またはサブスクリプションのオブジェクトの説明」をご参照ください。

  • notTagColumnValue:タグ列をカスタマイズしません。

    重要

    現在、購入後に設定されたインスタンスのみがカスタムタグ列をサポートしています。

adsSqlType

インスタンスレベルで増分同期または移行の SQL 操作を選択する必要がある場合。

インスタンスレベルで増分同期または移行の SQL 操作を選択します。複数の SQL 操作はカンマで区切ります。有効値:

  • insert

  • update

  • delete

  • alterTable

  • truncateTable

  • createTable

  • dropTable

表 17. ターゲットデータベースタイプ:AnalyticDB for PostgreSQL

パラメーター

設定条件

説明

whitelist.dms.online.ddl.enable

ソースデータベースタイプが MySQL (RDS for MySQL および自己管理 MySQL を含む) または PolarDB for MySQL で、インスタンスが同期または移行用の場合。詳細については、「ソースデータベースのパラメーター設定」をご参照ください。

これら 6 つのパラメーターは一緒に使用する必要があります。これらは、ソーステーブルのオンライン DDL ツールによって生成された一時テーブルをターゲットデータベースにレプリケーションするかどうかを制御します。

sqlparser.dms.original.ddl

whitelist.ghost.online.ddl.enable

sqlparser.ghost.original.ddl

online.ddl.shadow.table.rule

online.ddl.trash.table.rule

isTargetDbCaseSensitive

ソースデータベースタイプが MySQL (RDS for MySQL および自己管理 MySQL を含む)、Oracle、または SQL Server (RDS for SQL Server および自己管理 SQL Server を含む) の場合。

宛先オブジェクトに引用符を追加するかどうかを指定します。有効値は truefalse です。

syncOperation

インスタンスレベルで増分同期または移行の SQL 操作を選択する必要がある場合。

インスタンスレベルで増分同期または移行の SQL 操作を選択します。複数の SQL 操作はカンマで区切ります。有効値:

  • insert

  • update

  • delete

  • alterTable

  • truncateTable

  • createTable

  • dropTable

  • createDB

  • dropDB

表 18. ターゲットデータベースタイプ:RDS for MariaDB

パラメーター

設定条件

説明

triggerMode

必須

ソースデータベースからトリガーを移行するメソッド。有効値:

  • manual:トリガーを手動で移行します。

  • auto:トリガーを自動的に移行します。

説明

詳細については、「トリガーを同期または移行するメソッドの設定」をご参照ください。

destSSL

接続タイプがクラウドインスタンスまたは ECS ホストの自己管理データベースの場合。

ターゲットデータベースの接続メソッド。有効値:

  • 0:非暗号化接続。

  • 1:SSL セキュア接続。

表 19. ターゲットデータベースタイプ:MongoDB (including ApsaraDB for MongoDB and self-managed MongoDB)

パラメーター

設定条件

説明

destEngineArchType

必須

宛先 MongoDB データベースのアーキテクチャタイプ。有効値:

  • 0 :シングルノードアーキテクチャ。

  • 1:レプリカセットアーキテクチャ。

  • 2:シャードクラスターアーキテクチャ。

表 20. ターゲットデータベースタイプ:Tair/Redis

説明

これには、ApsaraDB for Tair (Redis 互換) および自己管理 Redis が含まれます。

パラメーター

設定条件

説明

destKvStoreMode

データベースインスタンスの接続タイプが Alibaba Cloud インスタンス ではない場合。

自己管理の宛先 Redis のインスタンスモード。有効値:

  • single:Basic Edition。

  • cluster:Cluster Edition。

any.sink.redis.expire.extension.seconds

必須

キーがソースからターゲットデータベースに移行される際の、追加の生存時間 (TTL) (秒単位)。データ整合性を確保するため、次のようなコマンドを使用する場合は、キーの延長 TTL を 600 秒以上に設定します。

EXPIRE key seconds
PEXPIRE key milliseconds
EXPIREAT key timestamp
PEXPIREAT key timestampMs

表 21. ターゲットデータベースタイプ:PolarDB for PostgreSQL (Oracle 互換)

パラメーター

設定条件

説明

destHostPortCtl

接続タイプがパブリック IP の場合。

PolarDB for PostgreSQL (Oracle 互換) の複数ソースデータを選択するかどうかを指定します。有効値:

  • single:これは 単一のデータソース に対応します。

  • multiple:これは 複数のデータソース に対応します。

destHostPorts

destHostPortCtlmultiple の場合。

宛先 PolarDB for PostgreSQL (Oracle 互換) ノードの IP アドレスとポート番号。複数の IP:Port ペアはカンマで区切ります。

表 22. ターゲットデータベースタイプ:Oracle

パラメーター

設定条件

説明

destOracleType

必須

Oracle インスタンスのタイプ。有効値:

  • sid:非 RAC インスタンス。

  • serviceName:RAC または PDB インスタンス。

表 23. ターゲットデータベースタイプ:DataHub

パラメーター

設定条件

説明

isUseNewAttachedColumn

必須

添付列の命名規則は次のとおりです:

  • 添付列に新しい命名規則を使用する:isUseNewAttachedColumntrue に設定します。

  • 古いアタッチ列の命名規則を使用するには、isUseNewAttachedColumnfalse に設定します。

表 24. ターゲットデータベースタイプ:MaxCompute

パラメーター

設定条件

説明

isUseNewAttachedColumn

必須

添付列の命名規則は次のとおりです:

  • 添付列に新しい命名規則を使用する:isUseNewAttachedColumntrue に設定します。

  • 古いアタッチ列の命名規則を使用する場合: isUseNewAttachedColumn[false] に設定され、。

partition

必須

増分ログテーブルのパーティション名。有効値:

  • isUseNewAttachedColumntrue の場合:

    • modifytime_year

    • modifytime_month

    • modifytime_day

    • modifytime_hour

    • modifytime_minute

  • isUseNewAttachedColumnfalse の場合:

    • new_dts_sync_modifytime_year

    • new_dts_sync_modifytime_month

    • new_dts_sync_modifytime_day

    • new_dts_sync_modifytime_hour

    • new_dts_sync_modifytime_minute

表 25. ターゲットデータベースタイプ:Elasticsearch

パラメーター

設定条件

説明

indexMapping

必須

宛先 Elasticsearch インスタンスで作成されたインデックスの名前。有効値:

  • tb:作成されたインデックス名はテーブル名と同じです。

  • db_tb:作成されたインデックス名は、データベース名、アンダースコア (_)、およびテーブル名の組み合わせです。

表 26. ターゲットデータベースタイプ:Kafka

パラメーター

設定条件

説明

destTopic

必須

移行または同期オブジェクトが属する宛先 Kafka クラスター内のトピック。

destVersion

必須

宛先 Kafka クラスターのバージョン。有効値は 1.00.9、および 0.10 です。

説明

Kafka クラスターのバージョンが 1.0 以降の場合は、1.0 と入力します。

destSSL

必須

宛先 Kafka クラスターへの接続メソッド。有効値:

  • 0:非暗号化接続。

  • 3:SCRAM-SHA-256 を使用した暗号化接続。

sink.kafka.ddl.topic

DDL 情報を保存するトピックを指定する必要がある場合。

DDL 情報を保存するために使用されるトピック。値を入力しない場合、DDL 情報はデフォルトで destTopic で指定されたトピックに保存されます。

kafkaRecordFormat

必須

宛先 Kafka クラスターに配信されるデータのストレージ形式。有効値:

  • canal_jsonCanal を使用してデータベースの増分ログを解析し、増分データを宛先 Kafka クラスターに送信します。データは Canal JSON 形式で保存されます。

  • dts_avro:データ構造やオブジェクトを保存や送信が容易な形式に変換するデータシリアル化形式。

  • shareplex_jsonShareplex データレプリケーションソフトウェアを使用してソースデータベースからデータを読み取ります。宛先 Kafka クラスターにデータを書き込む際、データは Shareplex JSON 形式で保存されます。

  • debezium:データ変更をキャプチャし、ソースデータベースから宛先 Kafka クラスターへのデータ更新のリアルタイムストリーミングをサポートするツール。

説明

フォーマットの詳細については、「メッセージキューのデータストレージ形式」をご参照ください。

destKafkaPartitionKey

必須

Kafka パーティション同期ポリシー。有効値:

  • none:すべてのデータと DDL 情報を宛先トピックのパーティション 0 に配信します。

  • database_table:データベース名とテーブル名をマージしてハッシュ計算のパーティションキーとして使用します。その後、各テーブルのデータと DDL 情報を宛先トピックの異なるパーティションに配信します。

  • columns:テーブル内の列 (デフォルトではプライマリキー、プライマリキーがない場合はユニークキー) をハッシュ計算のパーティションキーとして使用します。その後、異なる行を宛先トピックの異なるパーティションに配信します。ハッシュ計算のパーティションキーとして 1 つ以上の列を指定することもできます。

説明

パーティション同期ポリシーの詳細については、「Kafka パーティション同期ポリシー」をご参照ください。

destSchemaRegistry

必須

Kafka Schema Registry を使用するかどうかを指定します。有効値は yesno です。

destKafkaSchemaRegistryUrl

destSchemaRegistrytrue の場合。

Kafka Schema Registry に Avro スキーマを登録するための URL または IP アドレス。

表 27. ターゲットデータベースタイプ:データレイクハウス統合タスク用の OSS

パラメーター

設定条件

説明

fusionMetastoreMod

必須

宛先 OSS メタデータ (データカタログ) のストレージ場所。有効値:

  • dms:DMS に保存されます。

  • adb:AnalyticDB for MySQL 3.0 クラスターに保存されます。

  • none:なし。メタデータは保存されません。

fusionOssFilePath

必須

データストレージ用の宛先 OSS 内のディレクトリ。

fusionOssFileFormat

必須

宛先 OSS 内の統合データのフォーマット。有効値:

  • DELTA:Delta フォーマット。

  • PARQUET:Parquet フォーマット。

  • HUDI:Hudi フォーマット。

fusionAdbCrossMdsDbClusterId

fusionMetastoreModadb の場合。

宛先 OSS メタデータを保存する AnalyticDB for MySQL 3.0 クラスターの ID。

fusionAdbCrossMdsRamId

fusionMetastoreModadb の場合。

宛先 OSS メタデータを保存する AnalyticDB for MySQL 3.0 クラスターを所有する Alibaba Cloud アカウントまたは RAM ユーザーの ID。

説明

アカウントまたはユーザーは、AnalyticDB for MySQL 3.0 クラスターデータベースに対する書き込み権限を持っている必要があります。

srcConnArgs

ソースデータベースが MySQL または SQL Server の場合。

ソースデータベースの接続パラメーター (JSON 形式)。例:

"srcConnArgs": {
 "rewriteBatchedStatements": "true",
 "tinyInt1isBit": "false",
 "zeroDateTimeBehavior": "convertToNull",
 "yearIsDateType": "false"
 }

sparkExtraArgs

Spark タスクパラメーターを設定する場合。

Spark タスクパラメーター (JSON 形式)。例:

 "sparkExtraArgs": {
 "spark.executor.extraJavaOptions": "-verbose:class",
 "spark.driver.extraJavaOptions": "-verbose:class"
 }