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 ENTITY

PreviousCOPY FUNCTION_SOURCENextDESCRIBE QUERY

Last updated 5 months ago

Syntax

DESCRIBE Entity entity_name
[ IN STORE store_name ];

Description

This command describes an entity in a Store.

Entities is visible only if the current has USAGE privileges on the store.

Arguments

entity_name

This is the name of the entity to describe. If the name is case-sensitive, you must wrap it in double quotes; otherwise, the lowercase name is used.

IN STORE store_name

Optionally, describe an entity in a specific store. If the name is case-sensitive, you must wrap it in double quotes; otherwise, the lowercase name is used.

Examples

Describe an entity in the current Kafka store

The following describes the pageviews entity in the current Kafka store demostore:

demodb.public/demostore# DESCRIBE ENTITY pageviews;
+-----------+--------------+-------------+-----------+-----------------+-------------------+-----------+
|  Name     |  Entity Type |  Partitions |  Replicas |  Key Descriptor |  Value Descriptor |  Configs  |
+===========+==============+=============+===========+=================+===================+===========+
| pageviews | Topic        | 1           | 1         | <null>          | <null>            | {}        |
+-----------+--------------+-------------+-----------+-----------------+-------------------+-----------+

Describe an entity in a specific Kinesis store

The following describes the InterestCount entity in the Amazon Kinesis store kinesis_main:

demodb.public/demostore# DESCRIBE ENTITY "InterestCount" IN STORE kinesis_store;
+---------------+--------------+---------+-------------+
|  Name         |  Entity Type |  Shards |  Descriptor |
+===============+==============+=========+=============+
| InterestCount | Data Stream  | 6       | <null>      |
+---------------+--------------+---------+-------------+

Describe an entity with descriptors

The following describes the pv_pb entity in the Kafka Store called KafkaStore2. This entity's native format is ProtoBuf and the Key and Value descriptors assigned to it allow serialization to/from this format:

