get-schemas
Fetch database schemas (tables, columns, relationships, indexes) for project SQL connections
Request Body
application/json
Response Body
application/json
Input
{
"projectId": "string",
"envId": "string",
"repoId": "string",
"branchId": "string",
"isRefreshExistingCache": true
}Output
{
"combinedSchemaItems": [
{
"connectionId": "string",
"schemas": [
{
"schemaName": "string",
"description": "string",
"tables": [
{
"tableName": "string",
"tableType": "string",
"columns": [
{
"columnName": "string",
"dataType": "string",
"isNullable": true,
"isPrimaryKey": true,
"isUnique": true,
"foreignKeys": [
{
"constraintName": "string",
"referencedSchemaName": "string",
"referencedTableName": "string",
"referencedColumnName": "string"
}
],
"description": "string",
"example": "string",
"cacheUniqueValues": true,
"references": [
{
"relationshipType": "one_to_one",
"isForeignKey": true,
"referencedSchemaName": "string",
"referencedTableName": "string",
"referencedColumnName": "string"
}
],
"cachedColumn": {
"projectId": "string",
"connectionId": "string",
"envId": "string",
"schemaName": "string",
"tableName": "string",
"columnName": "string",
"requestedByUserId": "string",
"status": "running",
"errorMessage": "string",
"startedTs": 0,
"completedTs": 0,
"completedDurationMs": 0,
"limit": 0,
"sampleSize": 0,
"isLimitReached": true,
"serverTs": 0,
"uniqueValuesCount": 0
}
}
],
"indexes": [
{
"indexName": "string",
"indexColumns": [
"string"
],
"isUnique": true,
"isPrimaryKey": true
}
],
"description": "string"
}
]
}
],
"lastRefreshedTs": 0,
"errorMessage": "string"
}
]
}