Help Center> Cloud Data Migration> API Reference> Public Data Structures> Link Parameter Description> Link to a Relational Database
View PDF

Link to a Relational Database

Description

By creating a JDBC link, you can extract data from or load data to the following relational databases:
  • Data Warehouse Service
  • RDS for MySQL
  • RDS for PostgreSQL
  • RDS for SQL Server
  • MySQL
  • PostgreSQL
  • Microsoft SQL Server
  • Oracle
  • IBM Db2
  • FusionInsight LibrA
  • Derecho (GaussDB)
  • NewSQL (GaussDB)
  • SAP HANA
  • MYCAT
  • Dameng database
  • Sharding

Sample Link

{
    "links": [
        {
            "link-config-values": {
                "configs": [
                    {
                        "inputs": [
                            {
                                "name": "linkConfig.databaseType",
                                "value": "MYSQL"
                            },
                            {
                                "name": "linkConfig.host",
                                "value": "10.120.205.30"
                            },
                            {
                                "name": "linkConfig.port",
                                "value": "3306"
                            },
                            {
                                "name": "linkConfig.database",
                                "value": "DB_name"
                            },
                            {
                                "name": "linkConfig.username",
                                "value": "username"
                            },
                            {
                                "name": "linkConfig.password",
                                "value": "Add password here"
                            },
                            {
                                "name": "linkConfig.fetchSize",
                                "value": "100000"
                            },
                            {
                                "name": "linkConfig.usingNative",
                                "value": "false"
                            },
                            {
                                "name": "linkConfig.useSSL",
                                "value": "false"
                            }
                        ],
                        "name": "linkConfig"
                    }
                ]
            },
            "name": "mysql_link",
            "connector-name": "generic-jdbc-connector"
        }
    ]
}

Link Parameters

Parameter

Mandatory

Type

Description

linkConfig.databaseType

Yes

Enumeration

Database type. The options are as follows:

  • ORACLE
  • MYSQL
  • SQLSERVER
  • DB2
  • POSTGRESQL
  • GAUSSDB
  • DWS
  • DDM
  • SAP HANA

linkConfig.host

No

String

IP address of the database server

linkConfig.port

No

String

Port number of the database server

linkConfig.databaseconfig

No

Enumeration
Oracle database link type. This parameter is available only when an Oracle link is created. The options are as follows:
  • SERVICENAME: Use SERVICE_NAME to connect to the Oracle database.
  • SID: Use SID to connect to the Oracle database.

linkConfig.sidname

No

String

Oracle instance ID, which is used to differentiate databases by instances. This parameter is available only when an Oracle link is created and the database link type linkConfig.databaseconfig is set to SID.

linkConfig.database

No

String

Database name

linkConfig.username

Yes

String

Username

linkConfig.password

Yes

String

Password

linkConfig.fetchSize

No

String

Number of data rows obtained each time

linkConfig.usingNative

No

Boolean

Whether to use the local API acceleration function of the database

When creating a MySQL link, you can use the LOAD DATA function of MySQL to accelerate data import and improve the performance of importing data to the MySQL database.

linkConfig.useSSL

No

Boolean

Whether to use encrypted transmission. You can enable SSL encrypted transmission for Relational Database Service (RDS).

linkConfig.jdbcProperties

No

Map

Link attribute, which specifies the JDBC connector attributes of the data source. For details about how to configure the link attributes, see the JDBC connector description of the corresponding database.

linkConfig.version

No

Enumeration

Oracle database version. This parameter is available only when you create an Oracle link. The options are as follows:

  • HIGH_VERSION: Select this value if the Oracle database version is later than 12.1.
  • MED_VERSION: Select this value if the Oracle database version is 12.1.
  • LOW_VERSION: Select this value if the Oracle database version is earlier than 12.1.

If error message "java.sql.SQLException: Protocol violation" is displayed, select another option.

dialect.identifierEnclose

No

String

Reference identifier, which is the delimiter between the referenced table names or column names. For details, see the product documentation of the corresponding database.

linkConfig.importMode

No

Enumeration

Data import mode. This parameter is available only when the database type is DWS.

  • GDS: In GDS mode, port 25000 is enabled on CDM, and multiple DWS DataNodes extract data from CDM.
  • COPY: In COPY mode, CDM copies data to DWS by using the JDBC API of DWS.