This topic describes how to synchronize data from a self-managed Oracle database to a Message Queue for Apache Kafka instance by using Data Transmission Service (DTS).

Prerequisites

  • The source Oracle database and the destination instance are created.
    Note For more information about the versions supported by the source database and the destination instance, see Overview of data synchronization scenarios.
  • The self-managed Oracle database is running in ARCHIVELOG mode. Archived log files are accessible and a suitable retention period is set for archived log files. For more information, see Managing Archived Redo Log Files.
  • Supplemental logging, including SUPPLEMENTAL_LOG_DATA_PK and SUPPLEMENTAL_LOG_DATA_UI, is enabled for the self-managed Oracle database. For more information, see Supplemental Logging.
  • The available storage space of the destination instance is larger than the total size of the data in the self-managed Oracle database.
  • In the destination instance, a topic is created to receive the synchronized data. For more information, see Step 1: Create a topic.

Limits

Supported synchronization topologies

  • One-way one-to-one synchronization
  • One-way one-to-many synchronization
  • One-way many-to-one synchronization
  • One-way cascade synchronization
For more information, see Synchronization topologies.

SQL operations that can be synchronized

Operation type SQL statements
DML INSERT, UPDATE, and DELETE
DDL
  • CREATE TABLE, ALTER TABLE, DROP TABLE, RENAME TABLE, and TRUNCATE TABLE
  • CREATE VIEW, ALTER VIEW, and DROP VIEW
  • CREATE PROCEDURE, ALTER PROCEDURE, and DROP PROCEDURE
  • CREATE FUNCTION, DROP FUNCTION, CREATE TRIGGER, and DROP TRIGGER
  • CREATE INDEX and DROP INDEX

Permissions required for database accounts

