LogoLogo
Start Trial
  • Overview
    • What is DeltaStream?
    • Core Concepts
      • Access Control
      • Region
      • SQL
      • Store
      • Database
      • Query
      • Visualizing Data Lineage
      • Function
  • Getting Started
    • Free Trial Quick Start
    • Starting with the Web App
    • Starting with the CLI
  • Tutorials
    • Managing Users and User Roles
      • Inviting Users to an Organization
      • Administering Users in your Organization
      • Using the CLI to Manage User Roles
      • Example: Setting Up Custom Roles for Production and Stage
    • Creating Stores for Streaming Data
    • Using Multiple Stores in Queries
    • Creating Relations to Structure Raw Data
    • Namespacing with Database and Schema
    • Creating and Querying Materialized Views
    • Creating a Function
    • Securing Your Connections to Data Stores
      • Introducing DeltaStream Private Links
      • Creating an AWS Private Link from DeltaStream to your Confluent Kafka Dedicated Cluster
      • Enabling Private Link Connectivity to Confluent Enterprise Cluster and Schema Registry
      • Creating a Private Link from DeltaStream to Amazon MSK
      • Creating a Private Link for RDS Databases
      • Deleting a Private Link
    • Integrations
      • Connecting to Confluent Cloud
      • Databricks
      • PostgreSQL
      • Snowflake
      • WarpStream
    • Serialization
      • Working with ProtoBuf Serialized Data and DeltaStream Descriptors
      • Working with Avro Serialized Data and Schema Registries
      • Configuring Deserialization Error Handling
  • Reference
    • Enterprise Security Integrations
      • Okta SAML Integration
      • Okta SCIM Integration
    • Metrics
      • Prometheus Integration
      • Built-In Metrics
      • Custom Metrics in Functions
    • SQL Syntax
      • Data Formats (Serialization)
        • Serializing with JSON
        • Serializing with Primitive Data Types
        • Serializing with Protobuf
      • Data Types
      • Identifiers and Keywords
      • Command
        • ACCEPT INVITATION
        • CAN I
        • COPY DESCRIPTOR_SOURCE
        • COPY FUNCTION_SOURCE
        • DESCRIBE ENTITY
        • DESCRIBE QUERY
        • DESCRIBE QUERY METRICS
        • DESCRIBE QUERY EVENTS
        • DESCRIBE QUERY STATE
        • DESCRIBE RELATION
        • DESCRIBE RELATION COLUMNS
        • DESCRIBE ROLE
        • DESCRIBE SECURITY INTEGRATION
        • DESCRIBE <statement>
        • DESCRIBE STORE
        • DESCRIBE USER
        • GENERATE COLUMNS
        • GENERATE TEMPLATE
        • GRANT OWNERSHIP
        • GRANT PRIVILEGES
        • GRANT ROLE
        • INVITE USER
        • LIST API_TOKENS
        • LIST DATABASES
        • LIST DESCRIPTORS
        • LIST DESCRIPTOR_SOURCES
        • LIST ENTITIES
        • LIST FUNCTIONS
        • LIST FUNCTION_SOURCES
        • LIST INVITATIONS
        • LIST METRICS INTEGRATIONS
        • LIST ORGANIZATIONS
        • LIST QUERIES
        • LIST REGIONS
        • LIST RELATIONS
        • LIST ROLES
        • LIST SCHEMAS
        • LIST SCHEMA_REGISTRIES
        • LIST SECRETS
        • LIST SECURITY INTEGRATIONS
        • LIST STORES
        • LIST USERS
        • PRINT ENTITY
        • REJECT INVITATION
        • REVOKE INVITATION
        • REVOKE PRIVILEGES
        • REVOKE ROLE
        • SET DEFAULT
        • USE
      • DDL
        • ALTER API_TOKEN
        • ALTER SECURITY INTEGRATION
        • CREATE API_TOKEN
        • CREATE CHANGELOG
        • CREATE DATABASE
        • CREATE DESCRIPTOR_SOURCE
        • CREATE ENTITY
        • CREATE FUNCTION_SOURCE
        • CREATE FUNCTION
        • CREATE INDEX
        • CREATE METRICS INTEGRATION
        • CREATE ORGANIZATION
        • CREATE ROLE
        • CREATE SCHEMA_REGISTRY
        • CREATE SCHEMA
        • CREATE SECRET
        • CREATE SECURITY INTEGRATION
        • CREATE STORE
        • CREATE STREAM
        • CREATE TABLE
        • DROP API_TOKEN
        • DROP CHANGELOG
        • DROP DATABASE
        • DROP DESCRIPTOR_SOURCE
        • DROP ENTITY
        • DROP FUNCTION_SOURCE
        • DROP FUNCTION
        • DROP METRICS INTEGRATION
        • DROP RELATION
        • DROP ROLE
        • DROP SCHEMA
        • DROP SCHEMA_REGISTRY
        • DROP SECRET
        • DROP SECURITY INTEGRATION
        • DROP STORE
        • DROP STREAM
        • DROP USER
        • UPDATE ENTITY
        • UPDATE SCHEMA_REGISTRY
        • UPDATE SECRET
        • UPDATE STORE
      • Query
        • APPLICATION
        • Change Data Capture (CDC)
        • CREATE CHANGELOG AS SELECT
        • CREATE STREAM AS SELECT
        • CREATE TABLE AS SELECT
        • Function
          • Built-in Functions
          • Row Metadata Functions
        • INSERT INTO
        • Materialized View
          • CREATE MATERIALIZED VIEW AS
          • SELECT (FROM MATERIALIZED VIEW)
        • Query Name and Version
        • Resume Query
        • RESTART QUERY
        • SELECT
          • FROM
          • JOIN
          • MATCH_RECOGNIZE
          • WITH (Common Table Expression)
        • TERMINATE QUERY
      • Sandbox
        • START SANDBOX
        • DESCRIBE SANDBOX
        • STOP SANDBOX
      • Row Key Definition
    • Rest API
