Describe a Harbor table
harbor_describe_tableRead-onlyIdempotent
Return the schema for one table—columns, types, nullability, primary key, and PII masking—so you can write accurate queries.
Instructions
Return the column list, types, nullability and primary key for one table.
Args:
table (string): one of customers, subscriptions, plans, invoices, tickets, usage_events
Returns JSON: { "table": string, "note": string, "columns": [ { "name": string, "type": string, "nullable": boolean, "primary_key": boolean, "masked": boolean } ] }
"masked" marks columns whose values are partially redacted on the way out.
Example: use before writing a query that filters on a column you have not seen yet. Error: returns an error listing valid tables if the name is not readable.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| table | Yes | Name of the table to describe. Must be one of the readable tables. |