DataWorks provides PolarDB Reader and PolarDB Writer for you to read data from and write data to PolarDB data sources. You can use the codeless user interface (UI) or code editor to configure sync nodes for PolarDB data sources.

Background information

Workspaces in standard mode support the data source isolation feature. You can add data sources separately for the development and production environments to isolate the data sources. This helps keep your data secure. For more information, see Isolate connections between the development and production environments.

Procedure

  1. Go to the Data Source page.
    1. Log on to the DataWorks console.
    2. In the left-side navigation pane, click Workspaces.
    3. After you select the region where the required workspace resides, find the workspace and click Data Integration in the Actions column.
    4. In the left-side navigation pane of the Data Integration page, choose Data Source > Data Sources to go to the Data Source page.
  2. On the Data Source page, click Add data source in the upper-right corner.
  3. In the Add data source dialog box, click PolarDB in the Relational Database section.
  4. In the Add PolarDB data source dialog box, set the parameters as required.
    You can use one of the following modes to add a PolarDB data source: Alibaba Cloud Database (POLARDB) and Connection string mode.
    • The following table describes the parameters you can set if you add a PolarDB data source by using the Alibaba Cloud Database (POLARDB) mode. Add a PolarDB data source by using the Alibaba Cloud Database (POLARDB) mode
      Parameter Description
      Data source type The mode in which the data source is added. Set this parameter to Alibaba Cloud Database (POLARDB).
      Data Source Name The name of the data source. The name can contain letters, digits, and underscores (_) and must start with a letter.
      Data source description The description of the data source. The description can be up to 80 characters in length.
      Environment The environment in which the data source is used. Valid values: Development and Production.
      Note This parameter is displayed only when the workspace is in standard mode.
      Cluster ID The ID of the PolarDB cluster. You can log on to the PolarDB console to view the ID.
      POLARDB instance master account ID The ID of the Alibaba Cloud account that is used to purchase the PolarDB cluster. You can use the account to log on to the DataWorks console, move the pointer over the profile picture in the upper-right corner, and then view the ID of the account.
      Database name The name of the PolarDB database.
      User name The username that you use to connect to the database.
      Password The password that you use to connect to the database.
    • The following table describes the parameters you can set if you add a PolarDB data source by using the Connection string mode. Add a PolarDB data source by using the Connection string mode
      Parameter Description
      Data source type The mode in which the data source is added. Set this parameter to Connection string mode.
      Data Source Name The name of the data source. The name can contain letters, digits, and underscores (_) and must start with a letter.
      Data source description The description of the data source. The description can be up to 80 characters in length.
      Environment The environment in which the data source is used. Valid values: Development and Production.
      Note This parameter is displayed only when the workspace is in standard mode.
      Database type The type of the database. Valid values: MySql and PostgreSql.
      JDBC URL The Java Database Connectivity (JDBC) URL of the database. Specify this parameter in the format of jdbc:mysql://ServerIP:Port/Database.
      User name The username that you use to connect to the database.
      Password The password that you use to connect to the database.
    • The following table describes the parameters you must configure if you add a PolarDB data source by using the DMS Mode. Add a PolarDB data source by using the DMS Mode
      Parameter Description
      Data source type The mode in which the data source is added. Set this parameter to DMS Mode.
      Data Source Name The name of the data source. The name can contain letters, digits, and underscores (_) and must start with a letter.
      Data source description The description of the data source. The description can be up to 80 characters in length.
      Environment The environment in which the data source is used. Valid values: Development and Production.
      Note This parameter is displayed only when the workspace is in standard mode.
      owner_id The ID of the Alibaba Cloud account that is used to purchase the PolarDB cluster. You can use the account to log on to the DataWorks console, move the pointer over the profile picture in the upper-right corner, and then view the ID of the account.
      Database type The type of the database. Default value: MySql.
      Region The region in which the data source resides.
      Database name The name of the PolarDB database.
      User name The username that you use to connect to the database.
      Password The password that you use to connect to the database.
  5. Set Resource Group connectivity to Data Integration.
  6. Find the desired resource group in the resource group list in the lower part of the dialog box and click Test connectivity in the Actions column.
    A synchronization node can use only one type of resource group. To ensure that your synchronization nodes can be normally run, you must test the connectivity of all the resource groups for Data Integration on which your synchronization nodes will be run. If you want to test the connectivity of multiple resource groups for Data Integration at a time, select the resource groups and click Batch test connectivity. For more information, see Select a network connectivity solution.
    Note
    • By default, the resource group list displays only exclusive resource groups for Data Integration. To ensure the stability and performance of data synchronization, we recommend that you use exclusive resource groups for Data Integration.
    • If you want to test the network connectivity between the shared resource group or a custom resource group and the data source, click Advanced below the resource group list. In the Warning message, click Confirm. Then, all available shared and custom resource groups appear in the resource group list.
  7. After the data source passes the connectivity test, click Complete.

What to do next

You have learned how to add a PolarDB data source. You can proceed to subsequent tutorials. In subsequent tutorials, you will learn how to configure PolarDB Reader and PolarDB Writer. For more information, see PolarDB Reader and PolarDB Writer.