Powered by GitBook
On this page
  • Syntax
  • Description
  • Arguments
  • Examples
  1. Reference
  2. SQL Syntax
  3. Command

DESCRIBE RELATION COLUMNS

PreviousDESCRIBE RELATIONNextDESCRIBE ROLE

Last updated 5 months ago

Syntax

DESCRIBE [ RELATION | STREAM | CHANGELOG | MATERIALIZED VIEW ]
COLUMNS fully_qualified_relation_name;

Description

This provides the information about an existing 's columns in a . This command can also be used to define a specific relation type's columns. See LIST RELATIONS for a list of available relations to describe.

Relations are visible only if the current has USAGE privileges on the database and schema and SELECT or INSERT privilege on the relation.

Arguments

fully_qualified_relation_name

This is the name of the relation to describe its columns. If the name is case-sensitive you must wrap it in double quotes; otherwise, the system uses the lowercase name.

Optionally, the relation name may be fully-qualified in the format of <database_name>.<schema_name>.<relation_name> or <schema_name>.<relation_name>. If the database or schema name is not provided, the system uses the current session's database or schema (see USE).

Examples

Describe a Stream's columns

demodb.public/demostore# DESCRIBE RELATION COLUMNS pageviews;
+----------+---------+-----------+-------------+
|  Name    |  Type   |  Nullable |  Properties |
+==========+=========+===========+=============+
| viewtime | BIGINT  | true      | {}          |
+----------+---------+-----------+-------------+
| userid   | VARCHAR | true      | {}          |
+----------+---------+-----------+-------------+
| pageid   | VARCHAR | true      | {}          |
+----------+---------+-----------+-------------+

Describe a stream's columns in a specific database/schema

demodb.public/demostore# DESCRIBE RELATION COLUMNS pageviews;
+----------+---------+-----------+-------------+
|  Name    |  Type   |  Nullable |  Properties |
+==========+=========+===========+=============+
| viewtime | BIGINT  | true      | {}          |
+----------+---------+-----------+-------------+
| userid   | VARCHAR | true      | {}          |
+----------+---------+-----------+-------------+
| pageid   | VARCHAR | true      | {}          |
+----------+---------+-----------+-------------+

Describe a materialized view's columns

The following describes the columns for pvcount in the demodb database and public schema:

demodb.public/demostore# DESCRIBE MATERIALIZED VIEW COLUMNS demodb."public".pvcount;
+-------------+---------+-----------+-------------+
|  Name       |  Type   |  Nullable |  Properties |
+=============+=========+===========+=============+
| page_name   | VARCHAR | true      | {}          |
+-------------+---------+-----------+-------------+
| pageid      | VARCHAR | true      | {}          |
+-------------+---------+-----------+-------------+
| cnt         | BIGINT  | false     | {}          |
+-------------+---------+-----------+-------------+

Describe a changelog

demodb.public/demostore# DESCRIBE CHANGELOG COLUMNS users_log;
+--------------+-----------------------+-----------+-------------+
|  Name        |  Type                 |  Nullable |  Properties |
+==============+=======================+===========+=============+
| registertime | BIGINT                | true      | {}          |
+--------------+-----------------------+-----------+-------------+
| userid       | VARCHAR               | true      | {}          |
+--------------+-----------------------+-----------+-------------+
| regionid     | VARCHAR               | true      | {}          |
+--------------+-----------------------+-----------+-------------+
| gender       | VARCHAR               | true      | {}          |
+--------------+-----------------------+-----------+-------------+
| interests    | ARRAY<VARCHAR>        | true      | {}          |
+--------------+-----------------------+-----------+-------------+
| contactinfo  | STRUCT <phone VARCHAR | true      | {}          |
|              | , city VARCHAR,       |           |             |
|              | "state" VARCHAR, zip  |           |             |
|              | code VARCHAR>         |           |             |
+--------------+-----------------------+-----------+-------------+

Describe a Table's columns

demodb.public/demostore# DESCRIBE RELATION COLUMNS pv_agg;
+-----------+---------+-----------+-------------+
|  Name     |  Type   |  Nullable |  Properties |
+===========+=========+===========+=============+
| userid    | VARCHAR | true      | {}          |
+-----------+---------+-----------+-------------+
| pagecount | BIGINT  | true      | {}          |
+-----------+---------+-----------+-------------+

Describe a relation's columns with a case-sensitive name

demodb.public/demostore# DESCRIBE RELATION "Pageviews";
+----------+---------+-----------+-------------+
|  Name    |  Type   |  Nullable |  Properties |
+==========+=========+===========+=============+
| viewtime | BIGINT  | true      | {}          |
+----------+---------+-----------+-------------+
| userid   | VARCHAR | true      | {}          |
+----------+---------+-----------+-------------+
| pageid   | VARCHAR | true      | {}          |
+----------+---------+-----------+-------------+

The following describes the total_views relation columns in the demodb database and analytics schema, using its fully-qualified relation name:

The following describes the users_log in the current database and schema:

The following describes the columns for pv_agg in the current database and schema:

The following describes the columns for Pageviews relation in the current demodb database and public schema:

Database's
Stream
Changelog
Table
Stream
Relation
schema
Role