Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Databases coordinates as present in the SQL, e.g. db.schema.table
Response
200 - application/json
Success
curl --request POST \
--url https://developer.synq.io/api/coordinates/v1/database/by-fqn \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"sqlFqn": [
"<string>"
]
}'
{
"matchedCoordinates": [
{
"sqlFqn": "<string>",
"candidates": [
{
"identifiers": [
{
"airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
}
}
],
"synqPaths": [
"<string>"
],
"dialectName": "<string>",
"dialect": "SQL_DIALECT_UNSPECIFIED",
"dataPlatform": {
"bigquery": {
"project": "<string>"
}
},
"dataPlatformType": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"connectionId": "<string>",
"instanceName": "<string>",
"databaseName": "<string>",
"schemaName": "<string>",
"objectName": "<string>",
"sqlFqn": "<string>"
}
]
}
]
}
Given database FQN return possible entity ids.
curl --request POST \
--url https://developer.synq.io/api/coordinates/v1/database/by-fqn \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"sqlFqn": [
"<string>"
]
}'
{
"matchedCoordinates": [
{
"sqlFqn": "<string>",
"candidates": [
{
"identifiers": [
{
"airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
}
}
],
"synqPaths": [
"<string>"
],
"dialectName": "<string>",
"dialect": "SQL_DIALECT_UNSPECIFIED",
"dataPlatform": {
"bigquery": {
"project": "<string>"
}
},
"dataPlatformType": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"connectionId": "<string>",
"instanceName": "<string>",
"databaseName": "<string>",
"schemaName": "<string>",
"objectName": "<string>",
"sqlFqn": "<string>"
}
]
}
]
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Databases coordinates as present in the SQL, e.g. db.schema.table
Success
Show child attributes