demodb.analytics/demostore# DESCRIBE ENTITY pv_pb IN STORE "KafkaStore2";
```csharp
+-------+--------------+-------------+-----------+---------------------+--------------------+-----------+
|  Name |  Entity Type |  Partitions |  Replicas |  Key Descriptor     |  Value Descriptor  |  Configs  |
+=======+==============+=============+===========+=====================+====================+===========+
| pv_pb | Topic        | 1           | 2         | pb_key.PageviewsKey | pb_value.Pageviews | {}        |
+-------+--------------+-------------+-----------+---------------------+--------------------+-----------+

Describe a Snowflake database

demodb.public/sfstore# DESCRIBE ENTITY "FLINK_STREAMING";
+-----------------+--------------+------------+-------------------------------+-----------------+--------------+-----------+
|       Name      |  Entity Type |    Type    |  Created At                   |  Retention Time |     Owner    |  Comment  |
+=================+==============+============+===============================+=================+--------------+===========+
| FLINK_STREAMING | Database     | STANDARD   | 2024-07-17 00:19:33 +0000 UTC |               1 | ACCOUNTADMIN | <null>    |
+-----------------+--------------+------------+-------------------------------+-----------------+--------------+-----------+

Describe a Snowflake table

demodb.public/sfstore# DESCRIBE ENTITY "FLINK_STREAMING"."PUBLIC"."SF_PAGEVIEWS";
+-------------------------------------+--------------+------------+-------------------------------+--------------+-------------------------------+-----------------+-------------------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|                 Name                |  Entity Type |    Type    |           Created At          |     Owner    |           Last DDLAt          |  Retention Time |           Updated At          |  Comment |                                                             Columns                                                                                     |
+=====================================+==============+============+===============================+==============+===============================+=================+===============================+==========+=========================================================================================================================================================+
| FLINK_STREAMING.PUBLIC.SF_PAGEVIEWS | Table        | BASE TABLE | 2024-07-03 14:55:20 +0000 UTC | ACCOUNTADMIN | 2024-07-03 14:55:20 +0000 UTC |               1 | 2024-07-03 15:02:46 +0000 UTC | <nil>    | [{"name":"TIMESTAMP","type":"NUMBER(38,0)","nullable":true,"default":null,"primaryKey":false,"uniqueKey":false,"comment":null,"policyName":null},{...}] |
+-------------------------------------+--------------+------------+-------------------------------+--------------+-------------------------------+-----------------+-------------------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+

Describe a Databricks catalog

demodb.public/databricks_store# DESCRIBE ENTITY catalog1;
+------------------+--------------+-------------------------------+-----------------------------------------+-------------------------------+-----------------------------------------+----------+
|     Name         |  Entity Type |           Created At          |                Created By               |           Updated At          |                Updated By               |  Comment |
+==================+==============+===============================+=========================================+===============================+=========================================+==========+
| catalog1         | Catalog      | 2024-02-09 22:07:14 +0000 UTC | subscriptions+databricks@deltastream.io | 2024-02-09 22:07:14 +0000 UTC | subscriptions+databricks@deltastream.io |          |
+------------------+--------------+-------------------------------+-----------------------------------------+-------------------------------+-----------------------------------------+----------+

Describe a Databricks schema

demodb.public/databricks_store# DESCRIBE ENTITY catalog1.schema1;
+------------------+--------------+-------------------------------+-------------+-------------------------------+-------------+----------+
|      Name        |  Entity Type |           Created At          | Created By  |           Updated At          | Updated By  |  Comment |
+==================+==============+===============================+=============+===============================+=============+==========+
| catalog1.schema1 | Schema       | 2024-02-13 23:43:59 +0000 UTC | sch_owner   | 2024-02-13 23:43:59 +0000 UTC | sch_owner   |          |
+------------------+--------------+-------------------------------+-------------+-------------------------------+-------------+----------+

Describe a Databricks table

demodb.public/dbx_store# DESCRIBE ENTITY catalog1.schema1.pageviews;
+----------------------------+--------------+-------------------------------+-------------+-------------------------------+-------------+----------------------+------------------------------------+---------------------------------------------------------------------------+
|            Name            |  Entity Type |           Created At          | Created By  |           Updated At          | Updated By  | Storage Location     |              Comment               |                              Columns                                      |
+============================+==============+===============================+=============+===============================+=============+======================+====================================+===========================================================================+
| catalog1.schema1.pageviews | Table        | 2024-04-10 15:24:07 +0000 UTC | tbl_owner   | 2024-04-10 15:24:07 +0000 UTC | tbl_owner   | s3://somebucket/test | {"deltastream.relation.fqn":"..."} | [{"name":"messageId","type":"string","nullable":true,"position":0},{...}] |
+----------------------------+--------------+-------------------------------+-------------+-------------------------------+-------------+----------------------+----------------------------------+-----------------------------------------------------------------------------+

Describe a Postgresql schema

demodb.public/databricks_store# DESCRIBE ENTITY db.schema1;
+-------------+--------------+-----------+
|  Name       |  Entity Type |  Owner    |
+=============+==============+===========+
| db.schema1  | Schema       | sch_owner |
+-------------+--------------+-----------+

Describe a Postgresql table

demodb.public/pgx_store# DESCRIBE ENTITY public.pageviews;
+------------------+--------------+-----------+---------------------------------------------------------------------------+
|  Name            |  Entity Type |  Owner    |  Columns                                                                  |
+==================+==============+===========+===========================================================================+
| public.pageviews | Table        | tbl_owner | [{"name":"viewtime","type":"bigint","nullable":true,"position":0},{...}]  |
+------------------+--------------+-----------+---------------------------------------------------------------------------+

The entity provides the Kafka topic-specific information and the Key/Value defining the serialization format of both the key and value portions of a Kafka record.

The entity provides the Kinesis stream specific information and a defining the serialization format of the Kinesis records.

Role
Descriptor
Descriptor