Todos os produtos
Search
Central de documentação

Data Transmission Service:Referência do parâmetro Reserve

Última atualização: Aug 21, 2026

Ao configurar ou consultar tarefas de migração, sincronização ou rastreamento por meio de determinadas APIs, use o parâmetro Reserve. Trata-se de um parâmetro do tipo string no formato JSON, usado para definir ou visualizar detalhes de configuração das instâncias de origem ou destino. Por exemplo, especifique o formato de armazenamento de dados de um cluster Kafka de destino ou o ID de uma instância do Cloud Enterprise Network (CEN). Este tópico descreve os cenários de uso e as opções de configuração do parâmetro Reserve.

Observações importantes

  • Configure os parâmetros comuns com base no tipo da sua instância DTS e no método de conexão do banco de dados. Em seguida, defina os demais parâmetros conforme os tipos de banco de dados de origem e destino e suas necessidades específicas.

  • Caso um mesmo parâmetro se aplique tanto ao banco de dados de origem quanto ao de destino na sua instância DTS, configure-o apenas uma vez. Evite repetir a configuração.

  • Ao informar um valor numérico, envolva-o entre aspas duplas ("") para convertê-lo em string.

  • Para facilitar o preenchimento dos parâmetros de solicitação, pré-configure as definições no console e visualize os parâmetros correspondentes da OpenAPI. Para mais informações, consulte Preview OpenAPI request parameters.

APIs relacionadas

Parâmetros comuns

Defina estes parâmetros no Reserve de acordo com o tipo da instância DTS e o método de conexão do banco de dados.

Tabela 1. Instâncias de migração ou sincronização

Parâmetro

Obrigatório

Descrição

targetTableMode

Sim

Como tratar uma tabela existente no banco de dados de destino:

  • 0: Executa uma pré-verificação e bloqueia a operação se ocorrer um erro.

  • 2: Ignora erros e continua a operação.

dts.datamove.source.bps.max

Não

Quantidade máxima de dados a serem sincronizados ou migrados por segundo em tarefas completas ou incrementais. Unidade: B (byte).

Nota

Use este parâmetro com fullDynamicConfig ou incDynamicConfig. Por exemplo, ao chamar uma API, envie {"fullDynamicConfig": {"dts.datamove.source.bps.max":10485760},"incDynamicConfig": {"dts.datamove.source.bps.max":10485760}}.

conflict

Não

Política global de resolução de conflitos para tarefas de sincronização bidirecional. Valores válidos:

  • overwrite: Sobrescreve os registros conflitantes no banco de dados de destino quando ocorre um conflito.

  • interrupt: Interrompe a tarefa de sincronização e a marca como falha ao detectar um conflito. Corrija a tarefa manualmente.

  • ignore: Ignora a instrução de sincronização atual e prossegue. Mantém o registro conflitante no banco de dados de destino.

filterDDL

Não

Define se as operações DDL devem ser filtradas nas tarefas diretas da sincronização bidirecional. Valores válidos:

  • true: Não sincroniza operações DDL.

  • false: Sincroniza operações DDL.

    Importante

    As tarefas reversas filtram automaticamente as operações DDL.

autoStartModulesAfterConfig

Não

Controla se os módulos devem ser iniciados após a configuração da tarefa. Valores válidos:

  • none: Após configurar a tarefa DTS, não inicia a pré-verificação nem outros módulos. Inicie a tarefa manualmente.

  • auto: Após configurar a tarefa DTS, inicia automaticamente o módulo de pré-verificação e todos os módulos subsequentes.

    Nota

    No cenário de compra antes da configuração, o valor padrão é auto. No cenário de configuração antes da compra, este parâmetro não tem efeito.

etlOperatorCtl

Não

Define se os recursos de ETL devem ser ativados. Valores válidos:

  • Y: Ativa os recursos de ETL.

  • N: Não configura o recurso de ETL.

etlOperatorSetting

Não

Instrução de processamento de dados ETL. Para mais informações, consulte ETL DSL syntax.

etlOperatorColumnReference

Não

Campo utilizado para negócios T+1. Funciona como um operador ETL.

configKeyMap

Não

Informações de configuração do operador ETL.

syncArchitecture

Não

Topologia de sincronização. Valores válidos:

  • oneway: Sincronização unidirecional.

  • bidirectional: Sincronização bidirecional.

dataCheckConfigure

Não

Configuração de validação de dados. Para mais informações, consulte DataCheckConfigure parameter reference.

dbListCaseChangeMode

Não

