Help Center/ ROMA Connect/ API Reference/ Data Integration APIs/ Data Source Management/ Testing SQL
Updated on 2025-03-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Testing SQL

Function

This API is used to test whether the SQL data source is available.

URI

POST /v2/{project_id}/fdi/instances/{instance_id}/datasources/{datasource_id}/test-sql

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID

datasource_id

Yes

String

Data source ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

sql

No

String

The SQL data source pending testing.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

columns

Array of ColumnInfo objects

The SQL data source pending testing.
Table 5 ColumnInfo

Parameter

Type

Description

field_name

String

Field name.

field_type

String

Field type.

field_length

String

Field length.

null_able

String

Indicates whether it can be null.

is_partition

Boolean

Whether it is a partition field.

primary

String

Whether it is a primary key field.

unique

String

Whether it is a unique key field.

decimal_digits

String

Number of decimal places. If the value is not a number, null is returned.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

detail

String

Description details.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Error response

404

Not Found

Error Codes

See Error Codes.

Parent topic: Data Source Management