All Products
Search
Document Center

Dataphin:Create RocketMQ Data Source

Last Updated:Mar 05, 2025

This topic explains how to create a RocketMQ data source, enabling Dataphin to read from or write to RocketMQ, thus facilitating business data management.

Background information

RocketMQ, also known as Alibaba Cloud Message Queue RocketMQ Edition, is a distributed platform that offers low-latency, high-concurrency, and reliable processing of messages, events, and streams. If you are utilizing Alibaba Cloud Message Queue RocketMQ Edition, you must create a RocketMQ data source before you can integrate it with Dataphin for data development. For more information about Alibaba Cloud Message Queue RocketMQ Edition, see What is Cloud Message Queue RocketMQ Edition.

Permissions description

Creation of data sources is supported for custom global roles with the Create Data Source permission and system roles such as super administrator, data source administrator, section architect, and project administrator.

Procedure

  1. On the Dataphin home page, click the top menu bar Management Center > Datasource Management.

  2. On the Datasource page, click + Create Data Source.

  3. In the Create Data Source dialog box, in the Message Queue area, select RocketMQ.

    If you have recently used RocketMQ, you can also select it in the Recently Used area. Alternatively, enter RocketMQ in the search box for a quick search.

  4. In the Create RocketMQ Data Source dialog box, configure the connection parameters for the data source.

    1. Configure the basic information for the data source.

      Parameter

      Description

      Datasource Name

      The naming conventions are as follows:

      • Can only contain Chinese characters, uppercase and lowercase English letters, numbers, underscores (_), or hyphens (-).

      • Cannot exceed 64 characters in length.

      Datasource Code

      After configuring the data source encoding, you can reference tables in the data source in Flink_SQL tasks using the format Datasource Code.Table Name or Datasource Code.Schema.Table Name. If you need to automatically access the data source corresponding to the environment, use the variable format ${Datasource Code}.table or ${Datasource Code}.schema.table. For more information, see Dataphin Data Source Table Development Method.

      Important
      • Once the data source encoding is successfully configured, it cannot be modified.

      • After the data source encoding is successfully configured, data preview can be performed on the object details page of the asset directory and asset checklist.

      • In Flink SQL, currently only MySQL, Hologres, MaxCompute, Oracle, StarRocks, Hive, and SelectDB data sources are supported.

      Datasource Description

      A brief description of the data source. Must not exceed 128 characters.

      Datasource Configuration

      Select the data source to be configured:

      • If the business data source distinguishes between production data source and development data source, select Production + Development Data Source.

      • If the business data source does not distinguish between production data source and development data source, select Production Data Source.

    2. Configure the connection parameters between the data source and Dataphin.

      If your data source configuration selects Production + Development Data Source, you need to configure the connection information for Production + Development Data Source. If your data source configuration is Production Data Source, you only need to configure the connection information for Production Data Source.

      Note

      Typically, the production and development data sources should be separate to ensure environment isolation and minimize the impact of development activities on the production environment. However, Dataphin also allows for the same data source configuration, using identical parameter values.

      Parameter

      Description

      Endpoint

      The endpoint of the RocketMQ instance. You can view the endpoint on the Message Queue RocketMQ Edition Console on the Instance Details page. It is recommended to select the endpoint corresponding to the intranet access under the TCP protocol client access point.

      Important

      When the RocketMQ instance and Dataphin instance are in the same region, only then can you use the intranet access corresponding to the endpoint.

      Instance ID

      The ID of the RocketMQ instance. You can view the instance ID on the Message Queue RocketMQ Edition Console on the Instance Details page.

      Access ID, Access Key

      The AccessKey ID and AccessKey Secret of the account where the RocketMQ data source is located. For information on how to obtain them, see Create AccessKey.

      Important

      Please note that testing the connection between the RocketMQ data source and Dataphin is not supported during creation. Ensure the accuracy of the connection information provided.

  5. Click OK to finalize the creation of the RocketMQ data source.