Política de diferenciação de maiúsculas e minúsculas para nomes de objetos no banco de dados de destino. Valores válidos:

  • default: Usa a política padrão do DTS.

  • source: Corresponde à capitalização do banco de dados de origem.

  • dest_upper: Usa letras maiúsculas, seguindo a política padrão do banco de dados de destino.

  • dest_lower: Usa letras minúsculas, seguindo a política padrão do banco de dados de destino.

maxRetryTime

Não

Tempo de nova tentativa, em segundos, após falha de conexão com o banco de dados de origem ou destino. Essa falha é esperada, como em casos de problemas de rede ou espera por bloqueios. Valores válidos: inteiros de 600 a 86400. Padrão: 43200 segundos (720 minutos). Recomenda-se definir pelo menos 1800 segundos (30 minutos).

retry.blind.seconds

Não

Tempo de nova tentativa, em segundos, após falhas inesperadas no banco de dados de origem ou destino, como erros de execução DDL ou DML. Valores válidos: inteiros de 60 a 86340. Padrão: 600 segundos (10 minutos). Recomenda-se definir pelo menos 600 segundos (10 minutos).

Importante
  • O valor de retry.blind.seconds deve ser menor que o de maxRetryTime.

  • Se várias instâncias DTS se conectarem ao mesmo banco de dados, prevalece o menor tempo de nova tentativa entre elas.

modulesExtraConfiguration

Não

Itens de configuração de extensão de módulo. Para detalhes dos parâmetros, consulte Parameters reference.

Formato: array JSON

Exemplo:

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

Tabela 2. Instâncias de assinatura

Parâmetro

Obrigatório

Descrição

vpcId

Sim

ID da virtual private cloud (VPC) da instância de rastreamento.

vswitchId

Sim

ID do vSwitch da instância assinada.

startTime

Não

Timestamp inicial para o rastreamento de dados. Unidade: segundos.

endTime

Não

Timestamp final da assinatura de dados, em segundos.

Tabela 3. Instâncias de banco de dados conectadas via Cloud Enterprise Network (CEN)

Parâmetro

Obrigatório

Descrição

srcInstanceId

Não

ID da instância CEN da instância de origem. Exemplo:

{
   "srcInstanceId": "cen-9kqshqum*******"  }
Nota

Configure este parâmetro apenas quando a instância de banco de dados de origem utilizar o CEN para conectividade.

destInstanceId

Não

ID da instância CEN da instância de destino. Exemplo:

{
   "destInstanceId": "cen-9kqshqum*******"  }
Nota

Configure este parâmetro apenas quando a instância de banco de dados de destino utilizar o CEN para conectividade.

Parâmetros do banco de dados de origem

Configure estes parâmetros no Reserve conforme o tipo do seu banco de dados de origem.

Tabela 4. Tipo de banco de dados de origem: MySQL (incluindo ApsaraDB RDS for MySQL e MySQL autogerenciado)

Parâmetro

Condição

Descrição

privilegeMigration

Quando os bancos de dados de origem e de destino são ApsaraDB RDS for MySQL.

Define se as contas devem ser migradas. Valores válidos:

  • true: Migra as contas.

  • false (padrão): Não migra as contas.

privilegeDbList

Informações sobre a migração de contas. Para determinar o formato correto, utilize Preview OpenAPI request parameters. Exemplo:

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

definer

Define se o Definer original dos objetos de banco de dados deve ser mantido. Valores válidos: true ou false.

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

Quando o banco de dados de origem é uma instância MySQL autogerenciada.

Define se as instruções SQL da tabela de heartbeat devem ser removidas das tarefas diretas e reversas. Valores válidos:

  • none: Não grava informações SQL de heartbeat no banco de dados de origem.

  • N: Grava informações SQL de heartbeat no banco de dados de origem.

whitelist.dms.online.ddl.enable

Quando o tipo de banco de dados de destino é MySQL (incluindo ApsaraDB RDS for MySQL e MySQL autogerenciado), PolarDB for MySQL, AnalyticDB for MySQL ou AnalyticDB for PostgreSQL, e trata-se de uma instância de sincronização ou migração.

