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
Show child attributes
Identifier is a unique reference to an entity in SYNQ system. Entity identifiers are designed to closely mimic identifiers used by data platforms and tools. To construct an identifier, you need to know the kind of the entity and the ids that you would normally use to identify it in the data platform or tool. For example, to identify a table in BigQuery, you would need to know the project, dataset, and table names.
Show child attributes
SQL_DIALECT_UNSPECIFIED, SQL_DIALECT_BIGQUERY, SQL_DIALECT_CLICKHOUSE, SQL_DIALECT_DATABRICKS, SQL_DIALECT_MYSQL, SQL_DIALECT_POSTGRESQL, SQL_DIALECT_REDSHIFT, SQL_DIALECT_SNOWFLAKE, SQL_DIALECT_DUCKDB, SQL_DIALECT_TRINO DataPlatformIdentifier is a unique reference to a data platform integrated with Synq.
DATA_PLATFORM_TYPE_UNSPECIFIED, DATA_PLATFORM_TYPE_BIGQUERY, DATA_PLATFORM_TYPE_LOOKER, DATA_PLATFORM_TYPE_DBT, DATA_PLATFORM_TYPE_DBT_CLOUD, DATA_PLATFORM_TYPE_DBT_SELF_HOSTED, DATA_PLATFORM_TYPE_SNOWFLAKE, DATA_PLATFORM_TYPE_GCP, DATA_PLATFORM_TYPE_GIT, DATA_PLATFORM_TYPE_REDSHIFT, DATA_PLATFORM_TYPE_TABLEAU, DATA_PLATFORM_TYPE_AIRFLOW, DATA_PLATFORM_TYPE_CLICKHOUSE, DATA_PLATFORM_TYPE_POSTGRES, DATA_PLATFORM_TYPE_MYSQL, DATA_PLATFORM_TYPE_DATABRICKS, DATA_PLATFORM_TYPE_SQLMESH, DATA_PLATFORM_TYPE_DUCKDB, DATA_PLATFORM_TYPE_TRINO, DATA_PLATFORM_TYPE_ATLAN, DATA_PLATFORM_TYPE_COALESCE, DATA_PLATFORM_TYPE_CASTORDOC, DATA_PLATFORM_TYPE_SYNQ