Database Required permissions References
Self-managed Oracle database Database administrator (DBA) CREATE USER and GRANT
Notice If you need to synchronize data from an Oracle database but the database administrator (DBA) permission cannot be granted to the database account, you can enable archive logging and supplemental logging, and grant fine-grained permissions to the account.
  1. Enable archive logging and supplemental logging.
    Type Procedure
    Archive logging Execute the following statements to enable archive logging:
    shutdown immediate;
    startup mount;
    alter database archivelog;
    alter database open;
    archive log list;
    Supplemental logging Enable supplemental logging at the database or table level:
    Note You can enable database-level supplemental logging to ensure the stability of DTS tasks. You can enable table-level supplemental logging to reduce the disk usage of the source Oracle database.
    • Enable database-level supplemental logging
      1. Enable minimal supplemental logging:
        alter database add supplemental log data;
      2. Enable primary key and unique key supplemental logging at the database level:
        alter database add supplemental log data (primary key,unique index) columns;
    • Enable table-level supplemental logging
      1. Enable minimal supplemental logging:
        alter database add supplemental log data;
      2. Enable table-level supplemental logging by using one of the following methods:
        • Enable primary key supplemental logging at the table level:
          alter table table_name add supplemental log data (primary key) columns;
        • Enable table-level supplemental logging for all columns:
          alter table tb_name add supplemental log data (all) columns ;
  2. Grant fine-grained permissions to an Oracle database account
    # Create a database account, for example, rdsdt_dtsacct, and grant permissions to the account.
    create user rdsdt_dtsacct IDENTIFIED BY rdsdt_dtsacct;
    grant create session to rdsdt_dtsacct;
    grant connect to rdsdt_dtsacct;
    grant resource to rdsdt_dtsacct;
    grant execute on sys.dbms_logmnr to rdsdt_dtsacct;
    grant select on V_$LOGMNR_LOGS to rdsdt_dtsacct;
    grant select on  all_objects to rdsdt_dtsacct;
    grant select on  all_tab_cols to rdsdt_dtsacct;
    grant select on  dba_registry to rdsdt_dtsacct;
    grant select any table to rdsdt_dtsacct;
    grant select any transaction to rdsdt_dtsacct;
    -- v$log privileges
    grant select on v_$log to rdsdt_dtsacct;
    -- v$logfile privileges
    grant select on v_$logfile to rdsdt_dtsacct;
    -- v$archived_log privileges
    grant select on v_$archived_log to rdsdt_dtsacct;
    -- v$parameter privileges
    grant select on v_$parameter to rdsdt_dtsacct;
    -- v$database privileges
    grant select on v_$database to rdsdt_dtsacct;
    -- v$active_instances privileges
    grant select on v_$active_instances to rdsdt_dtsacct;
    -- v$instance privileges
    grant select on v_$instance to rdsdt_dtsacct;
    -- v$logmnr_contents privileges
    grant select on v_$logmnr_contents to rdsdt_dtsacct;
    -- system tables
    grant select on sys.USER$ to rdsdt_dtsacct;
    grant select on SYS.OBJ$ to rdsdt_dtsacct;
    grant select on SYS.COL$ to rdsdt_dtsacct;
    grant select on SYS.IND$ to rdsdt_dtsacct;
    grant select on SYS.ICOL$ to rdsdt_dtsacct;
    grant select on SYS.CDEF$ to rdsdt_dtsacct;
    grant select on SYS.CCOL$ to rdsdt_dtsacct;
    grant select on SYS.TABPART$ to rdsdt_dtsacct;
    grant select on SYS.TABSUBPART$ to rdsdt_dtsacct;
    grant select on SYS.TABCOMPART$ to rdsdt_dtsacct;
    # Switch to the pluggable database (PDB). Create a database account, for example, rdsdt_dtsacct, and grant permissions to the account.
    ALTER SESSION SET container = ORCLPDB1;
    create user rdsdt_dtsacct IDENTIFIED BY rdsdt_dtsacct;
    grant create  session to rdsdt_dtsacct;
    grant connect  to rdsdt_dtsacct;
    grant resource to rdsdt_dtsacct;
    grant execute on sys.dbms_logmnr to rdsdt_dtsacct;
    grant select on  all_objects to rdsdt_dtsacct;
    grant select on  all_tab_cols to rdsdt_dtsacct;
    grant select on  dba_registry to rdsdt_dtsacct;
    grant select any table to rdsdt_dtsacct;
    grant select any transaction to rdsdt_dtsacct;
    -- v$log privileges
    grant select on v_$log to rdsdt_dtsacct;
    -- v$logfile privileges
    grant select on v_$logfile to rdsdt_dtsacct;
    -- v$archived_log privileges
    grant select on v_$archived_log to rdsdt_dtsacct;
    -- v$parameter privileges
    grant select on v_$parameter to rdsdt_dtsacct;
    -- v$database privileges
    grant select on v_$database to rdsdt_dtsacct;
    -- v$active_instances privileges
    grant select on v_$active_instances to rdsdt_dtsacct;
    -- v$instance privileges
    grant select on v_$instance to rdsdt_dtsacct;
    -- v$logmnr_contents privileges
    grant select on v_$logmnr_contents to rdsdt_dtsacct;
    grant select on sys.USER$ to rdsdt_dtsacct;
    grant select on SYS.OBJ$ to rdsdt_dtsacct;
    grant select on SYS.COL$ to rdsdt_dtsacct;
    grant select on SYS.IND$ to rdsdt_dtsacct;
    grant select on SYS.ICOL$ to rdsdt_dtsacct;
    grant select on SYS.CDEF$ to rdsdt_dtsacct;
    grant select on SYS.CCOL$ to rdsdt_dtsacct;
    grant select on SYS.TABPART$ to rdsdt_dtsacct;
    grant select on SYS.TABSUBPART$ to rdsdt_dtsacct;
    grant select on SYS.TABCOMPART$ to rdsdt_dtsacct;
    -- V$PDBS privileges
    grant select on V_$PDBS to rdsdt_dtsacct;
    
    # Switch to the container database (CDB). Create a database account and grant permissions to the account by using one of the following methods:
    ALTER SESSION SET container = CDB$ROOT;
    Method 1: Create a global account starting with C##, for example, C##rdsdt_dtsacct, and grant permissions to the account. If you use this method, you must submit a ticket and contact the DTS team to modify some parameters. The link to submit a ticket is provided in the note.
    create user C##rdsdt_dtsacct IDENTIFIED BY rdsdt_dtsacct;
    grant create session to C##rdsdt_dtsacct;
    grant connect to C##rdsdt_dtsacct;
    grant resource to C##rdsdt_dtsacct;
    grant select on v_$logmnr_contents to rdsdt_dtsacct;
    grant LOGMINING to C##rdsdt_dtsacct;
    grant EXECUTE_CATALOG_ROLE to C##rdsdt_dtsacct;
    grant execute on sys.dbms_logmnr to C##rdsdt_dtsacct;
    Method 2: Create a database account, for example, rdsdt_dtsacct, and grant permissions to the account. If you use this method, you must modify the default parameters of the Oracle database.
    alter session set "_ORACLE_SCRIPT"=true;
    create user rdsdt_dtsacct IDENTIFIED BY rdsdt_dtsacct;
    grant create session to rdsdt_dtsacct;
    grant connect to rdsdt_dtsacct;
    grant select on v_$logmnr_contents to rdsdt_dtsacct;
    grant LOGMINING TO rdsdt_dtsacct;
    grant EXECUTE_CATALOG_ROLE to rdsdt_dtsacct;
    grant execute on sys.dbms_logmnr to rdsdt_dtsacct;
    # Create a database account, for example, rdsdt_dtsacct, and grant permissions to the account.
    create user rdsdt_dtsacct IDENTIFIED BY rdsdt_dtsacct;
    grant create  session to rdsdt_dtsacct;
    grant connect  to rdsdt_dtsacct;
    grant resource to rdsdt_dtsacct;
    grant select on V_$LOGMNR_LOGS to rdsdt_dtsacct;
    grant select on  all_objects to rdsdt_dtsacct;
    grant select on  all_tab_cols to rdsdt_dtsacct;
    grant select on  dba_registry to rdsdt_dtsacct;
    grant select any table to rdsdt_dtsacct;
    grant select any transaction to rdsdt_dtsacct;
    -- v$log privileges
    grant select on v_$log to rdsdt_dtsacct;
    -- v$logfile privileges
    grant select on v_$logfile to rdsdt_dtsacct;
    -- v$archived_log privileges
    grant select on v_$archived_log to rdsdt_dtsacct;
    -- v$parameter privileges
    grant select on v_$parameter to rdsdt_dtsacct;
    -- v$database privileges
    grant select on v_$database to rdsdt_dtsacct;
    -- v$active_instances privileges
    grant select on v_$active_instances to rdsdt_dtsacct;
    -- v$instance privileges
    grant select on v_$instance to rdsdt_dtsacct;
    -- v$logmnr_contents privileges
    grant select on v_$logmnr_contents to rdsdt_dtsacct;
    grant select on sys.USER$ to rdsdt_dtsacct;
    grant select on SYS.OBJ$ to rdsdt_dtsacct;
    grant select on SYS.COL$ to rdsdt_dtsacct;
    grant select on SYS.IND$ to rdsdt_dtsacct;
    grant select on SYS.ICOL$ to rdsdt_dtsacct;
    grant select on SYS.CDEF$ to rdsdt_dtsacct;
    grant select on SYS.CCOL$ to rdsdt_dtsacct;
    grant select on SYS.TABPART$ to rdsdt_dtsacct;
    grant select on SYS.TABSUBPART$ to rdsdt_dtsacct;
    grant select on SYS.TABCOMPART$ to rdsdt_dtsacct;
    grant LOGMINING TO rdsdt_dtsacct;
    grant EXECUTE_CATALOG_ROLE to rdsdt_dtsacct;
    grant execute on sys.dbms_logmnr to rdsdt_dtsacct;
    Note To create a global account starting with C## for a multitenant container database (CDB) in Oracle 12c to 19c, you must submit a ticket and contact the DTS team to modify some parameters.

