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.

Workspaces in 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.

Note Currently, only SQL Server 2005 and later are supported. When you add connections for SQL Server data stores deployed in Virtual Private Clouds (VPCs), note the following information:
  • User-created SQL Server data store
    • You can configure sync nodes that involve such connections. However, connectivity testing is not supported. You can click Complete without testing the connectivity.
    • You must run such sync nodes on custom resource groups. Make sure that the custom resource groups can connect to the data stores.
  • ApsaraDB RDS for SQL Server data store

    You do not need to select the network type, because DataWorks automatically identifies the network type based on the information you enter for the ApsaraDB RDS for SQL Server instance.

Procedure

  1. Log on to the DataWorks console as a workspace administrator, find the target workspace, and then click Data Integration in the Actions column.
  2. In the left-side navigation pane, click Connection to go to the Workspace Manage > Data Source page.
  3. On the Data Source page that appears, click Add Connection in the upper-right corner.
  4. In the Add Connection dialog box that appears, click SQL Server in the Relational Database section.
  5. In the Add SQL Server Connection dialog box that appears, set the parameters.
    The SQL Server connection type can be set to ApsaraDB for RDS or JDBC Connection Mode. You can select a type as required.
    • The following table describes the parameters that appear after you set Connect To to ApsaraDB for RDS.
      Parameter Description
      Connect To The type of the connection. Here, set the value to ApsaraDB for RDS.
      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 cannot exceed 80 characters in length.
      Applicable 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 standard mode.
      Region The region of the ApsaraDB RDS for SQL Server instance.
      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 used to purchase the ApsaraDB RDS for SQL Server instance
      Database Name The name of the database.
      Username The username for logging on to the database.
      Password The password for logging on to the database.
      Note You must add the IP addresses or Classless Inter-Domain Routing (CIDR) blocks that you use to access 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 that appear after you set Connect To to JDBC Connection Mode.
      Parameter Description
      Connect To The type of the connection. Here, set the value to JDBC 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 cannot exceed 80 characters in length.
      Applicable 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 standard mode.
      JDBC URL The Java Database Connectivity (JDBC) URL of the database, in the format of jdbc:sqlserver://ServerIP:Port;DatabaseName=Database.
      Username The username for logging on to the database.
      Password The password for logging on to the database.
  6. Click Test Connection.
  7. After the connectivity test is passed, click Complete.

Note on connectivity testing

  • If the data store is a user-created one deployed on Elastic Compute Service (ECS) instances that reside on a classic network, we recommend that you use a custom resource group to run sync nodes that use the connection. The default resource group does not guarantee that it can connect to the data store over the network.
  • If the data store is deployed in a VPC and you configure the connection in instance mode, the connectivity test checks whether the entered information is correct.
  • In a VPC, if you use an internal address as the JDBC URL to configure the connection, the connectivity test will fail.
  • If you use a public address as the JDBC URL to configure the connection, the connectivity test checks whether the entered information is correct.

What to do next

Now you have learned how to configure an SQL Server connection. You can proceed with the next tutorial. In the next tutorial, you will learn how to configure SQL Server Reader and Writer. For more information, see Configure SQL Server Reader and Configure SQL Server Writer.