Updated on 2024-05-09 GMT+08:00

From DDS to Kafka

Supported Source and Destination Databases

Table 1 Supported databases

Source DB

Destination DB

  • DDS DB instances (versions 4.0, 4.2, and 4.4)
  • Kafka

Suggestions

  • The success of database synchronization depends on environment and manual operations. To ensure a smooth synchronization, perform a synchronization trial before you start the synchronization to help you detect and resolve problems in advance.
  • It is recommended that you start a task during off-peak hours to minimize the impact of synchronization on your services.
  • For more information about the impact of DRS on databases, see What Is the Impact of DRS on Source and Destination Databases?

Precautions

Before creating a synchronization task, read the following notes:

  • You are advised to create an independent database account for DRS task connection to prevent task failures caused by database account password modification.
  • After changing the account passwords for the source and destination databases, modify the connection information in the DRS task as soon as possible to prevent automatic retry after a task failure. Automatic retry will lock the database accounts.
Table 2 Precautions

Type

Restrictions

Database permissions

Source database (minimum permissions):

  • Permission requirements for incremental synchronization:

    The source database user must have the readAnyDatabase permission for the admin database.

Source database

  • During the incremental synchronization, the Oplog of the source database must be enabled.
  • If the storage space is sufficient, store the source database Oplog for as long as possible. The recommended retention period is three days.
  • The source database name cannot contain /\."$ or spaces. The collection name cannot start with system. or contain the dollar sign ($).
  • If the source database is a cluster, the balancer must be disabled and orphan documents must be deleted. For details, see How Do I Disable the Balancer? and How Do I Delete Orphaned Documents in MongoDB Sharded Clusters?

Destination database

  • The destination database is a Kafka database.
  • You are advised to set auto.create.topics.enable of Kafka to false.

Precautions

  • The synchronization process consumes certain CPU and memory resources of the source database. Evaluate the source database resources in advance.
  • If the source database is under a heavy load, the processing speed of change streams cannot keep up with the oplog generation speed. As a result, DRS synchronization delay occurs.
  • The following DMLs are supported: insert, update, replace, and delete.
  • Only the following DDLs are supported: drop database, drop collection and rename
  • In the incremental synchronization phase, the synchronization speed can reach up to 10,000 rows in a single table per second.
  • During startup, the specified start point must be within the Oplog range.
  • During synchronization, do not modify or delete the usernames, passwords, permissions, or ports of the source and destination databases.
  • To ensure data consistency, do not modify the destination database (including but not limited to DDL and DML operations) during the entire synchronization process.
  • Documents larger than 16 MB in the source database cannot be inserted or updated during incremental synchronization.
  • If an incremental synchronization task is suspended or resumed due to an exception, there may be duplicate data in the destination Kafka. Use the id field in the Kafka data for data deduplication.
  • During incremental synchronization, do not delete the topic for receiving DRS data in Kafka. Otherwise, the task may fail.

Procedure

