DROP ENTITY

Syntax

DROP ENTITY fully_qualified_entity_name
[IN STORE store_name];

Description

Drops an entity from the current store or a provided store name. You cannot drop an entity if any relations are defined that depend on it. But you can drop an entity outside of the DeltaStream platform. In this case the relations and queries that depend on it will fail to progress.

See USE for changing the current store.

Important DROP ENTITY cannot be undone. Use it with care!

Arguments

fully_qualified_entity_name

The full name of the entity to describe.

IN STORE store_name

Optionally, this specifies the store from which the entity should be dropped. If the name is case sensitive you must wrap it in double quotes; otherwise the system uses the lower case name.

Examples

Drop a Kafka topic in the current Kafka Store

The following drops a Kafka topic from the current kafka_store store. Note the store name:

demodb.public/kafka_store# LIST ENTITIES;
+--------------+----------+
|  Name        |  Is Leaf |
+==============+==========+
| pageviews    | true     |
+--------------+----------+
| pageviews_pb | true     |
+--------------+----------+
| users        | true     |
+--------------+----------+
demodb.public/kafka_store# DROP ENTITY "users";
+--------+----------+----------+------------------------------------------+
|  Type  |  Name    |  Command |  Summary                                 |
+========+==========+==========+==========================================+
| entity | users    | DROP     | entity "users" was successfully          |
|        |          |          | dropped from store "kafka_store"         |
+--------+----------+----------+------------------------------------------+
demodb.public/kafka_store# LIST ENTITIES;
+--------------+----------+
|  Name        |  Is Leaf |
+==============+==========+
| pageviews    | true     |
+--------------+----------+
| pageviews_pb | true     |
+--------------+----------+

Drop a Kinesis data stream in a specific store

The following drops a Kinesis data stream in the store AltStore, which is also provided to the commands LIST ENTITIES and DROP ENTITY for context:

demodb.public/demostore# LIST ENTITIES IN STORE "AltStore";
+--------------+----------+
|  Name        |  Is Leaf |
+==============+==========+
| Shipments    | true     |
+--------------+----------+
| reviews      | true     |
+--------------+----------+
demodb.public/demostore# DROP ENTITY "Shipments" IN STORE "AltStore";
+--------+------------+----------+------------------------------------------+
|  Type  |  Name      |  Command |  Summary                                 |
+========+============+==========+==========================================+
| entity | Shipments  | DROP     | entity "Shipments" was successfully      |
|        |            |          | dropped from store "AltStore"            |
+--------+------------+----------+------------------------------------------+
demodb.public/demostore# LIST ENTITIES IN STORE "AltStore";
+--------------+----------+
|  Name        |  Is Leaf |
+==============+==========+
| reviews      | true     |
+--------------+----------+

Drop a Snowflake database

demodb.public/sfstore# LIST ENTITIES;
+-----------------+------------+
|  Name           |  Is Leaf   |
+=================+============+
| MY_SNOWFLAKE_DB | false      |
+-----------------+------------+
| SNOWFLAKE       | false      |
+-----------------+------------+
| SNOWFLAKE_SAMPL | false      |
| E_DATA          |            |
+-----------------+------------+
demodb.public/sfstore# DROP ENTITY "MY_SNOWFLAKE_DB";
+------------+-----------------+------------+------------------------------------------+
|  Type      |  Name           |  Command   |  Summary                                 |
+============+=================+============+==========================================+
| entity     | MY_SNOWFLAKE_DB | DROP       | entity "MY_SNOWFLAKE_DB" was             |
|            |                 |            | successfully dropped from store          |
|            |                 |            | "sfstore"                                |
+------------+-----------------+------------+------------------------------------------+
demodb.public/sfstore# LIST ENTITIES;
+-----------------+------------+
|  Name           |  Is Leaf   |
+=================+============+
| SNOWFLAKE       | false      |
+-----------------+------------+
| SNOWFLAKE_SAMPL | false      |
| E_DATA          |            |
+-----------------+------------+

Drop a Snowflake schema

demodb.public/sfstore# LIST ENTITIES IN "DELTA_STREAMING";
+---------------------+------------+
|  Name               |  Is Leaf   |
+=====================+============+
| MY_STREAMING_SCHEMA | false      |
+---------------------+------------+
| PUBLIC              | false      |
+---------------------+------------+  
demodb.public/sfstore# DROP ENTITY "DELTA_STREAMING"."MY_SCHEMA";
+------------+---------------------------+------------+------------------------------------------+
|  Type      |  Name                     |  Command   |  Summary                                 |
+============+===========================+============+==========================================+
| entity     | DELTA_STREAMING.MY_SCHEMA | DROP       | entity "DELTA_STREAMING.MY_SCHEMA" was   |
|            |                           |            | successfully dropped from store          |
|            |                           |            | "sfstore"                                |
+------------+---------------------------+------------+------------------------------------------+
demodb.public/sfstore# LIST ENTITIES IN "DELTA_STREAMING";
+---------------------+------------+
|  Name               |  Is Leaf   |
+=====================+============+
| PUBLIC              | false      |
+---------------------+------------+              

