All Products
Search

This Product

    ApsaraDB for OceanBase:Synchronize data from OceanBase Database to a RocketMQ instance

    Document Center

    ApsaraDB for OceanBase:Synchronize data from OceanBase Database to a RocketMQ instance

    Last Updated:Jul 26, 2024

    This topic describes how to use the data transmission service to synchronize data from OceanBase Database to a RocketMQ instance.

    Background

    Message Queue for Apache RocketMQ is a distributed message-oriented middleware built by Alibaba Cloud based on Apache RocketMQ. It features low latency, high concurrency, and high reliability. The data synchronization capability of the data transmission service enables you to synchronize data between an OceanBase physical table and a RocketMQ data source in real time, extending the message processing capability.

    For more information about the data formats for the two types of tenants, see Data formats used when data is transmitted from OceanBase Database to a message queue system.

    Prerequisites

    • The data transmission service has the privilege to access cloud resources. For more information, see Grant privileges to roles for data transmission.

    • You have created a dedicated database user for data synchronization in the source OceanBase database and granted corresponding privileges to the user. For more information, see Create a database user.

    Limitations

    • The data transmission service supports RocketMQ instances of versions 4.x and 5.x, including commercial and community editions.

    • Only physical tables can be synchronized.

    • During data synchronization, the data transmission service allows you to drop a table before creating a new one. In other words, you can execute DROP TABLE and then execute CREATE TABLE. The data transmission service does not allow you to create a new table by renaming a table. In other words, you cannot execute RENAME TABLE a TO a_tmp.

    • The name of a table to be synchronized, as well as the names of columns in the table, must not contain Chinese characters.

    • The data transmission service supports the synchronization of an object only when the following conditions are met: the database name, table name, and column name of the object are ASCII-encoded without special characters. The special characters are line breaks, spaces, and the following characters: . | " ' ` ( ) = ; / & \.

    • The data transmission service does not support a standby OceanBase database as the source.

    Considerations

    • During incremental synchronization from OceanBase Database V4.x, if the STORED attribute is not specified for a generated column, the values of this column synchronized to the destination become NULL, which is not as expected by downstream systems that receive the values.

    • Take note of the following items when an updated row contains a LOB column:

      • If the LOB column is updated, do not use the value stored in the LOB column before the UPDATE or DELETE operation.

        The following data types are stored in LOB columns: JSON, GIS, XML, user-defined type (UDT), and TEXT such as LONGTEXT and MEDIUMTEXT.

      • If the LOB column is not updated, the value stored in the LOB column before and after the UPDATE or DELETE operation is NULL.

    • When a data synchronization project is resumed, some data (within the last minute) may be duplicated in the RocketMQ instance, and deduplication is required in downstream systems.

    • Clock desynchronization between nodes, or between the computer terminal and the server, can result in inaccurate incremental synchronization latency.

      For example, if the clock is ahead of the standard time, it may result in a negative latency. Conversely, if the clock is behind the standard time, it may result in an increased latency.

    Supported source and target instance types

    The following table lists the supported instance types for the source and destination. OceanBase Database has two types of tenants: MySQL and Oracle. The source can be an OceanBase cluster instance or a self-managed database in a virtual private cloud (VPC).

    Source

    Destination

    OceanBase Database

    RocketMQ (RocketMQ instance on Alibaba Cloud)

    OceanBase Database

    RocketMQ (self-managed RocketMQ instance in a VPC)

    OceanBase Database

    RocketMQ (RocketMQ instance in the public network)

    Procedure

    1. Log on to the ApsaraDB for OceanBase console and purchase a data synchronization project.

      For more information, see Purchase a data synchronization project.

    2. Choose Data Transmission > Data Synchronization. On the page that appears, click Configuration for the data synchronization project.

      image.png

      If you want to reference the configurations of an existing project, click Reference Configuration. For more information, see Reference and clear the configuration of a data synchronization project.

    3. On the Select Source and Destination page, configure the parameters.

      image.png

      Parameter

      Description

      Synchronization Project Name

      We recommend that you set it to a combination of digits and letters. It must not contain any spaces and cannot exceed 64 characters in length.

      Tag

      Click the field and select a target tag from the drop-down list. You can also click Manage Tags to create, modify, and delete tags. For more information, see Manage data synchronization projects by using tags.

      Source

      If you have created an OceanBase data source, select it from the drop-down list. If not, click New Data Source in the drop-down list to create one in the dialog box on the right side. For more information about the parameters, see Create an OceanBase data source.

      Important

      The source must not be an OceanBase Database tenant instance.

      Destination

      If you have created a RocketMQ data source, select it from the drop-down list. If not, click New Data Source in the drop-down list to create one in the dialog box on the right side. For more information, see Create a RocketMQ data source.

    4. Click Next. On the Select Synchronization Type page, specify the synchronization type for the current data synchronization project.

      image

      Valid values: Full Synchronization and Incremental Synchronization. At present, only DML Synchronization is supported for Incremental Synchronization. The supported DML operations are Insert, Delete, and Update. You can select operations as needed. For more information, see Configure DDL/DML synchronization.

    5. Click Next. On the Select Synchronization Objects page, select the objects to be synchronized in the current data synchronization project.

      You can select Specify Objects or Match Rules to specify synchronization objects. The following procedure describes how to specify synchronization objects by using the Specify Objects option. For information about the procedure for specifying synchronization objects by using the Match Rules option, see the "Configure matching rules for data migration/synchronization from a database to a Message Queue instance" section in the Configure matching rules topic.

      When you synchronize data from an OceanBase database to a RocketMQ instance, you can select multiple tables to map to multiple topics.

      1. In the Select Synchronization Objects section, select Specify Objects.

      2. In the left-side pane, select the objects to be synchronized.

      3. Click >.

      4. Click the Existing Topics drop-down list in the Map the Object to the Topic dialog box and select the target topic.

        You can also enter the name of an existing topic and select it after it appears.

        image.png

      5. Click OK.

        The data transmission service allows you to import objects by using text. It also allows you to change the topics of the objects, set row filters, and remove a single object or all objects. Objects in the destination database are listed in the structure of Topic > Database > Table.

        Note

        When you select Match Rules to specify synchronization objects, object renaming is implemented based on the syntax of the specified matching rules. In the operation area, you can only set filtering conditions and select sharding columns and the columns to be synchronized. For more information, see Configure matching rules.

        image.png

        Operation

        Description

        Import objects

        1. In the list on the right, click Import Objects in the upper-right corner.

        2. In the dialog box that appears, click OK.

          Important

          This operation will overwrite previous selections. Proceed with caution.

        3. In the Import Synchronization Objects dialog box, import the objects to be synchronized. You can import CSV files to set row filter conditions, filter columns, and sharding columns. For more information, see Download and import the settings of synchronization objects.

        4. Click Validate.

        5. After the validation succeeds, click OK.

        Change the topic

        The data transmission service allows you to change topics for objects in the destination database. For more information, see Change the topic.

        Configure settings

        You can use the WHERE clause to filter data by row and select sharding columns and the columns to be synchronized.

        In the Settings dialog box, you can perform the following operations:

        • In the Row Filters section, specify a standard SQL WHERE clause to filter data by row. For more information, see Use SQL conditions to filter data.

        • Select the sharding columns that you want to use from the Sharding Columns drop-down list. You can select multiple fields as sharding columns. This parameter is optional.

          Unless otherwise specified, select the primary keys as sharding columns. If the primary key is not load-balanced, select load-balanced fields with unique identifiers as sharding columns to avoid potential performance issues. Sharding columns can be used for the following purposes:

          • Load balancing: Threads used for sending messages can be recognized based on the sharding columns if the destination table supports concurrent writes.

          • Orderliness: The data transmission service ensures that messages are received in order if the values of the sharding columns are the same. The orderliness specifies the sequence of executing DML statements for a column.

        • In the Select Columns section, select the columns to be synchronized. For more information, see Column filtering.

        Remove one or all objects

        The data transmission service allows you to remove a single object or all synchronization objects that are added to the right-side list during data mapping.

        • Remove a single synchronization object

          In the list on the right, move the pointer over the object that you want to remove, and click Remove to remove the synchronization object.

        • Remove all synchronization objects

          In the list on the right, click Remove All in the upper-right corner. In the dialog box that appears, click OK to remove all synchronization objects.

    6. Click Next. On the Synchronization Options page, configure the parameters.

      • Full synchronization

        The following table describes the parameters for full synchronization, which are displayed only if you have selected Full Synchronization on the Select Synchronization Type page.

        image

        Parameter

        Description

        Read Concurrency Configuration

        The concurrency for reading data from the source during full synchronization. The maximum value is 512. A high concurrency may incur excessive stress on the source, thereby affecting the business.

        Write Concurrency Configuration

        The concurrency for writing data to the destination during full synchronization. The maximum value is 512. A high write concurrency may incur excessive stress on the destination, affecting the business.

        Full Synchronization Rate Limit

        You can choose whether to limit the full synchronization rate as needed. If you choose to limit the full synchronization rate, you must specify the records per second (RPS) and bytes per second (BPS). The RPS specifies the maximum number of data rows synchronized to the destination per second during full synchronization, and the BPS specifies the maximum amount of data in bytes synchronized to the destination per second during full synchronization.

        Note

        The RPS and BPS values specified here are only for throttling. The actual full synchronization performance is subject to factors such as the settings of the source and destination and the instance specifications.

      • Incremental synchronization

        The following table describes the incremental synchronization parameters, which are displayed only if you have selected Incremental Synchronization on the Select Synchronization Type page.

        image

        Parameter

        Description

        Write Concurrency Configuration

        The concurrency for writing data to the destination during incremental synchronization. The maximum value is 512. A high write concurrency may incur excessive stress on the destination, affecting the business.

        Incremental Synchronization Rate Limit

        You can choose whether to limit the incremental synchronization rate as needed. If you choose to limit the incremental synchronization rate, you must specify the RPS and BPS. The RPS specifies the maximum number of data rows synchronized to the destination per second during incremental synchronization, and the BPS specifies the maximum amount of data in bytes synchronized to the destination per second during incremental synchronization.

        Note

        The RPS and BPS values specified here are only for throttling. The actual incremental synchronization performance is subject to factors such as the settings of the source and destination and the instance specifications.

        Incremental Synchronization Start Timestamp

        • This parameter will not be displayed if you have selected Full Synchronization.

        • If you have selected Incremental Synchronization but not Full Synchronization, specify a point in time after which data is to be synchronized. The default value is the current system time. For more information, see Set an incremental synchronization timestamp.

      • Advanced parameters

        image

        Parameter

        Description

        Serialization Method

        The message format for synchronizing data to the destination RocketMQ instance. Valid values: Default, Canal, DataWorks (version 2.0 supported), SharePlex, DefaultExtendColumnType, Debezium, DebeziumFlatten, and DebeziumSmt. For more information, see Data formats.

        Important

        Only MySQL tenants of OceanBase Database support Debezium, DebeziumFlatten, and DebeziumSmt.

        Partitioning Rules

        When you synchronize data to a RocketMQ instance, only Hash is supported. Hash indicates that the data transmission service uses a hash algorithm to select a message queue of RocketMQ based on the value of the primary key or sharding column.

        Business System Identification (Optional)

        Identifies the source business system of data. The business system identifier consists of 1 to 20 characters.

      • Destination

        image

        Parameter

        Description

        Enter the name of the producer group

        Specifies a producer group that can write data into multiple topics.

        Whether to Allow Message Tracing

        Specifies whether to allow message tracing. If message tracing is enabled, you can trace the complete project information, including node time and status, of a message in its entire lifecycle from transmission to the RocketMQ server by the producer to consumption by consumers. The message tracing feature provides data support for troubleshooting in the production environment.

    7. Click Precheck.

      During the precheck, the data transmission service detects the connection with the destination data source. If an error is returned during the precheck, you can perform the following operations:

      • Identify and troubleshoot the problem and then perform the precheck again.

      • Click Skip in the Actions column of the failed precheck item. In the dialog box that prompts the consequences of the operation, click OK.

    8. After the precheck succeeds, click Start Project.

      If you do not need to start the project now, click Save. You can manually start the project on the Synchronization Projects page or by performing batch operations later. For more information about the batch operations, see Perform batch operations on data synchronization projects.

      The data transmission service allows you to modify the synchronization objects when a synchronization project is running. For more information, see View and modify synchronization objects. After the data synchronization project is started, it will be executed based on the selected synchronization types. For more information, see View synchronization details.

    If the data synchronization project encounters a running exception due to a network failure or slow startup of processes, you can click Recover on the Synchronization Projects page or on the Details page of the synchronization project.

    References