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

Background information

Workspaces in standard mode support the data source isolation feature. You can add data sources for the development and production environments separately and isolate the data sources to protect your data security. 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. In the top navigation bar, select the region where your workspace resides. Find your 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 New 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, set the parameters as required.
    You can set the Data source type parameter to Alibaba Cloud instance mode or Connection string mode for an SQL Server connection
    • The following table describes the parameters that are displayed after you set the Data source type parameter to Alibaba Cloud instance mode. Alibaba Cloud instance mode
      Parameter Description
      Data source type The type of the connection. Set this parameter to Alibaba Cloud instance mode.
      Data Source 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.
      Applicable environment The environment in which the connection is used. Valid values: Development and Production.
      Note This parameter is displayed only when the workspace is in standard mode.
      Region The region where the ApsaraDB RDS for SQL Server instance resides.
      RDS instance ID The ID of the ApsaraDB RDS for SQL Server instance. You can view the ID in the ApsaraDB for RDS console.
      RDS instance account ID The ID of the Alibaba Cloud account that is used to purchase the ApsaraDB RDS for SQL Server instance.
      Database name The name of the database.
      User name The username that you can use to connect to the database.
      Password The password that you can 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 whitelists.
    • The following table describes the parameters that are displayed after you set the Data source type parameter to Connection string mode.JDBC
      Parameter Description
      Data source type The type of the connection. Set this parameter to Connection string mode.
      Data Source 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.
      Applicable environment The environment in which the connection is used. Valid values: Development and Production.
      Note This parameter is displayed only when the workspace is in standard mode.
      JDBC URL The Java Database Connectivity (JDBC) URL of the database, in the format of jdbc:sqlserver://ServerIP:Port;DatabaseName=Database.
      User name The username that you can use to connect to the database.
      Password The password that you can use to connect to the database.
  5. On the Data Integration tab, click Test connectivity in the Operation column of each resource group.
    A sync node uses only one resource group. To ensure that your sync nodes can be properly run, you must test the connectivity of all the resource groups for Data Integration on which your sync nodes will be run. If you need 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 Test data store connectivity.
  6. After the connection passes the connectivity test, click Complete.

What to do next

You have learned how to configure an SQL Server connection. You can now proceed with the next tutorial. The next tutorial describes how to configure SQL Server Reader and Writer. For more information, see SQLServer Reader and SQLServer Writer.