Updated on 2025-09-09 GMT+08:00

GBase Connection Parameters

Table 1 GBase connection

Parameter

Mandatory

Description

Data Connection Type

Yes

GBASE 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 (-).

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.

Basic and Network Connectivity Configuration

IP Address or Domain Name

Yes

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

Port

Yes

Port for accessing the relational database

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

The CDM cluster provides an agent for communication between DataArts Studio and GBase. When creating a GBase connection, select a CDM cluster. If no CDM cluster is available, create one first by referring to Creating a CDM Cluster.

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.

Data Source Driver Configuration

Driver Name

Yes

Driver name

com.gbase.jdbc.Driver: Select this driver name for GBASE8A.

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.

  • GBASE8A driver: Obtain the driver from the following path:
  • https://www.gbase.cn/download/gbase-8a?category=DRIVER_PACKAGE. Version 8.3.81.53 is recommended.
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.

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.

Commit Size

No

Number of records submitted each time. Set this parameter based on the data destination and the job's data size. If the value is either too large or too small, the job may run for a long time.

Link Attributes

No

The following are some examples:
  • connectTimeout=360000 and socketTimeout=360000: 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.
  • tinyInt1isBit=false or mysql.bool.type.transform=false: By default, tinyInt1isBit is true, indicating that TINYINT(1) is processed as a bit, that is, Types.BOOLEAN, and 1 or 0 is read as true or false. As a result, the migration fails. In this case, you can set tinyInt1isBit to false to avoid migration failures.
  • useCursorFetch=false: By default, useCursorFetch is set to 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. Open-source MySQL databases support the useCursorFetch parameter, and you do not need to set this parameter.
  • allowPublicKeyRetrieval=true: By default, public key retrieval is disabled for MySQL databases. If TLS is unavailable and an RSA public key is used for encryption, connection to a MySQL database may fail. In this case, you can enable public key retrieval to avoid connection failures.

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 ".