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 a data source in 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. In the top navigation bar, select the region in which the workspace you want to manage resides. On the Workspaces page, find the workspace, move the pointer over the More icon in the Actions column, and then select Workspace Settings.
    4. In the left-side navigation pane of the page that appears, click Data Source to go to the Data Source page.
    Note You can also go to the Data Sources page in Data Integration to add a data source. However, you can add a data source on the Data Sources page in Data Integration only to the production environment.
  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
      ParameterDescription
      Data source typeThe mode in which the data source is added. Set this parameter to Alibaba Cloud Database (POLARDB).
      Data Source NameThe name of the data source. The name can contain letters, digits, and underscores (_) and must start with a letter.
      Data source descriptionThe description of the data source. The description can be up to 80 characters in length.
      EnvironmentThe 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 IDThe ID of the PolarDB cluster. You can log on to the PolarDB console to view the ID.
      POLARDB instance master account IDThe 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 nameThe name of the PolarDB database.
      User nameThe username that you use to connect to the database.
      PasswordThe 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. polardb连接串
      ParameterDescription
      Data source typeThe mode in which the data source is added. Set this parameter to Connection string mode.
      Data Source NameThe name of the data source. The name can contain letters, digits, and underscores (_) and must start with a letter.
      Data source descriptionThe description of the data source. The description can be up to 80 characters in length.
      EnvironmentThe 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 typeThe type of the database. Valid values: MySql and PostgreSql.
      JDBC URLThe Java Database Connectivity (JDBC) URL of the database. Specify this parameter in the format of jdbc:mysql://ServerIP:Port/Database.
      User nameThe username that you use to connect to the database.
      PasswordThe 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
      ParameterDescription
      Data source typeThe mode in which the data source is added. Set this parameter to DMS Mode.
      Data Source NameThe name of the data source. The name can contain letters, digits, and underscores (_) and must start with a letter.
      Data source descriptionThe description of the data source. The description can be up to 80 characters in length.
      EnvironmentThe 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_idThe 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 typeThe type of the database. Default value: MySql.
      RegionThe region in which the data source resides.
      Database nameThe name of the PolarDB database.
      User nameThe username that you use to connect to the database.
      PasswordThe 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 Establish a network connection between a resource group and a data source.
    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. If the data source passes the network 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.