Help Center/ DataArts Studio/ User Guide/ Management Center/ Configuring DataArts Studio Data Connection Parameters/ RDS Connection Parameters
Updated on 2024-10-28 GMT+08:00
View PDF
Share

RDS Connection Parameters

RDS connections can be used to connect to MySQL, PostgreSQL, and SQL Server databases.

Table 1 RDS connection

Parameter

Mandatory

Description

Data Connection Type

Yes

RDS is selected by default 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 (-).

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 the data migration job feature is 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 processing migration jobs only after apply for the trustlist membership. To use this feature, contact customer service or technical support.

Basic and Network Connectivity Configuration

IP Address or Domain Name

Yes

Address for accessing the relational database data source. The value can be an IP address or a domain name.

If you choose to manually enter an IP address or domain name, you must enter an internal IP address and a port that is accessible to the network segment of the resource group. Otherwise, the network is disconnected.

  • If the data source is RDS or GaussDB, 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.
    NOTE:

    Only the GaussDB data source supports multiple domain names. Use commas (,) to separate multiple domain names.

  • If the data source is MySQL, PostgreSQL, or DM, you can obtain the access address from the database administrator.

Port

Yes

Port for accessing the relational database.

  • If the data source is RDS or GaussDB, 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.
    NOTE:

    Only the GaussDB data source supports multiple domain names. Use commas (,) to separate multiple domain names.

  • If the data source is MySQL, PostgreSQL, or DM, you can obtain the access address from the database administrator.

KMS 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?.

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.

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 encrypted transmission.

Data Source Driver Configuration

Driver Name

Yes

The name of the driver. The following values are available:

  • com.mysql.jdbc.Driver: Select this driver name for RDS for MySQL or MySQL.
  • org.postgresql.Driver: Select this driver name for RDS for PostgreSQL or PostgreSQL.
  • com.microsoft.sqlserver.jdbc.SQLServerDriver: Select this driver name for RDS for SQL Server.
  • dm.jdbc.driver.DmDriver: Select this driver name for the Dameng database.
  • com.huawei.opengauss.jdbc.Driver: Select this driver name for RDS for GaussDB.

Driver file source

Yes

Select the source of the driver file.

Driver File Path

Yes

It specifies the OBS path where the driver file is located. You need to download a .jar driver file from the corresponding official website and upload it to OBS.

NOTE:
  • The OBS path of the driver file cannot contain Chinese characters.
  • 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

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

Password

Yes

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