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

Data Transmission Service:Reserve パラメーターリファレンス

最終更新日:Aug 22, 2026

特定の API を呼び出して移行、同期、または追跡タスクを設定またはクエリする場合、Reserve パラメーターを使用する必要があります。Reserve は JSON 形式の文字列型パラメーターです。これを使用して、ソースインスタンスまたはターゲットインスタンスの設定詳細を完了または表示します。たとえば、ターゲット Kafka クラスターのデータストレージ形式や、Cloud Enterprise Network (CEN) インスタンスのインスタンス ID を指定できます。このトピックでは、Reserve パラメーターのシナリオと設定オプションについて説明します。

注意事項

  • ご利用の DTS インスタンスタイプとデータベース接続方法に基づいて共通パラメーターを設定できます。その後、ソースデータベースとターゲットデータベースのタイプ、および実際の要件に基づいて他のパラメーターを設定できます。

  • ご利用の DTS インスタンスのソースデータベースとターゲットデータベースの両方に同じパラメーターが適用される場合は、一度だけ設定すればよく、設定を繰り返す必要はありません。

  • 数値を渡す場合は、二重引用符 ("") で囲んで文字列に変換してください。

  • コンソールで設定を事前構成し、対応する OpenAPI リクエストパラメーターをプレビューすることで、リクエストパラメーターの入力を補助できます。詳細については、「OpenAPI リクエストパラメーターのプレビュー」をご参照ください。

関連 API

共通パラメーター

ご利用の DTS インスタンスタイプとデータベース接続方法に基づいて、Reserve でこれらのパラメーターを設定できます。

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

パラメーター

必須

説明

targetTableMode

はい

ターゲットデータベースに既存のテーブルがある場合の処理方法:

  • 0:事前チェックを実行し、エラーが発生した場合は操作をブロックします。

  • 2:エラーを無視して操作を続行します。

dts.datamove.source.bps.max

いいえ

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

説明

このパラメーターは 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 機能を有効にします。

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

etlOperatorSetting

いいえ

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

etlOperatorColumnReference

いいえ

T+1 ビジネスで使用されるフィールド。ETL オペレーターです。

configKeyMap

いいえ

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

syncArchitecture

いいえ

同期トポロジ。有効な値:

  • oneway:一方向同期。

  • bidirectional:双方向同期。

dataCheckConfigure

いいえ

データ検証の設定。詳細については、「DataCheckConfigure パラメーターリファレンス」をご参照ください。

dbListCaseChangeMode

いいえ

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

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

  • source:ソースデータベースの大文字と小文字に合わせます。

  • dest_upper:大文字を使用し、ターゲットデータベースのデフォルトポリシーに合わせます。

  • dest_lower:小文字を使用し、ターゲットデータベースのデフォルトポリシーに合わせます。

maxRetryTime

いいえ

ソースまたはターゲットデータベースへの接続に失敗した後の再試行時間 (秒)。この失敗は、ネットワークの問題やロック待ちなど、予期されるものです。有効な値:600 から 86400 までの整数。デフォルト:43200 秒 (720 分)。少なくとも 1800 秒 (30 分) に設定することを推奨します。

retry.blind.seconds

いいえ

DDL または DML の実行エラーなど、ソースまたはターゲットデータベースで予期しない障害が発生した後の再試行時間 (秒)。有効な値:60 から 86340 までの整数。デフォルト:600 秒 (10 分)。少なくとも 600 秒 (10 分) に設定することを推奨します。

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

  • 複数の DTS インスタンスが同じデータベースに接続する場合、それらの中で最も短い再試行時間が有効になります。

modulesExtraConfiguration

いいえ

モジュール拡張設定項目。パラメーターの詳細については、「パラメーターリファレンス」をご参照ください。

形式:JSON 配列

例:

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

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

パラメーター

必須

説明

vpcId

はい

追跡インスタンスの VPC ID。

vswitchId

はい

サブスクライブされたインスタンスの vSwitch ID。

startTime

いいえ

データ追跡の開始タイムスタンプ。単位:秒。

