LIST ENTITIES

Syntax

[ LIST | SHOW ] ENTITIES
[IN fully_qualified_entity_name]
[IN STORE store_name];

Description

This command creates a new Entity supported by a Store. These Entities can then be used to host Relations created through DDL or Query.

This command lists Entities that are present under the entity name specified by fully_qualified_entity_name. If fully_qualified_entity_name is not provided, the Entities under the root namespace are returned.

Entities will only be listed if the current role has USAGE privileges on the Store.

Arguments

IN fully_qualified_entity_name

Optionally, this lists Entities under the provided entity name. Otherwise, the root Entities are returned.

IN STORE store_name

Optionally, this lists the Entities in the specified Store. By default, the current session's Store will be used.

Examples

List Kafka topics in the current Store

The following lists the Entities in the current Store:

demodb.public/kafka_store# LIST ENTITIES;
  Entity name
--------------
  pageviews

List Snowflake databases

demodb.public/sfstore# LIST ENTITIES;
       Entity name       
-------------------------
  MY_SNOWFLAKE_DB        
  SNOWFLAKE              
  SNOWFLAKE_SAMPLE_DATA  

List Snowflake schemas in a database

demodb.public/sfstore# LIST ENTITIES IN "MY_SNOWFLAKE_DB";
     Entity name      
----------------------
  INFORMATION_SCHEMA  
  MY_SCHEMA           
  PUBLIC              

List Snowflake tables in a schema

demodb.public/sfstore# LIST ENTITIES IN "MY_SNOWFLAKE_DB"."PUBLIC";
    Entity name    
-------------------
  STREAM_DATA_TBL  
  sf_pv_table      

List Databricks catalogs

demodb.public/databricks_store# LIST ENTITIES;
    Entity name    
-------------------
  cat1
  main
  stem_cat
  system

List Databricks schemas in a catalog

demodb.public/databricks_store# LIST ENTITIES IN cat1;
     Entity name
----------------------
  default
  information_schema
  schema1

List Databricks tables in a schema

demodb.public/databricks_store# LIST ENTITIES IN cat1.schema1;
  Entity name
---------------
  pageviews
  pv_agg

List schemas in a Postgresql store

demodb.public/psqlstore# LIST ENTITIES;
  Entity name  
---------------
  public

List Postgresql tables in a schema

demodb.public/psqlstore# LIST ENTITIES in public;
  Entity name  
---------------
  pageviews   

List Snowflake databases in a specific Store

demodb.public/kafka_store# LIST ENTITIES IN STORE sfstore;
       Entity name       
-------------------------
  MY_SNOWFLAKE_DB        
  SNOWFLAKE              
  SNOWFLAKE_SAMPLE_DATA