This topic describes how to add an ApsaraDB RDS for SQL Server data source in DataWorks.

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 SQLServer in the Relational Database section.
  4. In the Add SQLServer data source dialog box, configure the parameters.
    You can use one of the following modes to add an SQL Server data source: Alibaba Cloud instance mode and Connection string mode.
    • The following table describes the parameters you must configure if you add an SQL Server data source by using the Alibaba Cloud instance mode.Alibaba Cloud instance mode
      ParameterDescription
      Data source typeThe type of the data source. Set the value to Alibaba Cloud instance 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 a maximum of 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.
      RegionThe region where the data source resides.
      RDS instance IDThe ID of the ApsaraDB RDS for SQL Server instance. You can log on to the ApsaraDB RDS console to view the ID.
      RDS instance account IDThe ID of the Alibaba Cloud account that is used to purchase the ApsaraDB RDS for SQL Server instance.
      Database nameThe name of the ApsaraDB RDS for SQL Server database.
      User nameThe username that you use to connect to the database.
      PasswordThe password that you use to connect to the database.
      Note You must add the IP addresses or Classless Inter-Domain Routing (CIDR) blocks that you use to connect to the ApsaraDB RDS for SQL Server instance to a whitelist of the instance. For more information, see Configure a whitelist.
    • The following table describes the parameters you must configure if you add an SQL Server data source by using the connection string mode. JDBC
      ParameterDescription
      Data source typeThe type of the data source. Set the value 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 a maximum of 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.
      JDBC URLThe Java Database Connectivity (JDBC) URL of the database, in the format of jdbc:sqlserver://ServerIP:Port;DatabaseName=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. After the data source passes the connectivity test, click Complete.