Estes seis parâmetros atuam em conjunto para controlar se as tabelas temporárias criadas durante alterações Online DDL na tabela de origem devem ser replicadas para o banco de dados de destino.

  • Replicar dados de tabelas temporárias gerados por alterações Online DDL na tabela de origem:

    {
       "whitelist.dms.online.ddl.enable": "true",
         "sqlparser.dms.original.ddl": "false",
         "whitelist.ghost.online.ddl.enable": "true",
         "sqlparser.ghost.original.ddl": "false"
    }
  • Não replicar dados de tabelas temporárias gerados por alterações Online DDL na tabela de origem. Em vez disso, sincronizar apenas as instruções DDL originais executadas pelo DMS no banco de dados de origem:

    {
           "whitelist.dms.online.ddl.enable": "false",
             "sqlparser.dms.original.ddl": "true",
             "whitelist.ghost.online.ddl.enable": "false",
             "sqlparser.ghost.original.ddl": "false"
        }
  • Não replicar dados de tabelas temporárias gerados por alterações Online DDL na tabela de origem. Em vez disso, sincronizar apenas as instruções DDL originais executadas pelo gh-ost no banco de dados de origem:

    {
           "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)$"
        }
    Nota

    É possível usar as expressões regulares padrão ou personalizá-las para tabelas shadow do gh-ost (online.ddl.shadow.table.rule) e tabelas trash (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

Quando os bancos de dados de origem e de destino são MySQL (incluindo ApsaraDB RDS for MySQL e MySQL autogerenciado).

Define se a avaliação de migração deve ser ativada para verificar se as estruturas dos bancos de dados de origem e destino atendem aos requisitos. Valores válidos: true ou false.

srcSSL

Quando o método de conexão é uma instância cloud ou um banco de dados autogerenciado no ECS.

Método de conexão para o banco de dados de origem. Valores válidos:

  • 0: Conexão não criptografada.

  • 1: Conexão segura SSL.

Tabela 5. Tipo de banco de dados de origem: PolarDB for MySQL

Parâmetro

Requisitos de configuração

Descrição

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

Obrigatório

Define se as instruções SQL da tabela de heartbeat devem ser removidas das tarefas diretas e reversas. Valores válidos:

  • none: Não grava informações SQL de heartbeat no banco de dados de origem.

  • N: Grava informações SQL de heartbeat no banco de dados de origem.

whitelist.dms.online.ddl.enable

Quando o tipo de banco de dados de destino é MySQL (incluindo ApsaraDB RDS for MySQL e MySQL autogerenciado), PolarDB for MySQL, AnalyticDB for MySQL ou AnalyticDB for PostgreSQL, e trata-se de uma instância de sincronização ou migração.

Estes seis parâmetros atuam em conjunto para controlar se as tabelas temporárias criadas durante alterações Online DDL na tabela de origem devem ser replicadas para o banco de dados de destino.

  • Replicar dados de tabelas temporárias gerados por alterações Online DDL na tabela de origem:

    {
       "whitelist.dms.online.ddl.enable": "true",
         "sqlparser.dms.original.ddl": "false",
         "whitelist.ghost.online.ddl.enable": "true",
         "sqlparser.ghost.original.ddl": "false"
    }
  • Não replicar dados de tabelas temporárias gerados por alterações Online DDL na tabela de origem. Em vez disso, sincronizar apenas as instruções DDL originais executadas pelo DMS no banco de dados de origem:

    {
           "whitelist.dms.online.ddl.enable": "false",
             "sqlparser.dms.original.ddl": "true",
             "whitelist.ghost.online.ddl.enable": "false",
             "sqlparser.ghost.original.ddl": "false"
        }
  • Não replicar dados de tabelas temporárias gerados por alterações Online DDL na tabela de origem. Em vez disso, sincronizar apenas as instruções DDL originais executadas pelo gh-ost no banco de dados de origem:

    {
           "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)$"
        }
    Nota

    É possível usar as expressões regulares padrão ou personalizá-las para tabelas shadow do gh-ost (online.ddl.shadow.table.rule) e tabelas trash (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

Tabela 6. Tipo de banco de dados de origem: ApsaraDB RDS for MariaDB

Parâmetro

Pré-requisitos

Descrição

srcSSL

Quando o método de conexão é uma instância cloud ou um banco de dados autogerenciado no ECS.

Método de conexão para o banco de dados de origem. Valores válidos:

  • 0: Conexão não criptografada.

  • 1: Conexão segura SSL.

Tabela 7. Tipo de banco de dados de origem: Oracle

Parâmetro

Condição

Descrição

isTargetDbCaseSensitive

Quando o banco de dados de destino é AnalyticDB for PostgreSQL.

Define se devem ser adicionadas aspas ao redor dos objetos de destino. Valores válidos: true ou false.

isNeedAddRowId

Quando o banco de dados de destino é AnalyticDB for PostgreSQL e os objetos a serem sincronizados ou migrados incluem tabelas sem chaves primárias.

Define se o ROWID deve ser configurado como chave primária e chave de distribuição para todas as tabelas sem chaves primárias. Valores válidos: true ou false.

srcOracleType

Obrigatório

Tipo da instância Oracle. Valores válidos:

  • sid: Instância não RAC.

  • serviceName: Instância RAC ou banco de dados plugável (PDB).

source.column.encoding

Quando é necessário especificar a codificação usada pela aplicação para gravar dados.

Codificação utilizada pela aplicação para gravar dados. Codificações suportadas:

  • default (padrão)

  • GB 2312

  • GBK

  • GB 18030

  • UTF-8

  • UTF-16

  • UTF-32

Tabela 8. Tipo de banco de dados de origem: SQL Server (incluindo ApsaraDB RDS for SQL Server e SQL Server autogerenciado)

Parâmetro

Pré-requisitos

Descrição

isTargetDbCaseSensitive

Quando o banco de dados de destino é AnalyticDB for PostgreSQL.

Define se devem ser adicionadas aspas ao redor dos objetos de destino. Valores válidos: true ou false.

source.extractor.type

Quando o banco de dados de destino não é DataHub e a tarefa inclui operações incrementais.

Modo para sincronização ou migração incremental do SQL Server. Valores válidos:

  • cdc: Usa análise de log para tabelas non-heap e Change Data Capture (CDC) para tabelas heap.

  • log: Analisa logs do banco de dados de origem para sincronização ou migração incremental.

src.sqlserver.schema.mapper.mode

Quando o tipo de banco de dados de destino é MySQL (incluindo ApsaraDB RDS for MySQL e MySQL autogerenciado), PolarDB for MySQL ou AnalyticDB for MySQL.

Modo de mapeamento de schema entre os bancos de dados de origem e destino. Valores válidos:

  • schema.table: Usa o Schema name.Table name do banco de dados de origem como nome da tabela de destino.

  • without.schema: Usa o nome da tabela do banco de dados de origem como nome da tabela de destino.

    Aviso

    Se existirem tabelas com o mesmo nome em múltiplos schemas no banco de dados de origem, pode ocorrer inconsistência de dados ou falha na tarefa.

Tabela 9. Tipo de banco de dados de origem: Tair/Redis

Nota

Inclui Alibaba Cloud Tair (compatível com Redis) e Redis autogerenciado.

Parâmetro

Condições de configuração

Descrição

srcKvStoreMode

Quando o método de conexão da instância de banco de dados não é Alibaba Cloud Instance.

Modo da instância do banco de dados Redis de origem autogerenciado. Valores válidos:

  • single: Basic Edition.

  • cluster: Cluster Edition.

any.sink.redis.expire.extension.seconds

Obrigatório

Tempo de vida adicional (TTL), em segundos, adicionado às chaves quando migradas da origem para o banco de dados de destino. Para garantir a consistência dos dados, caso utilize qualquer um dos comandos abaixo, recomenda-se definir este valor como pelo menos 600 segundos.

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

any.source.redis.use.slave.node

Quando srcKvStoreMode é cluster.

Quando o banco de dados Redis de origem autogerenciado está em modo cluster, escolha se os dados devem ser extraídos do nó mestre ou escravo. Valores válidos:

  • true: Extrai dados do nó escravo.

  • false (padrão): Extrai dados do nó mestre.

Tabela 10. Tipo de banco de dados de origem: MongoDB (incluindo ApsaraDB for MongoDB e MongoDB autogerenciado)

Parâmetro

Requisitos de configuração

Descrição

srcEngineArchType

Obrigatório

Tipo de arquitetura do banco de dados MongoDB de origem. Valores válidos:

  • 0 : Instância standalone.

  • 1: ReplicaSet.

  • 2: Cluster fragmentado.

sourceShardEndpointUsername

Quando srcEngineArchType é 2.

Nome de usuário do shard para o banco de dados MongoDB de origem.

sourceShardEndpointPassword

Senha do shard para o banco de dados MongoDB de origem.

Tabela 11. Tipo de banco de dados de origem: PolarDB-X 2.0

Parâmetro

Requisitos de configuração

Descrição

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

Obrigatório

Define se as instruções SQL da tabela de heartbeat devem ser removidas das tarefas diretas e reversas. Valores válidos:

  • none: Não grava informações SQL de heartbeat no banco de dados de origem.

  • N: Grava informações SQL de heartbeat no banco de dados de origem.

Tabela 12. Tipo de banco de dados de origem: PolarDB for PostgreSQL (Compatible with Oracle)

Parâmetro

Condições de configuração

Descrição

srcHostPortCtl

Quando o método de conexão é um endereço IP público.

Define se devem ser selecionados dados de múltiplas fontes para o PolarDB for PostgreSQL (Compatible with Oracle). Valores válidos:

  • single: Single Data Source.

  • multiple: Multiple Data Sources.

srcHostPorts

Quando srcHostPortCtl é multiple.

Endereços IP e números de porta dos nós do PolarDB for PostgreSQL (Compatible with Oracle) de origem. Separe múltiplas entradas IP:Port com vírgulas.

Tabela 13. Tipo de banco de dados de origem: TiDB

Parâmetro

Pré-requisitos

Descrição

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

Obrigatório

Define se as instruções SQL da tabela de heartbeat devem ser removidas das tarefas diretas e reversas. Valores válidos:

  • none: Não grava informações SQL de heartbeat no banco de dados de origem.

  • N: Grava informações SQL de heartbeat no banco de dados de origem.

isIncMigration

Obrigatório

Define se a migração incremental deve ser realizada. Valores válidos: yes ou no.

Importante

Tarefas de sincronização aceitam apenas yes.

srcKafka

Quando isIncMigration é yes.

Informações do Kafka para o downstream do TiDB.

taskType

Tipo de cluster Kafka. Selecione com base no local de implantação do Kafka. Valores válidos:

  • EXPRESS: Leased line, VPN Gateway ou Smart Access Gateway.

  • ECS: Banco de dados autogerenciado no ECS.

bisId

  • Quando taskType é ECS, refere-se ao ID da instância ECS.

  • Quando taskType é EXPRESS, refere-se ao ID da VPC conectada ao banco de dados de origem.

port

Porta de service do cluster Kafka.

user

Conta do cluster Kafka. Deixe em branco se a autenticação do Kafka estiver desativada.

passwd

Senha do cluster Kafka. Deixe em branco se a autenticação do Kafka estiver desativada.

version

Versão do cluster Kafka.

ssl

Método de conexão para o cluster Kafka. Valores válidos:

  • 0: Conexão não criptografada.

  • 3: Conexão criptografada usando SCRAM-SHA-256.

topic

Tópico para os objetos de migração ou sincronização.

host

Quando taskType é EXPRESS.

Endereço IP do cluster Kafka.

vpcId

Quando taskType é ECS.

VPC da instância ECS.

Parâmetros do banco de dados de destino

Configure estes parâmetros no Reserve conforme o tipo do seu banco de dados de destino.

Tabela 14. Tipo de banco de dados de destino: MySQL (incluindo ApsaraDB RDS for MySQL e MySQL autogerenciado)

Parâmetro

Condição

Descrição

privilegeMigration

Quando os bancos de dados de origem e de destino são ApsaraDB RDS for MySQL. Para mais informações, consulte Source database type: MySQL (including ApsaraDB RDS for MySQL and self-managed MySQL).

Define se as contas devem ser migradas.

privilegeDbList

Informações sobre a migração de contas.

definer

Define se o Definer original dos objetos de banco de dados deve ser mantido.

whitelist.dms.online.ddl.enable

Quando o tipo de banco de dados de origem é MySQL (incluindo RDS MySQL e MySQL autogerenciado) ou PolarDB for MySQL, e a instância é de sincronização ou migração. Para mais informações, consulte Source database parameter settings.

Estes seis parâmetros atuam em conjunto para controlar se as tabelas temporárias criadas durante alterações Online DDL na tabela de origem devem ser replicadas para o banco de dados de destino.

sqlparser.dms.original.ddl

whitelist.ghost.online.ddl.enable

sqlparser.ghost.original.ddl

online.ddl.shadow.table.rule

online.ddl.trash.table.rule

isAnalyzer

Quando os bancos de dados de origem e de destino são MySQL (incluindo ApsaraDB RDS for MySQL e MySQL autogerenciado).

Define se a avaliação de migração deve ser ativada para verificar se as estruturas dos bancos de dados de origem e destino atendem aos requisitos. Valores válidos: true ou false.

triggerMode

Obrigatório

Método de migração de triggers para o banco de dados de origem. Valores válidos:

  • manual: Migração manual.

  • auto: Migração automática.

destSSL

Quando o método de conexão é uma instância cloud ou um banco de dados autogerenciado no ECS.

Método de conexão para o banco de dados de destino. Valores válidos:

  • 0: Conexão não criptografada.

  • 1: Conexão segura SSL.

src.sqlserver.schema.mapper.mode

Quando o banco de dados de origem é SQL Server (incluindo ApsaraDB RDS for SQL Server e SQL Server autogerenciado).

Modo de mapeamento de schema entre os bancos de dados de origem e destino. Para mais informações, consulte Source database type: SQL Server (including ApsaraDB RDS for SQL Server and self-managed SQL Server).

Tabela 15. Tipo de banco de dados de destino: PolarDB for MySQL

Parâmetro

Pré-requisitos

Descrição

whitelist.dms.online.ddl.enable

Quando o banco de dados de origem é MySQL (incluindo ApsaraDB RDS for MySQL e MySQL autogerenciado) ou PolarDB for MySQL, e a tarefa é uma instância de sincronização ou migração. Para mais informações, consulte Source database parameters.

Estes seis parâmetros atuam em conjunto para controlar se as tabelas temporárias criadas durante alterações Online DDL na tabela de origem devem ser replicadas para o banco de dados de destino.

sqlparser.dms.original.ddl

whitelist.ghost.online.ddl.enable

sqlparser.ghost.original.ddl

online.ddl.shadow.table.rule

online.ddl.trash.table.rule

anySinkTableEngineType

Obrigatório

Tipo de mecanismo da instância PolarDB for MySQL. Valores válidos:

  • innodb: Mecanismo de armazenamento padrão.

  • xengine: Mecanismo de armazenamento de banco de dados para Processamento de Transações On-Line (OLTP).

triggerMode

Obrigatório

Método de migração de triggers para o banco de dados de origem. Valores válidos:

  • manual: Migração manual.

  • auto: Migração automática.

src.sqlserver.schema.mapper.mode

Quando o banco de dados de origem é SQL Server (incluindo ApsaraDB RDS for SQL Server e SQL Server autogerenciado).

Modo de mapeamento de schema entre os bancos de dados de origem e destino. Para mais informações, consulte Source database type: SQL Server (including ApsaraDB RDS for SQL Server and self-managed SQL Server).

Tabela 16. Tipo de banco de dados de destino: AnalyticDB for MySQL

Parâmetro

Condição

Descrição

whitelist.dms.online.ddl.enable

Quando o banco de dados de origem é MySQL (incluindo ApsaraDB RDS for MySQL e MySQL autogerenciado) ou PolarDB for MySQL, e a tarefa é uma instância de sincronização ou migração. Para mais informações, consulte Source database parameters.

Estes seis parâmetros atuam em conjunto para controlar se as tabelas temporárias criadas durante alterações Online DDL na tabela de origem devem ser replicadas para o banco de dados de destino.

sqlparser.dms.original.ddl

whitelist.ghost.online.ddl.enable

sqlparser.ghost.original.ddl

online.ddl.shadow.table.rule

online.ddl.trash.table.rule

triggerMode

Obrigatório

Método de migração de triggers para o banco de dados de origem. Valores válidos:

  • manual: Migração manual.

  • auto: Migração automática.

src.sqlserver.schema.mapper.mode

Quando o banco de dados de origem é SQL Server (incluindo ApsaraDB RDS for SQL Server e SQL Server autogerenciado).

Modo de mapeamento de schema entre os bancos de dados de origem e destino. Para mais informações, consulte Source database type: SQL Server (including ApsaraDB RDS for SQL Server and self-managed SQL Server).

traceDatasource

Obrigatório

Define se a mesclagem de múltiplas tabelas deve ser ativada. Valores válidos: true ou false.

tagColumnValue

Quando você define uma coluna de tag personalizada.

Define se a coluna de tag __dts_data_source deve ser personalizada. Valores válidos:

  • tagColumnValue: Personaliza a coluna de tag.

    Importante

    Você também deve configurar o valor da coluna de tag no parâmetro DbList. Para mais informações, consulte Migration, synchronization, or tracking object description.

  • notTagColumnValue: Não personaliza a coluna de tag.

    Importante

    Colunas de tag personalizadas são suportadas apenas no cenário de compra antes da configuração.

adsSqlType

Quando é necessário selecionar operações SQL de sincronização ou migração incremental no nível da instância.

Operações SQL para sincronização ou migração incremental no nível da instância. Separe múltiplas operações SQL com vírgulas. Valores válidos:

  • insert

  • update

  • delete

  • alterTable

  • truncateTable

  • createTable

  • dropTable

Tabela 17. Tipo de banco de dados de destino: AnalyticDB for PostgreSQL

Parâmetro

Pré-requisitos

Descrição

whitelist.dms.online.ddl.enable

Quando o banco de dados de origem é MySQL (incluindo ApsaraDB RDS for MySQL e MySQL autogerenciado) ou PolarDB for MySQL, e a tarefa é uma instância de sincronização ou migração. Para mais informações, consulte Source database parameters.

Estes seis parâmetros atuam em conjunto para controlar se as tabelas temporárias criadas durante alterações Online DDL na tabela de origem devem ser replicadas para o banco de dados de destino.

sqlparser.dms.original.ddl

whitelist.ghost.online.ddl.enable

sqlparser.ghost.original.ddl

online.ddl.shadow.table.rule

online.ddl.trash.table.rule

isTargetDbCaseSensitive

Quando o banco de dados de origem é MySQL (incluindo ApsaraDB RDS for MySQL e MySQL autogerenciado), Oracle ou SQL Server (incluindo ApsaraDB RDS for SQL Server e SQL Server autogerenciado).

Define se devem ser adicionadas aspas ao redor dos objetos de destino. Valores válidos: true ou false.

syncOperation

Quando é necessário selecionar operações SQL de sincronização ou migração incremental no nível da instância.

Operações SQL para sincronização ou migração incremental no nível da instância. Separe múltiplas operações SQL com vírgulas. Valores válidos:

  • insert

  • update

  • delete

  • alterTable

  • truncateTable

  • createTable

  • dropTable

  • createDB

  • dropDB

Tabela 18. Tipo de banco de dados de destino: ApsaraDB RDS for MariaDB

Parâmetro

Condições de configuração

Descrição

triggerMode

Obrigatório

Método de migração de triggers para o banco de dados de origem. Valores válidos:

  • manual: Migração manual.

  • auto: Migração automática.

destSSL

Quando o método de conexão é uma instância cloud ou um banco de dados autogerenciado no ECS.

Método de conexão para o banco de dados de destino. Valores válidos:

  • 0: Conexão não criptografada.

  • 1: Conexão segura SSL.

Tabela 19. Tipo de banco de dados de destino: MongoDB (incluindo ApsaraDB for MongoDB e MongoDB autogerenciado)

Parâmetro

Condição

Descrição

destEngineArchType

Obrigatório

Tipo de arquitetura do banco de dados MongoDB de destino. Valores válidos:

  • 0 : Instância standalone.

  • 1: ReplicaSet.

  • 2: Cluster fragmentado.

Tabela 20. Tipo de banco de dados de destino: Tair/Redis

Nota

Inclui Alibaba Cloud Tair (compatível com Redis) e Redis autogerenciado.

Parâmetro

Pré-requisitos

Descrição

destKvStoreMode

Quando o método de conexão da instância de banco de dados não é Alibaba Cloud Instance.

Modo da instância do banco de dados Redis de destino autogerenciado. Valores válidos:

  • single: Basic Edition.

  • cluster: Cluster Edition.

any.sink.redis.expire.extension.seconds

Obrigatório

Tempo de vida adicional (TTL), em segundos, adicionado às chaves quando migradas da origem para o banco de dados de destino. Para garantir a consistência dos dados, caso utilize qualquer um dos comandos abaixo, recomenda-se definir este valor como pelo menos 600 segundos.

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

Tabela 21. Tipo de banco de dados de destino: PolarDB for PostgreSQL (Compatible with Oracle)

Parâmetro

Pré-requisitos de configuração

Descrição

destHostPortCtl

Quando o método de conexão é um endereço IP público.

Define se devem ser selecionados dados de múltiplas fontes para o PolarDB for PostgreSQL (Compatible with Oracle). Valores válidos:

  • single: Single Data Source.

  • multiple: Multiple Data Sources.

destHostPorts

Quando destHostPortCtl é multiple.

Endereços IP e números de porta dos nós do PolarDB for PostgreSQL (Compatible with Oracle) de destino. Separe múltiplas entradas IP:Port com vírgulas.

Tabela 22. Tipo de banco de dados de destino: Oracle

Parâmetro

Condição

Descrição

destOracleType

Obrigatório

Tipo da instância Oracle. Valores válidos:

  • sid: Instância não RAC.

  • serviceName: Instância RAC ou banco de dados plugável (PDB).

Tabela 23. Tipo de banco de dados de destino: DataHub

Parâmetro

Condições de configuração

Descrição

isUseNewAttachedColumn

Obrigatório

A regra de nomenclatura para colunas anexadas é a seguinte:

  • Usar a nova regra de nomenclatura: Defina isUseNewAttachedColumn como true.

  • Usar a regra antiga de nomenclatura: Defina isUseNewAttachedColumn como false.

Tabela 24. Tipo de banco de dados de destino: MaxCompute

Parâmetro

Condição

Descrição

isUseNewAttachedColumn

Obrigatório

A regra de nomenclatura para colunas anexadas é a seguinte:

  • Usar a nova regra de nomenclatura: Defina isUseNewAttachedColumn como true.

  • Usar a regra antiga de nomenclatura: Defina isUseNewAttachedColumn como false.

partition

Obrigatório

Nome da partição para a tabela de log incremental. Valores válidos:

  • Quando isUseNewAttachedColumn é true:

    • modifytime_year

    • modifytime_month

    • modifytime_day

    • modifytime_hour

    • modifytime_minute

  • Quando 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

Tabela 25. Tipo de banco de dados de destino: Elasticsearch

Parâmetro

Pré-requisitos

Descrição

indexMapping

Obrigatório

Nome do índice criado na instância Elasticsearch de destino. Valores válidos:

  • tb: O nome do índice corresponde ao nome da tabela.

  • db_tb: O nome do índice é formado pela concatenação do nome do banco de dados, um sublinhado (_) e o nome da tabela.

Tabela 26. Tipo de banco de dados de destino: Kafka

Parâmetro

Pré-requisitos

Descrição

destTopic

Obrigatório

Tópico no cluster Kafka de destino para os objetos de migração ou sincronização.

destVersion

Obrigatório

Versão do cluster Kafka de destino. Valores válidos: 1,0, 0,9 ou 0,10.

Nota

Se a versão do cluster Kafka for 1,0 ou superior, insira 1,0.

destSSL

Obrigatório

Método de conexão para o cluster Kafka de destino. Valores válidos:

  • 0: Conexão não criptografada.

  • 3: Conexão criptografada usando SCRAM-SHA-256.

sink.kafka.ddl.topic

Quando é necessário especificar um tópico para armazenar informações DDL.

Tópico usado para armazenar informações DDL. Se nenhum for especificado, as informações DDL serão armazenadas por padrão no tópico definido em destTopic.

kafkaRecordFormat

Obrigatório

Formato de armazenamento para dados entregues ao cluster Kafka de destino. Valores válidos:

  • canal_json: Usa o Canal para analisar logs incrementais do banco de dados e entregar dados incrementais ao cluster Kafka de destino. O formato de armazenamento de dados é Canal JSON.

  • dts_avro: Formato de serialização de dados que converte estruturas de dados ou objetos em formatos adequados para armazenamento ou transmissão.

  • shareplex_json: Usa o software de replicação de dados Shareplex para ler dados do banco de dados de origem e gravá-los no cluster Kafka de destino. O formato de armazenamento de dados é Shareplex JSON.

  • debezium: Ferramenta que captura alterações de dados e suporta atualizações de dados em tempo real via streaming do banco de dados de origem para o cluster Kafka de destino.

Nota

Para mais informações sobre formatos, consulte Data storage formats in message queues.

destKafkaPartitionKey

Obrigatório

Política de sincronização de partições Kafka. Valores válidos:

  • none: Entrega todos os dados e informações DDL na Partição 0 do tópico de destino.

  • database_table: Combina o nome do banco de dados e o nome da tabela como chave de partição para calcular um valor hash. Em seguida, entrega dados e informações DDL de cada tabela para diferentes partições no tópico de destino.

  • columns: Usa colunas da tabela (por padrão, a chave primária; se não houver chave primária, usa a chave única) como chave de partição para calcular um valor hash. Em seguida, entrega linhas diferentes para partições diferentes no tópico de destino. Também é possível especificar uma ou mais colunas como chave de partição para calcular o valor hash.

Nota

Para mais informações sobre políticas de sincronização de partições, consulte Kafka partition synchronization policy reference.

destSchemaRegistry

Obrigatório

Define se o Kafka Schema Registry deve ser usado. Valores válidos: yes ou no.

destKafkaSchemaRegistryUrl

Quando destSchemaRegistry é true.

URL ou endereço IP onde o schema Avro está registrado no Kafka Schema Registry.

Tabela 27. Tipo de banco de dados de destino: OSS para tarefas de integração de dados lakehouse

Parâmetro

Pré-requisitos

Descrição

fusionMetastoreMod

Obrigatório

Local de armazenamento para os metadados do OSS de destino (catálogo de dados). Valores válidos:

  • dms: Armazena no DMS.

  • adb: Armazena em um cluster AnalyticDB for MySQL 3.0.

  • none: Não armazena metadados.

fusionOssFilePath

Obrigatório

Diretório no OSS onde os dados são armazenados.

fusionOssFileFormat

Obrigatório

Formato dos dados integrados no OSS de destino. Valores válidos:

  • DELTA: Formato Delta.

  • PARQUET: Formato Parquet.

  • HUDI: Formato Hudi.

fusionAdbCrossMdsDbClusterId

Quando fusionMetastoreMod é adb.

ID do cluster AnalyticDB for MySQL 3.0 que armazena os metadados do OSS de destino.

fusionAdbCrossMdsRamId

Quando fusionMetastoreMod é adb.

ID da conta Alibaba Cloud (conta principal) ou do usuário RAM (subconta) do cluster AnalyticDB for MySQL 3.0 que armazena os metadados do OSS de destino.

Nota

Você deve ter permissões de gravação nos bancos de dados deste cluster AnalyticDB for MySQL 3.0.

srcConnArgs

Quando o banco de dados de origem é MySQL ou SQL Server.

Parâmetros de conexão para o banco de dados de origem no formato JSON. Exemplo:

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

sparkExtraArgs

Quando você configura parâmetros de tarefa Spark.

Parâmetros da tarefa Spark no formato JSON. Exemplo:

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