This section uses real-time incremental synchronization from DDS to Kafka as an example to describe how to configure a real-time synchronization task.

  1. On the Data Synchronization Management page, click Create Synchronization Task.
  2. On the Create Synchronization Instance page, select a region and project, specify the task name, description, and the synchronization instance details, and click Create Now.

    • Task information description
      Figure 1 Synchronization task information
      Table 3 Task information

      Parameter

      Description

      Region

      The region where the replication instance is deployed. You can change the region.

      Project

      The project corresponds to the current region and can be changed.

      Task Name

      The task name must start with a letter and consist of 4 to 50 characters. It can contain only letters, digits, hyphens (-), and underscores (_).

      Description

      The description consists of a maximum of 256 characters and cannot contain special characters !=<>'&"\

    • Synchronization instance information
      Figure 2 Synchronization instance information
      Table 4 Synchronization instance settings

      Parameter

      Description

      Data Flow

      Select Out of the cloud.

      Source DB Engine

      Select DDS.

      Destination DB Engine

      Select Kafka.

      Network Type

      The Public network is used as an example. Available options: VPC, Public network, and VPN or Direct Connect

      • VPC is suitable for data synchronization between cloud databases of the same account in the same region.
      • Public network is suitable for data synchronization from on-premises or external cloud databases to the destination databases bound with an EIP.
      • VPN or Direct Connect is suitable for synchronization of data between on-premises databases and cloud databases, between cloud databases of different accounts in the same region, or between cloud databases across regions.

      Source DB Instance

      An available DDS instance.

      Synchronization Instance Subnet

      Select the subnet where the synchronization instance is located. You can also click View Subnets to go to the network console to view the subnet where the instance resides.

      By default, the DRS instance and the destination DB instance are in the same subnet. You need to select the subnet where the DRS instance resides, and there are available IP addresses for the subnet. To ensure that the synchronization instance is successfully created, only subnets with DHCP enabled are displayed.

      Synchronization Mode

      The synchronization mode supported by a DRS task. For details about the underlying working principles for incremental synchronization, see Product Architecture and Function Principles.

      • Incremental

        Through log parsing, incremental data generated on the source database is synchronized to the destination database.

        During synchronization, the source database continues to provide services for external systems with zero downtime.

    • Task type
      Figure 3 Task type
      Table 5 Task type information

      Parameter

      Description

      Specifications

      DRS instance specifications. Different specifications have different performance upper limits. For details, see Real-Time Synchronization.

      NOTE:

      DRS allows you to upgrade specifications only for single-AZ synchronization tasks. Task specifications cannot be downgraded. For details, see Changing Specifications.

      AZ

      Select the AZ where you want to create the DRS task. Selecting the one housing the source or destination database can provide better performance.

    • Enterprise Project and Tags
      Figure 4 Enterprise projects and tags
      Table 6 Enterprise Project and Tags

      Parameter

      Description

      Enterprise Project

      An enterprise project you would like to use to centrally manage your cloud resources and members. Select an enterprise project from the drop-down list. The default project is default.

      For more information about enterprise project, see Enterprise Management User Guide.

      To customize an enterprise project, click Enterprise in the upper right corner of the console. The Enterprise Project Management Service page is displayed. For details, see Creating an Enterprise Project in Enterprise Management User Guide.

      Tags

      • Tags a task. This configuration is optional. Adding tags helps you better identify and manage your tasks. Each task can have up to 20 tags.
      • If your organization has configured tag policies for DRS, add tags to tasks based on the policies. If a tag does not comply with the policies, task creation may fail. Contact your organization administrator to learn more about tag policies.
      • After a task is created, you can view its tag details on the Tags tab. For details, see Tag Management.

    If a task fails to be created, DRS retains the task for three days by default. After three days, the task automatically stops.

  3. On the Configure Source and Destination Databases page, wait until the synchronization instance is created. Then, specify source and destination database information and click Test Connection for both the source and destination databases to check whether they have been connected to the synchronization instance. After the connection tests are successful, click Next.

    Figure 5 Source database information
    Table 7 Source database settings

    Parameter

    Description

    DB Instance Name

    The DDS instance you selected when creating the task. This parameter cannot be changed.

    Authentication Database

    The name of the authentication database. For example: The default authentication database of Huawei Cloud DDS instance is admin.

    Database Username

    The username for accessing the source database.

    Database Password

    The password for the database username.

    SSL Connection

    SSL encrypts the connections between the source and destination databases. If SSL is enabled, upload the SSL CA root certificate.

    NOTE:
    • The maximum size of a single certificate file that can be uploaded is 500 KB.
    • If SSL is disabled, your data may be at risk.

    The IP address, port, username, and password of the source database are encrypted and stored in the database and the synchronization instance, and will be cleared after the task is deleted.

    Figure 6 Destination database information
    Table 8 Destination database settings

    Parameter

    Description

    IP Address or Domain Name

    The IP address or domain name of the destination database.

    Security Protocol

    Available options: PLAINTEXT, SSL, SASL_PLAINTEXT, and SASL_SSL. For details, see Kafka Authentication.

    The username and password of the destination database are encrypted and stored in the database and the synchronization instance during the synchronization. After the task is deleted, the username and password are permanently deleted.

  4. On the Set Task page, select the start point and synchronization objects, and click Next.

    Figure 7 Synchronization Mode
    Table 9 Synchronization Object

    Parameter

    Description

    Start Point

    The start time of incremental synchronization. The value is in the format of timestamp:incre. timestamp is the Unix timestamp (unit: second), and incre is the command execution sequence in a second. A synchronization task obtains incremental logs of the source database from the start position (including the current start position).

    • Run db.getSiblingDB("local").oplog.rs.find() to query the source database oplog. The format of the ts field is timestamp:incre.
    • A cluster cannot query the oplog from mongos. timestamp can be converted into the Unix timestamp format based on the start time. The value of incre is 1.

    Topic Synchronization Policy

    Topic synchronization policy. You can select A specific topic.

    Topic

    Select the topic to be synchronized to the destination database.

    Synchronize Topic To

    The policy for synchronizing topics to the Kafka partitions.

    • If topics are synchronized to partition 0, strong consistency can be obtained but write performance is impacted.
    • If topics are synchronized to different partitions by hash value of the primary key, one table corresponds to one topic.

    Data Format in Kafka

    Select the data format to be delivered to Kafka.

    • JSON: JSON message format, which is easy to interpret but takes up more space.

    For details, see Kafka Message Format.

    Synchronization Object

    The left pane displays the source database objects, and the right pane displays the selected objects. DRS supports table- and database-level synchronization. You can select data for synchronization based on your service requirements.

    NOTE:
    • To quickly select the desired database objects, you can use the search function.
    • If there are changes made to the source databases or objects, click in the upper right corner to update the objects to be synchronized.
    • If an object name contains spaces, the spaces before and after the object name are not displayed. If there are two or more consecutive spaces in the middle of the object name, only one space is displayed.
    • The name of the selected synchronization object cannot contain spaces.

  5. On the Check Task page, check the synchronization task.

    • If any check fails, review the cause and rectify the fault. After the fault is rectified, click Check Again.

      For details about how to handle check failures, see Solutions to Failed Check Items in Data Replication Service User Guide.

    • If all check items are successful, click Next.
      Figure 8 Pre-check

      You can proceed to the next step only when all checks are successful. If there are any items that require confirmation, view and confirm the details first before proceeding to the next step.

  6. On the displayed page, specify Start Time, Send Notifications, SMN Topic, Delay Threshold (s), and Stop Abnormal Tasks After, confirm that the configured information is correct, select the check box before the agreement, and click Submit to submit the task.

    Figure 9 Task startup settings
    Table 10 Task startup settings

    Parameter

    Description

    Start Time

    Set Start Time to Start upon task creation or Start at a specified time based on site requirements.

    NOTE:

    After a synchronization task is started, the performance of the source and destination databases may be affected. You are advised to start a synchronization task during off-peak hours.

    Send Notifications

    This parameter is optional. After enabled, select a SMN topic. If the status, latency metric, or data of the synchronization task is abnormal, DRS will send a notification.

    SMN Topic

    This parameter is available only after you enable Send Notifications and create a topic on the SMN console and add a subscriber.

    For details, see Simple Message Notification User Guide.

    Delay Threshold (s)

    During an incremental synchronization, a synchronization delay indicates a time difference (in seconds) of synchronization between the source and destination database.

    If the synchronization delay exceeds the threshold you specify, DRS will send alarms to the specified recipients. The value ranges from 0 to 3,600. To avoid repeated alarms caused by the fluctuation of delay, an alarm is sent only after the delay has exceeded the threshold for six minutes.

    NOTE:
    • If the delay threshold is set to 0, no notifications will be sent to the recipient.
    • In the early stages of an incremental synchronization, the synchronization delay is long because a large quantity of data is awaiting synchronization. In this case, no notifications will be sent.
    • Before setting the delay threshold, enable Send Notifications.

    Data Exception Notification

    This parameter is optional. After enabled, DRS will send a notification if the task data is abnormal.

    Stop Abnormal Tasks After

    Number of days after which an abnormal task is automatically stopped. The value must range from 14 to 100. The default value is 14.

    NOTE:
    • You can set this parameter only for pay-per-use tasks.
    • Tasks in the abnormal state are still charged. If tasks remain in the abnormal state for a long time, they cannot be resumed. Abnormal tasks run longer than the period you set (unit: day) will automatically stop to avoid unnecessary fees.

  7. After the task is submitted, you can view and manage it on the Data Synchronization Management page.

    • You can view the task status. For more information about task status, see Task Statuses.
    • You can click in the upper right corner to view the latest task status.
    • By default, DRS retains a task in the Configuration state for three days. After three days, DRS automatically deletes background resources, but the task status remains unchanged. When you configure the task again, DRS applies for resources for the task again. In this case, the IP address of the DRS instance changes.