Procedure

  1. Go to the Data Synchronization page of the new DTS console.
    Note You can also log on to the Data Management (DMS) console. In the top navigation bar, choose DTS > Data Synchronization.
  2. In the upper-left corner of the page, select the region where the data synchronization instance resides.
    Select a region
  3. Click Create Task. On the page that appears, configure the source and destination databases.
    Section Parameter Description
    N/A Task Name

    DTS automatically generates a task name. We recommend that you specify an informative name to identify the task. You do not need to use a unique task name.

    Source Database Database Type Select Oracle.
    Access Method Select an instance type based on the deployment of the source database. In this example, select Self-managed Database on ECS.
    Note If your source database is a self-managed database, you must deploy the network environment for the database. For more information, see Preparation overview.
    Instance Region Select the region where the self-managed Oracle database resides.
    ECS Instance ID Select the ID of the Elastic Compute Service (ECS) instance that hosts the self-managed Oracle database.
    Port Number Enter the service port number of the self-managed Oracle database. The default port number is 1521.
    Oracle Type
    • If you select Non-RAC Instance, you must specify the SID parameter.
    • If you select RAC or PDB Instance, you must specify the Service Name parameter.
      Notice RAC instances are not supported.
    In this example, select Non-RAC Instance.
    Database Account Enter the account of the self-managed Oracle database. For information about the permissions that are required for the account, see Permissions required for database accounts.
    Database Password

    Enter the password of the database account.

    Destination Database Database Type Select Kafka.
    Access Method Select Express Connect, VPN Gateway, or Smart Access Gateway.
    Note You cannot select as the instance type. You can use Message Queue for Apache Kafka as a self-managed Kafka database to configure data synchronization.
    Instance Region Select the region where the destination instance resides.
    Connected VPC Select the ID of the virtual private cloud (VPC) to which the destination instance belongs. To obtain the VPC ID, you can log on to the Message Queue for Apache Kafka console and go to the Instance Details page of the Message Queue for Apache Kafka instance. In the Basic Information section, you can view the VPC ID.
    Hostname or IP Address Enter an IP address that is included in the Default Endpoint parameter of the instance.
    Note To obtain an IP address, you can log on to the Message Queue for Apache Kafka console and go to the Instance Details page of the instance. In the Basic Information section, you can obtain an IP address from the Default Endpoint parameter.
    Port Number Enter the service port number of the instance. The default port number is 9092.
    Database Account Enter the database account of the instance.
    Note If the instance type of the instance is VPC Instance, you do not need to specify the database account or database password.
    Database Password

    Enter the password of the database account.

    Kafka Version Select the version of the Message Queue for Apache Kafka instance.
    Encryption Select Non-encrypted or SCRAM-SHA-256 based on your business and security requirements.
    Topic Select a topic from the drop-down list.
    Topic That Stores DDL Information Select a topic from the drop-down list. The topic is used to store the DDL information. If you do not specify this parameter, the DDL information is stored in the topic that is specified by the Topic parameter.
    Whether to Use Kafka Schema Registry Kafka Schema Registry provides a serving layer for your metadata. It provides a RESTful interface for storing and retrieving your Avro schemas.
    • No: Kafka Schema Registry is not used.
    • Yes: Kafka Schema Registry is used. In this case, you must enter the URL or IP address that is registered in Kafka Schema Registry for your Avro schemas.
  4. In the lower part of the page, click Test Connectivity and Proceed.
  5. Select objects for the task and configure advanced settings.
    • Basic SettingsBasic Settings
      Parameter Description
      Task Stages

      Incremental Data Synchronization is selected by default. You must also select Schema Synchronization and Full Data Synchronization. After the precheck, DTS synchronizes the historical data of the selected objects from the source instance to the destination cluster. The historical data is the basis for subsequent incremental synchronization.

      Processing Mode of Conflicting Tables
      • Precheck and Report Errors: checks whether the destination database contains tables that have the same names as tables in the source database. If the source and destination databases do not contain identical table names, the precheck is passed. Otherwise, an error is returned during precheck and the data synchronization task cannot be started.

        Note You can use the object name mapping feature to rename the tables that are synchronized to the destination database. You can use this feature if the source and destination databases contain identical table names and the tables in the destination database cannot be deleted or renamed. For more information, see Map object names.
      • Ignore Errors and Proceed: skips the precheck for identical table names in the source and destination databases.
        Warning If you select Ignore Errors and Proceed, data consistency is not guaranteed and your business may be exposed to potential risks.
        • If the source and destination databases have the same schema, and a data record has the same primary key as an existing data record in the destination database:
          • During full data synchronization, DTS does not synchronize the data record to the destination database. The existing data record in the destination database is retained.
          • During incremental data synchronization, DTS synchronizes the data record to the destination database. The existing data record in the destination database is overwritten.
        • If the source and destination databases have different schemas, data may fail to be initialized. In this case, only some columns are synchronized or the data synchronization task fails.
      Data Format in Kafka Select the format in which data records are stored in the Message Queue for Apache Kafka instance.
      • If you select DTS Avro, data is parsed based on the schema definition of DTS Avro. For more information, see DTS Avro schema.
      • If you select SharePlex JSON, data is stored in the SharePlex JSON format. For more information, see SharePlex JSON.
      Policy for Shipping Data to Kafka Partitions Select a synchronization policy based on your business requirements. For more information, see Specify the policy for migrating data to Kafka partitions.
      Select Objects

      Select one or more objects from the Source Objects section and click the Rightwards arrow icon to move the objects to the Selected Objects section.

      Note You can select columns, tables, or databases as the objects to be synchronized.
      Rename Databases and Tables
      • To rename an object that you want to synchronize to the destination instance, right-click the object in the Selected Objects section. For more information, see Map the name of a single object.
      • To rename multiple objects at a time, click Batch Edit in the upper-right corner of the Selected Objects section. For more information, see Map multiple object names at a time.
      Filter data

      You can specify WHERE conditions to filter data. For more information, see Use SQL conditions to filter data.

      Select the SQL operations to be synchronized In the Selected Objects section, right-click an object. In the dialog box that appears, select the DML and DDL operations that you want to synchronize. For more information, see SQL operations that can be synchronized.
    • Advanced SettingsAdvanced Settings
      Parameter Description
      Set Alerts
      Specify whether to set alerts for the data synchronization task. If the task fails or the synchronization latency exceeds the threshold, the alert contacts will receive notifications.
      • Select No if you do not want to set alerts.
      • Select Yes to set alerts. In this case, you must also set the alert threshold and alert contacts.
      Capitalization of Object Names in Destination Instance

      Specify the capitalization of database names, table names, and column names in the destination instance. By default, DTS default policy is selected. You can select other options to make sure that the capitalization of object names is consistent with that of the source or destination database. For more information, see Specify the capitalization of object names in the destination instance.

      Retry Time for Failed Connection
      Specify the retry time for failed connections. Valid values: 10 to 1440. Unit: minutes. Default value: 120. We recommend that you set the retry time to more than 30 minutes. If DTS reconnects to the source and destination databases within the specified time, DTS resumes the data synchronization task. Otherwise, the data synchronization task fails.
      Note
      • If multiple DTS instances have the same source or destination database, the lowest value takes effect. For example, the retry time is set to 30 minutes for Instance A and 60 minutes for Instance B, DTS retries failed connections at an interval of 30 minutes.
      • When DTS retries a connection, you are charged for the DTS instance. We recommend that you specify the retry time based on your business needs. You can also release the DTS instance at your earliest opportunity after the source and destination instances are released.
  6. Click Next: Save Task Settings and Precheck in the lower part of the page.
    Note
    • Before you can start the data synchronization task, DTS performs a precheck. You can start the data synchronization task only after the task passes the precheck.
    • If the task fails to pass the precheck, you can click the Info icon icon next to each failed item to view details.
      • You can troubleshoot the issues based on the causes and run a precheck again.
      • If you do not need to troubleshoot the issues, you can ignore failed items and run a precheck again.
  7. Wait until the Success Rate becomes 100%. Then, click Next: Purchase Instance.
  8. On the Purchase Instance page, specify the Billing Method and Instance Class parameters for the data synchronization instance. The following table describes the parameters.
    Section Parameter Description
    Parameters Billing Method
    • Subscription: You can pay for your subscription when you create an instance. We recommend that you select the subscription billing method for long-term use because it is more cost-effective than the pay-as-you-go billing method. You can save more costs with longer subscription periods.
    • Pay-as-you-go: A pay-as-you-go instance is billed on an hourly basis. We recommend that you select the pay-as-you-go billing method for short-term use. If you no longer require your pay-as-you-go instance, you can release it to reduce costs.
    Instance Class DTS provides several instance classes that have different performance in synchronization speed. You can select an instance class based on your business scenario. For more information, see Specifications of data synchronization instances.
    Subscription Length If you select the subscription billing method, set the subscription length and the number of instances that you want to create. The subscription length can be one to nine months or one to three years.
    Note This parameter is available only if you select the subscription billing method.
  9. Read and select Data Transmission Service (Pay-as-you-go) Service Terms.
  10. Click Buy and Start to start the data synchronization task. You can view the progress of the task in the task list.