endTime

いいえ

データサブスクリプションの終了タイムスタンプ (秒)。

表 3. Cloud Enterprise Network (CEN) を使用して接続されたデータベースインスタンス

パラメーター

必須

説明

srcInstanceId

いいえ

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

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

このパラメーターは、ソースデータベースインスタンスが接続に CEN を使用する場合にのみ設定します。

destInstanceId

いいえ

ターゲットインスタンスの CEN インスタンス ID。例:

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

このパラメーターは、ターゲットデータベースインスタンスが接続に CEN を使用する場合にのみ設定します。

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

ソースデータベースのタイプに基づいて、Reserve でこれらのパラメーターを設定できます。

表 4. ソースデータベースタイプ:MySQL (ApsaraDB RDS for MySQL およびセルフマネージド MySQL を含む)

パラメーター

条件

説明

privilegeMigration

ソースデータベースとターゲットデータベースの両方が ApsaraDB 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 (ApsaraDB RDS for MySQL およびセルフマネージド MySQL を含む)、PolarDB for MySQL、AnalyticDB 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 (ApsaraDB RDS for 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 (ApsaraDB RDS for MySQL およびセルフマネージド MySQL を含む)、PolarDB for MySQL、AnalyticDB 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

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

パラメーター

前提条件

説明

srcSSL

接続方法がクラウドインスタンスまたは ECS 上のセルフマネージドデータベースの場合。

ソースデータベースの接続方法。有効な値:

  • 0:暗号化されていない接続。

  • 1:SSL セキュア接続。

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

パラメーター

条件

説明

isTargetDbCaseSensitive

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

ターゲットオブジェクトを引用符で囲むかどうか。有効な値:true または false。

isNeedAddRowId

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

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

srcOracleType

必須

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

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

  • serviceName: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 の場合。

ターゲットオブジェクトを引用符で囲むかどうか。有効な値:true または false。

source.extractor.type

ターゲットデータベースが DataHub ではなく、タスクに増分操作が含まれる場合。

SQL Server の増分同期または移行のモード。有効な値:

  • cdc:非ヒープテーブルにはログ解析を使用し、ヒープテーブルには Change Data Capture (CDC) を使用します。

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

src.sqlserver.schema.mapper.mode

ターゲットデータベースタイプが MySQL (ApsaraDB RDS for MySQL およびセルフマネージド MySQL を含む)、PolarDB for MySQL、または AnalyticDB for MySQL の場合。

ソースデータベースとターゲットデータベース間のスキーママッピングモード。有効な値:

  • schema.table:ソースデータベースの Schema name.Table name をターゲットテーブルの名前として使用します。

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

    警告

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

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

説明

これには、Alibaba Cloud Tair (Redis 互換) とセルフマネージド Redis が含まれます。

パラメーター

設定条件

説明

srcKvStoreMode

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

セルフマネージド Redis ソースデータベースのインスタンスモード。有効な値:

  • シングル: Basic Edition。

  • cluster:Cluster Edition。

any.sink.redis.expire.extension.seconds

必須

キーがソースからターゲットデータベースに移行されるときに追加される追加の生存時間 (TTL) (秒)。データ整合性を確保するため、次のいずれかのコマンドを使用する場合は、この値を少なくとも 600 秒に設定することを推奨します。

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

any.source.redis.use.slave.node

srcKvStoreMode が cluster の場合。

セルフマネージド Redis ソースデータベースがクラスターモードの場合、マスターノードまたはスレーブノードからデータをプルするかどうかを選択します。有効な値:

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

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

表 10. ソースデータベースタイプ:MongoDB (ApsaraDB for MongoDB およびセルフマネージド MongoDB を含む)

パラメーター

設定要件

説明

srcEngineArchType

必須

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

  • 0 :スタンドアロンインスタンス。

  • 1:ReplicaSet。

  • 2:シャードクラスター。

sourceShardEndpointUsername

srcEngineArchType が 2 の場合。

ソース 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 互換) の複数ソースデータを選択するかどうか。有効な値:

  • 単一: 単一のデータソース。

  • 複数: 複数のデータソース。

