Skip to main content

DESCRIBE

DESCRIBE returns the ordered column names and types of one configured KV, Table or Document query source through the console or query workspace inspect operation. With writes.catalog configured, console DESCRIBE instead resolves a named Table in that catalog under current native reads and inspect policy. It returns its definition and checks the live Table schema. .schema continues to describe the query source.

Syntax​

DESCRIBE items;

The object name is a single identifier. The rule has no object-kind keyword, qualified name, query argument, EXTENDED modifier or DESC shorthand. Quoting follows the shared syntax. Unquoted names fold to lowercase; quoted names resolve exactly against the configured source name.

Result and access​

The query-source result identifies its scope as one configured source, with source kind, resource, full declaration and schema fingerprints, current metadata and policy revisions, and column names/types. It does not enumerate other realm objects or read application rows. Current native source/requester access and query policy are checked before resolving the name and again before disclosing the result. DESCRIBE SELECT ... is unsupported; use EXPLAIN for a query's output columns. See the inspection contract.

Related metadata interfaces are documented in the console guide, the Board API, and the declared query source schema. Flight SQL retains its separate Table metadata and SELECT interfaces and does not accept this SQL statement.

Source: describeStatement. See also SHOW.