Skip to Content
MosaicMosaicDocs
Tool Reference

DescribeDatabase

Read a database's tables, versions and columns before writing SQL: IDs, exact SQL names, types, select labels, and relation targets.

Starter documentation. Features and account details may differ from this deployment.

DescribeDatabase

Read a database's tables, versions and columns before writing SQL: IDs, exact SQL names, types, select labels, and relation targets. Pass includeEditingMetadata only when editing views or changing column types to include saved views and conversion targets. Get databaseId from ListDatabases.

Parameters

ParameterTypeRequiredDescription
databaseIdstringYesId of the database to describe, as returned by ListDatabases.
includeEditingMetadatabooleanNoInclude saved views and per-column type conversion targets. Omit for queries.

On this page