Syntax
Copy [ LIST | SHOW ] ENTITIES
[IN fully_qualified_entity_name]
[IN STORE store_name];
Description
This command creates a new entity supported by a store . You can then use the entity 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 system returns the entities under the root namespace.
Entities are listed only 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 system returns the root entities.
IN STORE store_name
Optionally, this lists the entities in the specified store. By default, the system uses the current session's store.
Examples
List Kafka topics in the current store
The following lists the entities in the current store:
Copy demodb.public/kafka_store# LIST ENTITIES ;
+--------------+----------+
| Name | Is Leaf |
+ ==============+==========+
| pageviews | true |
+--------------+----------+
| pageviews_pb | true |
+--------------+----------+
| users | true |
+--------------+----------+
List Snowflake databases
Copy demodb.public/sfstore# LIST ENTITIES ;
+-----------------+------------+
| Name | Is Leaf |
+ =================+============+
| MY_SNOWFLAKE_DB | false |
+-----------------+------------+
| SNOWFLAKE | false |
+-----------------+------------+
| SNOWFLAKE_SAMPL | false |
| E_DATA | |
+-----------------+------------+
List Snowflake schemas in a database
Copy demodb.public/sfstore# LIST ENTITIES IN "DELTA_STREAMING" ;
+---------------------+------------+
| Name | Is Leaf |
+ =====================+============+
| MY_STREAMING_SCHEMA | false |
+---------------------+------------+
| PUBLIC | false |
+---------------------+------------+
List Snowflake tables in a schema
Copy demodb.public/sfstore# LIST ENTITIES IN "DELTA_STREAMING" . "PUBLIC" ;
+---------------------+------------+
| Name | Is Leaf |
+ =====================+============+
| STREAM_DATA_TBL | true |
+---------------------+------------+
| sf_pv_table | true |
+---------------------+------------+
List Databricks catalogs
Copy demodb.public/databricks_store# LIST ENTITIES ;
+------------+------------+
| Name | Is Leaf |
+ ============+============+
| catalog1 | false |
+------------+------------+
| main | false |
+------------+------------+
| system | false |
+------------+------------+
List Databricks schemas in a catalog
Copy demodb.public/databricks_store# LIST ENTITIES in catalog1 ;
+--------------------+------------+
| Name | Is Leaf |
+ ====================+============+
| default | false |
+--------------------+------------+
| information_schema | false |
+--------------------+------------+
List Databricks tables in a schema
Copy demodb.public/databricks_store# LIST ENTITIES IN catalog1.schema1 ;
+--------------------+------------+
| Name | Is Leaf |
+ ====================+============+
| pageviews | true |
| pv_agg | true |
+--------------------+------------+
List schemas in a Postgresql store
Copy demodb.public/databricks_store# LIST ENTITIES ;
+------------+------------+
| Name | Is Leaf |
+ ============+============+
| public | false |
+------------+------------+
List Postgresql tables in a schema
Copy demodb.public/psqlstore# LIST ENTITIES in public ;
+--------------------+------------+
| Name | Is Leaf |
+ ====================+============+
| pageviews | true |
+--------------------+------------+
List Snowflake databases in a specific store
Copy demodb.public/kafka_store# LIST ENTITIES IN STORE sfstore ;
+-----------------+------------+
| Name | Is Leaf |
+ =================+============+
| MY_SNOWFLAKE_DB | false |
+-----------------+------------+
| SNOWFLAKE | false |
+-----------------+------------+
| SNOWFLAKE_SAMPL | false |
| E_DATA | |
+-----------------+------------+