Skip to main content
POST
Describe a Snowflake table

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

snowflake_account_id
string
required

Body

application/json

The table to describe.

database_name
string
required

The name of the database. The match is exact and case-sensitive.

Minimum string length: 1
schema_name
string
required

The name of the schema. The match is exact and case-sensitive.

Minimum string length: 1
table_name
string
required

The name of the table. The match is exact and case-sensitive.

Minimum string length: 1

Response

Successful Response

The columns of a Snowflake table, with their clustering information.

columns
SnowflakeTableColumn · object[]
required

The columns of the table.

clustering_key
SnowflakeClusteringInformation · object | null
required

How well the table is clustered on its clustering key. null when the table has no clustering key.

version
string
required

The version of the SELECT stored procedure that described the table.