An ApsaraDB for OceanBase connection allows you to read data from and write data to ApsaraDB for OceanBase by using ApsaraDB for OceanBase Reader and Writer. You can configure sync nodes for ApsaraDB for OceanBase by using the codeless user interface (UI) or code editor.

Background information

Workspaces in the standard mode support the connection isolation feature. You can add connections for the development and production environments separately and isolate the connections to protect your data security. For more information, see Connection isolation.

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 where the target workspace resides. Find the target workspace and click Data Integration in the Actions column.
    4. On the page that appears, click Connection in the left-side navigation pane. The Data Source page appears.
  2. On the Data Source page, click Add a Connection in the upper-right corner.
  3. In the Add Connection dialog box that appears, click ApsaraDB for OceanBase in the Relational Database section.
  4. In the Add ApsaraDB for OceanBase Connection dialog box that appears, set the parameters as required.
    The values that are optional for the Connect To parameter include ApsaraDB for Oceanbase and Connection Mode.
    • The following table describes the parameters that you need to set if you select ApsaraDB for Oceanbase for Connect To.OceanBase
      Parameter Description
      Connect To The type of the connection. In this example, select ApsaraDB for Oceanbase.
      Connection Name The name of the connection. The name can contain letters, digits, and underscores (_) and must start with a letter.
      Description The description of the connection. The description can be up to 80 characters in length.
      Environment The environment in which the connection is used. Valid values: Development and Production.
      Note This parameter is available only when the workspace is in the standard mode.
      Region The region of the ApsaraDB for OceanBase cluster.
      Cluster The ID of the ApsaraDB for OceanBase cluster. You can view the cluster ID in the ApsaraDB for OceanBase console.
      Tenant The ID of the tenant. You can view the tenant ID in the ApsaraDB for OceanBase console.
      Account ID The ID of the Alibaba Cloud account. To obtain the ID, follow these steps: Log on to the DataWorks console, move the pointer over the profile picture in the upper-right corner, and then click Security Settings. On the Security Settings page that appears, view the value of Account ID, which is the ID of your Alibaba Cloud account.
      Database Name The name of the ApsaraDB for OceanBase database.
      Username The username for logging on to the database.
      Password The password for logging on to the database.
    • The following table describes the parameters that you need to set if you select Connection Mode for Connect To.Connection Mode
      Parameter Description
      Connect To The type of the connection. In this example, select Connection Mode.
      Connection Name The name of the connection. The name can contain letters, digits, and underscores (_) and must start with a letter.
      Description The description of the connection. The description can be up to 80 characters in length.
      Environment The environment in which the connection is used. Valid values: Development and Production.
      Note This parameter is available only when the workspace is in the standard mode.
      JDBC URL The Java Database Connectivity (JDBC) URL of the ApsaraDB for OceanBase database, in the format jdbc:oceanbase://ip:port/database.
      Username The username for logging on to the database.
      Password The password for logging on to the database.
  5. Click Test Connection in the Actions column of each resource group.
    A sync node only uses one resource group. Therefore, you must test the connectivity of all the resource groups for Data Integration that your sync nodes use to connect to the data store so that sync nodes can run properly. For more information, see Test data store connectivity.
  6. After the connection passes the connectivity test, click Complete.

What to do next

Now you have learned how to configure an ApsaraDB for OceanBase connection. You can proceed with the next tutorial to configure ApsaraDB for OceanBase Reader and Writer. For more information, see Configure ApsaraDB for OceanBase Reader and Configure ApsaraDB for OceanBase Writer.