describe_table
Get detailed schema information for database tables including columns, data types, and constraints to understand table structure and relationships.
Instructions
Get detailed schema information for a specific table (columns, types, constraints)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| connection_string | No | Database connection URL or configured connection name (e.g., "oracle" for USQL_ORACLE) | |
| database | No | Optional database name (if not specified in connection) | |
| output_format | No | Output format for results (default: json) | |
| table | Yes | Table name to describe | |
| timeout_ms | No | Optional timeout in milliseconds for this call (overrides defaults). Use null for unlimited. |
Input Schema (JSON Schema)
{
"properties": {
"connection_string": {
"description": "Database connection URL or configured connection name (e.g., \"oracle\" for USQL_ORACLE)",
"type": "string"
},
"database": {
"description": "Optional database name (if not specified in connection)",
"type": "string"
},
"output_format": {
"description": "Output format for results (default: json)",
"enum": [
"json",
"csv"
],
"type": "string"
},
"table": {
"description": "Table name to describe",
"type": "string"
},
"timeout_ms": {
"description": "Optional timeout in milliseconds for this call (overrides defaults). Use null for unlimited.",
"minimum": 1,
"type": [
"number",
"null"
]
}
},
"required": [
"table"
],
"type": "object"
}