srcHostPorts

srcHostPortCtl が multiple の場合。

ソース 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

isIncMigration が yes の場合。

TiDB ダウンストリームの Kafka 情報。

taskType

Kafka クラスタータイプ。Kafka がデプロイされている場所に基づいて選択します。有効な値:

  • EXPRESS:リース回線、VPN Gateway、または Smart Access Gateway。

  • ECS:ECS 上のセルフマネージドデータベース。

bisId

  • taskType が ECS の場合、これは ECS インスタンス ID です。

  • taskType が EXPRESS の場合、これはソースデータベースに接続されている VPC ID です。

port

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

user

Kafka クラスターアカウント。Kafka 認証が無効な場合は空白のままにします。

passwd

Kafka クラスターのパスワード。Kafka 認証が無効な場合は空白のままにします。

version

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

ssl

Kafka クラスターの接続方法。有効な値:

  • 0:暗号化されていない接続。

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

topic

移行または同期オブジェクトのトピック。

host

taskType が EXPRESS の場合。

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

vpcId

taskType が ECS の場合。

ECS インスタンスの VPC。

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

ターゲットデータベースのタイプに基づいて、Reserve でこれらのパラメーターを設定できます。

表 14. ターゲットデータベースタイプ:MySQL (ApsaraDB RDS for MySQL およびセルフマネージド MySQL を含む)

パラメーター

条件

説明

privilegeMigration

ソースデータベースとターゲットデータベースの両方が ApsaraDB RDS for MySQL の場合。詳細については、「ソースデータベースタイプ:MySQL (ApsaraDB RDS for MySQL およびセルフマネージド MySQL を含む)」をご参照ください。

アカウントを移行するかどうか。

privilegeDbList

アカウント移行情報。

definer

データベースオブジェクトの元の Definer を保持するかどうか。

whitelist.dms.online.ddl.enable

