archive_datasets() | DatasetCatalog Method | Teradata Package for Python - archive_datasets() - Teradata Package for Python

Use the archive_datasets() method to archive the dataset from the dataset catalog.

Required Parameter

id

Specifies the dataset id to be archived from the dataset catalog.

Example setup

Upload features first to create a dataset.

>>> from teradataml import load_example_data, FeatureProcess
>>> load_example_data('dataframe', 'sales')
>>> df = DataFrame("sales")

Create a feature store.

>>> fs = FeatureStore(repo='vfs_v1', data_domain='sales')

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

Run FeatureProcess to ingest features.

>>> fp = FeatureProcess(repo='vfs_v1', data_domain='sales', object=df, entity='accounts',
...                     features=['Jan', 'Feb', 'Mar', 'Apr'])

>>> fp.run()

Process '3acf5632-5d73-11f0-99c5-a30631e77953' started.
Process '3acf5632-5d73-11f0-99c5-a30631e77953' completed.

Build a dataset.

>>> from teradataml import DatasetCatalog
>>> dc = DatasetCatalog(repo='vfs_v1', data_domain='sales')
>>> dataset = dc.build_dataset(entity='accounts',
...                            selected_features = {
...                                        'Jan': fp.process_id,
...                                        'Feb': fp.process_id},
...                            view_name='ds_jan_feb',
...                            description='Dataset with Jan and Feb features')

List the datasets.

>>> dc.list_datasets()

                                     data_domain          name entity_name                            description                       valid_start                       valid_end
id
851a651a-68a3-4eb6-b606-df2617089068       sales  ds_jan_feb_1    accounts      Dataset with Jan and Feb features    2025-07-10 09:50:25.527852+00:  9999-12-31 23:59:59.999999+00:

Example: Archive the dataset

>>> dc.archive_datasets('851a651a-68a3-4eb6-b606-df2617089068')

Dataset id(s) '851a651a-68a3-4eb6-b606-df2617089068' is/are archived from the dataset catalog.
True

List the datasets.

>>> dc.list_datasets()

                                     data_domain          name entity_name                            description                      valid_start                       valid_end
id
851a651a-68a3-4eb6-b606-df2617089068       sales  ds_jan_feb_1    accounts      Dataset with Jan and Feb features   2025-07-10 09:50:25.527852+00:  2025-07-10 09:55:02.830000+00: