Refresh a table description#
This endpoint establishes a database connection, retrieves the table names, and merges these records with the existing table-descriptions. It updates the status accordingly: if the table no longer exists, it changes the status to DEPRECATED, and if it is not in the MongoDB collection, it is inserted with a status of NOT_SCANNED.
Request this POST
endpoint:
/api/v1/table-descriptions/refresh
Request body
{
"db_connection_id": "string",
}
Responses
HTTP 201 code response
[{
"id": "string",
"db_connection_id": "string",
"table_name": "string",
"description": "string",
"table_schema": "string",
"status": "NOT_SCANNED | SYNCHRONIZING | DEPRECATED | SCANNED | FAILED"
"error_message": "string",
"table_schema": "string",
"columns": [
{
"name": "string",
"is_primary_key": false,
"data_type": "str",
"description": "string",
"low_cardinality": false,
"categories": [
"string"
],
"foreign_key": {
"field_name": "string",
"reference_table": "string"
}
}
],
"examples": []
}]
Name |
Type |
Description |
---|---|---|
status |
string |
|
error_message |
string |
This field is set only if the async schema process fails |
Request example
curl -X 'GET' \
'<localhost>/api/v1/table-descriptions/64fa09446cec0b4ff60d3ae3 \
-H 'accept: application/json'