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;
+--------------+----------+
|  Name        |  Is Leaf |
+==============+==========+
| pageviews    | true     |
+--------------+----------+
| pageviews_pb | true     |
+--------------+----------+
| users        | true     |
+--------------+----------+

List Snowflake databases

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

demodb.public/sfstore# LIST ENTITIES IN "DELTA_STREAMING";
+---------------------+------------+
|  Name               |  Is Leaf   |
+=====================+============+
| MY_STREAMING_SCHEMA | false      |
+---------------------+------------+
| PUBLIC              | false      |
+---------------------+------------+  

List Snowflake tables in a schema

demodb.public/sfstore# LIST ENTITIES IN "DELTA_STREAMING"."PUBLIC";
+---------------------+------------+
|  Name               |  Is Leaf   |
+=====================+============+
| STREAM_DATA_TBL     | true       |
+---------------------+------------+
| sf_pv_table         | true       |
+---------------------+------------+      

List Databricks catalogs

demodb.public/databricks_store# LIST ENTITIES;
+------------+------------+
|  Name      |  Is Leaf   |
+============+============+
| catalog1   | false      |
+------------+------------+
| main       | false      |
+------------+------------+
| system     | false      |
+------------+------------+

List Databricks schemas in a catalog

demodb.public/databricks_store# LIST ENTITIES in catalog1;
+--------------------+------------+
|  Name              |  Is Leaf   |
+====================+============+
| default            | false      |
+--------------------+------------+
| information_schema | false      |
+--------------------+------------+

List Databricks tables in a schema

demodb.public/databricks_store# LIST ENTITIES IN catalog1.schema1;
+--------------------+------------+
|  Name              |  Is Leaf   |
+====================+============+
| pageviews          | true       |
| pv_agg             | true       |
+--------------------+------------+ 

List schemas in a Postgresql store

demodb.public/databricks_store# LIST ENTITIES;
+------------+------------+
|  Name      |  Is Leaf   |
+============+============+
| public     | false      |
+------------+------------+

List Postgresql tables in a schema

demodb.public/psqlstore# LIST ENTITIES in public;
+--------------------+------------+
|  Name              |  Is Leaf   |
+====================+============+
| pageviews          | true       |
+--------------------+------------+ 

List Snowflake databases in a specific Store

demodb.public/kafka_store# LIST ENTITIES IN STORE sfstore;
+-----------------+------------+
|  Name           |  Is Leaf   |
+=================+============+
| MY_SNOWFLAKE_DB | false      |
+-----------------+------------+
| SNOWFLAKE       | false      |
+-----------------+------------+
| SNOWFLAKE_SAMPL | false      |
| E_DATA          |            |
+-----------------+------------+