describe_table
Inspects a table or view to return column names, types, nullability, defaults, and primary keys for understanding its structure before querying.
Instructions
Describes the columns of one table or view that the read login may use: name, type, nullable, default and primary key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| table | Yes | The table or view to describe, by exact name. | |
| schema | No | The schema, by exact name. Defaults to public. | |
| database | Yes | The database to run on. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | The result rows, each an array in column order. | |
| columns | Yes | The result columns, in order. | |
| truncated | Yes | True when the row cap, the byte cap or limit cut off more rows. |