DESCRIBE ENTITY

Syntax

DESCRIBE ENTITY fully_qualified_entity_name;

Description

This command describes an entity in a Store.

Entities can only be described if the current role has USAGE privileges on the Store.

Arguments

fully_qualified_entity_name

The full name of the entity to describe.

Examples

Describe a Snowflake database

demodb.public/sfstore# DESCRIBE ENTITY "FLINK_STREAMING";
    Type   |       Name        |      Created at      | Retention time |      Updated at      | Comment  
-----------+-------------------+----------------------+----------------+----------------------+----------
  Database | "FLINK_STREAMING" | 2023-09-02T13:37:32Z |              1 | 2023-09-02T13:37:32Z |          

Describe a Databricks catalog

demodb.public/databricks_store# DESCRIBE ENTITY catalog1;
   Type   |   Name   |      Created at      |     Created by      |      Updated at      |     Updated by      |            Comment
----------+----------+----------------------+---------------------+----------------------+---------------------+--------------------------------
  Catalog | catalog1 | 2023-09-18T14:33:19Z | [e-mail] | 2023-09-18T14:33:19Z | [e-mail] | Shared catalog (auto-created)

Describe a Databricks schema

demodb.public/databricks_store# DESCRIBE ENTITY catalog1.schema1;
   Type  |       Name       |      Created at      |     Created by      |      Updated at      |     Updated by      | Comment
---------+------------------+----------------------+---------------------+----------------------+---------------------+----------
  Schema | catalog1.schema1 | 2023-09-18T15:14:35Z | [e-mail] | 2023-09-18T15:14:35Z | [e-mail] |

Describe a Databricks table

demodb.public/databricks_store# DESCRIBE ENTITY catalog1.schema1.pageviews;
  Type  |           Name             |      Created at      |     Created by      |      Updated at      |     Updated by      | Storage location | Comment
--------+----------------------------+----------------------+---------------------+----------------------+---------------------+------------------+----------
  Table | catalog1.schema1.pageviews | 2023-09-18T16:26:04Z | [e-mail] | 2023-09-18T16:26:04Z | [e-mail] |                  |

Columns:
  Position |   Name   |  Type  | Nullable
-----------+----------+--------+-----------
         0 | viewtime | bigint | ✓
         1 | userid   | string | ✓
         2 | pageid   | string | ✓

Describe a Postgresql schema

demodb.public/psqlstore# DESCRIBE ENTITY public;
          Type         |   Name    
-----------------------+-----------
  PostgresSchemaEntity | "public"  

Describe a Postgresql table

demodb.public/psqlstore# DESCRIBE ENTITY public.pageviews;
  PostgresTableEntity | "public".pageviews  

Columns:
  Position |   Name   |       Type        | Nullable  
-----------+----------+-------------------+-----------
         1 | viewtime | bigint            | ✓         
         2 | userid   | character varying |           
         3 | pageid   | character varying | ✓