Drop a Snowflake table

demodb.public/sfstore# LIST ENTITIES IN "DELTA_STREAMING"."PUBLIC";
+---------------------+------------+
|  Name               |  Is Leaf   |
+=====================+============+
| STREAM_DATA_TBL     | true       |
+---------------------+------------+
| sf_pv_table         | true       |
+---------------------+------------+      
demodb.public/sfstore# DROP ENTITY "DELTA_STREAMING"."PUBLIC".sf_pv_table;
+------------+---------------------------+------------+------------------------------------------+
|  Type      |  Name                     |  Command   |  Summary                                 |
+============+===========================+============+==========================================+
| entity     | DELTA_STREAMING.MY_SCHEMA | DROP       | entity "DELTA_STREAMING.PUBLIC." was     |
|            |                           |            | successfully dropped from store          |
|            |                           |            | "sfstore"                                |
+------------+---------------------------+------------+------------------------------------------+
demodb.public/sfstore# LIST ENTITIES IN "DELTA_STREAMING"."PUBLIC";
+---------------------+------------+
|  Name               |  Is Leaf   |
+=====================+============+
| STREAM_DATA_TBL     | true       |
+---------------------+------------+ 

Drop a Databricks catalog

This example drops the catalog catalog1 from the Databricks store databricks_store, which in turn drops all of its sub-entities as well:

demodb.public/databricks_store# LIST ENTITIES;
+------------+------------+
|  Name      |  Is Leaf   |
+============+============+
| catalog1   | false      |
+------------+------------+
| main       | false      |
+------------+------------+
| system     | false      |
+------------+------------+
demodb.public/databricks_store# DROP ENTITY catalog1;
+------------+------------+------------+------------------------------------------+
|  Type      |  Name      |  Command   |  Summary                                 |
+============+============+============+==========================================+
| entity     | catalog1   | DROP       | entity "catalog1" was successfully       |
|            |            |            | dropped from store                       |
|            |            |            | "databricks_store"                       |
+------------+------------+------------+------------------------------------------+
demodb.public/databricks_store# LIST ENTITIES;
+------------+------------+
|  Name      |  Is Leaf   |
+============+============+
| main       | false      |
+------------+------------+
| system     | false      |
+------------+------------+

Drop a Databricks schema

demodb.public/databricks_store# LIST ENTITIES in catalog1;
+--------------------+------------+
|  Name              |  Is Leaf   |
+====================+============+
| default            | false      |
+--------------------+------------+
| information_schema | false      |
+--------------------+------------+
demodb.public/databricks_store# DROP ENTITY catalog1."default";
+------------+------------------+------------+------------------------------------------+
|  Type      |  Name            |  Command   |  Summary                                 |
+============+==================+============+==========================================+
| entity     | catalog1.default | DROP       | entity "catalog1.default" was            |
|            |                  |            | successfully dropped from store          |
|            |                  |            | "databricks_store"                       |
+------------+------------------+------------+------------------------------------------+    
demodb.public/databricks_store# LIST ENTITIES in catalog1;
+--------------------+------------+
|  Name              |  Is Leaf   |
+====================+============+
| information_schema | false      |
+--------------------+------------+ 

Drop a Databricks table

demodb.public/databricks_store# LIST ENTITIES IN catalog1.schema1;
+--------------------+------------+
|  Name              |  Is Leaf   |
+====================+============+
| pageviews          | true       |
| pv_agg             | true       |
+--------------------+------------+ 
demodb.public/databricks_store# DROP ENTITY catalog1.schema1.pageviews;
+------------+------------------+------------+------------------------------------------+
|  Type      |  Name            |  Command   |  Summary                                 |
+============+==================+============+==========================================+
| entity     | catalog1.default | DROP       | entity "catalog1.schema1.pageviews" was  |
|            |                  |            | successfully dropped from store          |
|            |                  |            | "databricks_store"                       |
+------------+------------------+------------+------------------------------------------+    
demodb.public/databricks_store# LIST ENTITIES IN catalog1.schema1;
+--------------------+------------+
|  Name              |  Is Leaf   |
+====================+============+
| pv_agg             | true       |
+--------------------+------------+