Updated on 2025-07-25 GMT+08:00

Open Gauss Connection Parameters

Table 1 RDS connection

Parameter

Mandatory

Description

Data Connection Type

Yes

Open Gauss 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 (-).

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.

Basic and 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 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.

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 MySQL, 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?.
  • 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 encrypted transmission.

Data Source Driver Configuration

Driver Name

Yes

Driver name

com.huawei.opengauss.jdbc.Driver: Select this driver name for RDS for GaussDB.

Driver Source

Yes

Source of the driver file

Driver File Path

Yes

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

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.

GaussDB driver: Search for "JDBC Package, Driver Class, and Environment Class" in GaussDB Documentation, select the document corresponding to the instance version, and obtain the driver package by referring to the document.

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.

Driver File

Yes

This parameter is mandatory when Driver Source is set to Local file.

You can download a driver file from the official driver website, and then click Select and upload the driver. Alternatively, you can select a driver that has been uploaded before.

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.

Automatic Metadata Collection

Yes

If this function is enabled, metadata will be collected from all tables in all databases. If there are a large number of databases and tables, the collection will take a long time. After a collection task is automatically generated, you can edit and schedule the task in DataArts Catalog. By default, the task is scheduled once.

DataArts Migration Configuration

Database Name

Yes

Name of the database to connect

Fetch Size

Yes

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.

Reference Sign

Yes

Database enclosure character. For some databases, the value is case sensitive. Leave this parameter blank if no enclosure character is required. The default value is ".