Help Center/ DataArts Studio/ User Guide/ Management Center/ Configuring DataArts Studio Data Connection Parameters/ RDS(SQL Server) Connection Parameters
Updated on 2026-08-17 GMT+08:00
View PDF
Share

RDS(SQL Server) Connection Parameters

RDS(SQL Server) connections can connect to databases such as RDS for SQL Server and on-premises SQL Server databases.

Table 1 RDS connection

Parameter

Mandatory

Description

Data Connection Type

Yes

For RDS(SQL Server) connections, RDS(SQL Server) is selected and cannot be changed.

Name

Yes

Name of the data connection to create. Data connection names can contain a maximum of 100 characters. They can contain only letters, digits, underscores (_), and hyphens (-).

Description

No

A description which can help identify the data connection more easily. It can contain a maximum of 100 characters.

Tag

No
Attribute of the data connection to create. Tags make management easier.
NOTE:

The tag name can contain only letters, digits, and underscores (_) and cannot start with an underscore (_) or contain more than 100 characters.

Applicable Modules

Yes

Select the modules for which this connection is available.

NOTE:
  • When offline or real-time data migration jobs are enabled, you can select the DataArts Migration module. Then you can select this data connection when creating a data migration job in DataArts Factory.
  • You can use offline or real-time data migration jobs only after you apply for the whitelist membership. To use this feature, contact customer service or technical support.

Network Connectivity Configuration

IP Address or Domain Name

Yes

Address for accessing the relational database through an internal network. Enter an IP address or domain name.

  • If the data source is RDS, you can obtain the address on the management console by performing the following operations:
    1. Log in to the management console of the corresponding cloud service using the account you have obtained.
    2. In the left navigation pane, choose Instances.
    3. Click the name of an instance to enter the basic information page. In the Connection Information area, you can obtain the private IP address, domain name, and port number.
  • If the data source is an on-premises SQL Server, you can obtain the access address from the database administrator.

Port

Yes

Port for accessing the relational database Ensure that you have enabled this port in the security group rule so that the DataArts Studio instance can connect to this database through this port.

  • If the data source is RDS, you can obtain the address on the management console by performing the following operations:
    1. Log in to the management console of the corresponding cloud service using the account you have obtained.
    2. In the left navigation pane, choose Instances.
    3. Click the name of an instance to enter the basic information page. In the Connection Information area, you can obtain the private IP address, domain name, and port number.
  • If the data source is an on-premises SQL Server, you can obtain the access address from the database administrator.

KMS encryption key

Yes
KMS key used to encrypt and decrypt data source authentication information. Select a default or custom key.
NOTE:
  • When you use KMS for encryption through DataArts Studio or KPS for the first time, the default key dlf/default or kps/default is automatically generated. For more information about default keys, see What Is a Default Master Key?.
  • Only symmetric keys are supported. Asymmetric keys are not supported.

Agent

Yes

RDS is not a fully managed service and cannot be directly connected to DataArts Studio. A CDM cluster can provide an agent for DataArts Studio to communicate with non-fully-managed services. Therefore, you need to select a CDM cluster when creating an RDS data connection. If no CDM cluster is available, create one first by referring to Creating a CDM Cluster.

As a network proxy, the CDM cluster must be able to communicate with RDS. To ensure network connectivity, the CDM cluster must be in the same region and AZ and use the same VPC and subnet as RDS. The security group rule must also allow the CDM cluster to communicate with RDS.

NOTE:

If a CDM cluster functions as the agent for a data connection in Management Center, the cluster supports a maximum of 200 concurrent active threads. If multiple data connections share an agent, a maximum of 200 SQL, Shell, and Python scripts submitted through the connections can run concurrently. Excess tasks will be queued. You are advised to plan multiple agents based on the workload.

SSL Encryption

No

Whether to enable SSL encryption

Data Source Driver Configuration

Driver Name

Yes

com.microsoft.sqlserver.jdbc.SQLServerDriver: Select this driver name for SQL Server.

Driver File Path

Yes

This parameter is mandatory when Driver File Source is set to OBS path.

Path of the driver file in the OBS bucket. You need to download the .jar driver file from the corresponding official website and upload it to the OBS bucket. You can download the .jar driver file from the official website and then upload it.

Download the SQL Server driver from https://learn.microsoft.com/en-us/sql/connect/jdbc/download-microsoft-jdbc-driver-for-sql-server?view=sql-server-ver16. Upload the driver file marked with .jre8. The 8.4.1 version is recommended.

NOTE:
  • The OBS path of the driver file cannot contain Chinese characters.
  • For security purposes, the system checks the SHA512 value and byte size of the selected driver file. If the driver file is not in the allowlist of Management Center, an error message will be displayed. You are advised to use the driver file of the recommended version or contact customer service or technical support.
  • To update the driver, you must restart the CDM cluster in DataArts Migration and then edit the data connection to upload the driver.

Data Source Authentication and Other Function Configuration

Username

Yes

Username of the database. The username is required for creating a cluster.

Password

Yes

Password for accessing the database. The password is required for creating a cluster.

DataArts Migration Configuration

Database Name

Yes

Name of the database to connect

Fetch Size

No

Set the number of rows obtained by each request. Set this parameter based on the data source and the job's data size. This parameter is optional. If the value is either too large or too small, the job may run for a long time. The default value is 1000.

Link Attributes

No

This parameter is optional. Click Add to add the JDBC connector attributes of multiple specified data sources. For details, see the JDBC connector document of the corresponding database.

Examples for SQL Server:
  • connectTimeout=60 and socketTimeout=300: When a large amount of data needs to be migrated or the entire table is retrieved using query statements, the migration fails due to connection timeout. In this case, you can customize the connection timeout interval (ms) and socket timeout interval (ms) to prevent failures caused by timeout.

    In addition, some driver versions may not support the socketTimeout parameter. You are advised to use sqljdbc9.4.jar or a later driver version.

  • useCursorFetch=false: By default, useCursorFetch is true, indicating that the JDBC connector communicates with relational databases using a binary protocol. Some third-party systems may have compatibility issues, causing migration time conversion errors. In this case, you can disable this function.
  • trustServerCertificate=true: A PKIX error may be reported during the creation of a secure connection. You are advised to set this parameter to true.
  • jdbc.read.timestamp.with.time.zone.switch=false: specifies whether to retain the time zone information when extracting data of the TIMESTAMPTZ type.

    The default value is false, indicating that the time zone information is not retained. If this parameter is set to true, the time zone information is retained. Generally, DataArts Migration handles the time zone properly. If the time zone information is lost during data synchronization to the destination (for example, 2026-07-21 10:30:00.123456+08:00 changes to 2026-07-21 10:30:00.123456), you are advised to set this parameter to true.

Reference Sign

No

(Optional) Delimiter between the names of the referenced tables or columns. For details, see the product documentation of the corresponding database. The default value is ".