ソースデータベースタイプが MySQL (RDS 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 (ApsaraDB RDS for MySQL およびセルフマネージド MySQL を含む) の場合。

ソースデータベースとターゲットデータベースの構造が要件を満たしているかを確認するための移行評価を有効にするかどうか。有効な値:true または false。

triggerMode

必須

ソースデータベースのトリガー移行方法。有効な値:

  • manual:手動移行。

  • auto:自動移行。

説明

詳細については、「同期または移行のトリガー移行方法の設定」をご参照ください。

destSSL

接続方法がクラウドインスタンスまたは ECS 上のセルフマネージドデータベースの場合。

ターゲットデータベースの接続方法。有効な値:

  • 0:暗号化されていない接続。

  • 1:SSL セキュア接続。

src.sqlserver.schema.mapper.mode

ソースデータベースが SQL Server (ApsaraDB RDS for SQL Server およびセルフマネージド SQL Server を含む) の場合。

ソースデータベースとターゲットデータベース間のスキーママッピングモード。詳細については、「ソースデータベースタイプ:SQL Server (ApsaraDB RDS for SQL Server およびセルフマネージド SQL Server を含む)」をご参照ください。

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

パラメーター

前提条件

説明

whitelist.dms.online.ddl.enable

ソースデータベースが MySQL (ApsaraDB 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 (ApsaraDB RDS for SQL Server およびセルフマネージド SQL Server を含む) の場合。

ソースデータベースとターゲットデータベース間のスキーママッピングモード。詳細については、「ソースデータベースタイプ:SQL Server (ApsaraDB RDS for SQL Server およびセルフマネージド SQL Server を含む)」をご参照ください。

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

パラメーター

条件

説明

whitelist.dms.online.ddl.enable

ソースデータベースが MySQL (ApsaraDB 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 (ApsaraDB RDS for SQL Server およびセルフマネージド SQL Server を含む) の場合。

ソースデータベースとターゲットデータベース間のスキーママッピングモード。詳細については、「ソースデータベースタイプ:SQL Server (ApsaraDB RDS for SQL Server およびセルフマネージド SQL Server を含む)」をご参照ください。

traceDatasource

必須

複数テーブルのマージを有効にするかどうか。有効な値:true または false。

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 (ApsaraDB 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 (ApsaraDB RDS for MySQL およびセルフマネージド MySQL を含む)、Oracle、または SQL Server (ApsaraDB RDS for SQL Server およびセルフマネージド SQL Server を含む) の場合。

ターゲットオブジェクトを引用符で囲むかどうか。有効な値:true または false。

syncOperation

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

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

  • insert

  • update

  • delete

  • alterTable

  • truncateTable

  • createTable

  • dropTable

  • createDB

  • dropDB

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

パラメーター

設定条件

説明

triggerMode

必須

ソースデータベースのトリガー移行方法。有効な値:

  • manual:手動移行。

  • auto:自動移行。

説明

詳細については、「同期または移行のトリガー移行方法の設定」をご参照ください。

destSSL

接続方法がクラウドインスタンスまたは ECS 上のセルフマネージドデータベースの場合。

ターゲットデータベースの接続方法。有効な値:

  • 0:暗号化されていない接続。

  • 1:SSL セキュア接続。

表 19. ターゲットデータベースタイプ:MongoDB (ApsaraDB for MongoDB およびセルフマネージド MongoDB を含む)

パラメーター

条件

説明

destEngineArchType

必須

ターゲット MongoDB データベースのアーキテクチャタイプ。有効な値:

  • 0 :スタンドアロンインスタンス。

  • 1:ReplicaSet。

  • 2:シャードクラスター。

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

説明

これには、Alibaba Cloud Tair (Redis 互換) とセルフマネージド Redis が含まれます。

パラメーター

前提条件

説明

destKvStoreMode

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

セルフマネージド Redis ターゲットデータベースのインスタンスモード。有効な値:

  • single:Basic Edition。

  • cluster:Cluster Edition。

any.sink.redis.expire.extension.seconds

必須

キーがソースからターゲットデータベースに移行されるときに追加される追加の生存時間 (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 互換) の複数ソースデータを選択するかどうか。有効な値:

  • 単一: 単一のデータソース。

  • 複数:複数のデータソース。

destHostPorts

destHostPortCtl が multiple の場合。

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

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

パラメーター

条件

説明

destOracleType

必須

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

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

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

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

パラメーター

設定条件

説明

isUseNewAttachedColumn

必須

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

  • 新しい命名規則を使用する:isUseNewAttachedColumn を true に設定します。

  • 古い命名ルールを使用する: isUseNewAttachedColumn を false に設定します。

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

パラメーター

条件

説明

isUseNewAttachedColumn

必須

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

  • 新しい命名規則を使用する:isUseNewAttachedColumn を true に設定します。

  • 古い命名規則を使用: isUseNewAttachedColumn を false に設定します。

partition

必須

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

  • isUseNewAttachedColumn が true の場合:

    • modifytime_year

    • modifytime_month

    • modifytime_day

    • modifytime_hour

    • modifytime_minute

  • isUseNewAttachedColumn が false の場合:

    • 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.0、0.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_json:Canal を使用してデータベースの増分ログを解析し、増分データをターゲット Kafka クラスターに配信します。データストレージ形式は Canal JSON です。

  • dts_avro:データ構造やオブジェクトをストレージや送信に適した形式に変換するデータシリアル化形式。

  • shareplex_json:データレプリケーションソフトウェア Shareplex を使用してソースデータベースからデータを読み取り、ターゲット Kafka クラスターに書き込みます。データストレージ形式は Shareplex JSON です。

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

説明

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

destKafkaPartitionKey

必須

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

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

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

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

説明

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

destSchemaRegistry

必須

Kafka Schema Registry を使用するかどうか。有効な値:yes または no。

destKafkaSchemaRegistryUrl

destSchemaRegistry が true の場合。

Avro スキーマが Kafka Schema Registry に登録されている 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

fusionMetastoreMod が adb の場合。

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

fusionAdbCrossMdsRamId

fusionMetastoreMod が adb の場合。

ターゲット 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"
 }