delete_entity() | FeatureStore Delete Method | Teradata Package for Python - delete_entity() - Teradata Package for Python

Use the delete_entity() method to remove the archived entity from the repository.

Required Parameter

entity

Specifies either the name of the entity or object of the entity to remove from the repository.

Example setup

>>> from teradataml import DataFrame, Entity, FeatureStore

Create teradataml DataFrame.

>>> load_example_data('dataframe', ['sales'])
>>> df = DataFrame("sales")

Create FeatureStore for repo 'vfs_v1'.

>>> fs = FeatureStore("vfs_v1")

Repo vfs_v1 does not exist. Run FeatureStore.setup() to create the repo and setup FeatureStore.

Set up FeatureStore for this repository.

>>> fs.setup()

True

Example 1: Delete the Entity 'sales_data' in the repo 'vfs_v1' using Entity name

Create Entity using teradataml DataFrame Column.

>>> entity = Entity(name="sales_data", columns=df.accounts)

Apply the entity to FeatureStore.

>>> fs.apply(entity)

True

List all the available entities.

>>> fs.list_entities()

                          description               creation_time modified_time entity_column
name       data_domain
sales_data ALICE                 None  2025-07-28 04:58:01.123456          None      accounts

Archive the entity.

>>> fs.archive_entity(entity=entity.name)

Entity 'sales_data' is archived.
True

Delete the entity with name "sales_data".

>>> fs.delete_entity(entity=entity.name)

Entity 'sales_data' is deleted.
True

List the entities after delete.

>>> fs.list_entities()

Empty DataFrame
Columns: [id, column_name, description, tags, data_type, feature_type, status, creation_time, modified_time, group_name]
Index: []

Example 2: Delete the Entity 'sales_data' in the repo 'vfs_v1' using Entity object

Create Entity using teradataml DataFrame Column.

>>> entity2 = Entity(name="sales_data_df", columns=df.accounts)

Apply the entity to FeatureStore.

>>> fs.apply(entity2)

True

List all the available entities.

>>> fs.list_entities()

                             description               creation_time modified_time entity_column
name       data_domain
sales_data_df ALICE                 None  2025-07-28 04:59:14.325456          None      accounts

Archive the entity.

>>> fs.archive_entity(entity=entity2)

Entity 'sales_data_df' is archived.
True

Delete the entity with the entity object.

>>> fs.delete_entity(entity=entity2)

Entity 'sales_data_df' is deleted.
True