teradataml.store.feature_store.feature_store.FeatureStore.archive_feature = archive_feature(self, feature)

DESCRIPTION:
    Archives Feature from repository. Note that archived Feature
    is not available for any further processing. Archived Feature can be
    viewed using "list_features(archived=True)" method.
 
PARAMETERS:
    feature:
        Required Argument.
        Specifies either the name of Feature or Object of Feature
        to archive from repository.
        Types: str OR Feature
 
RETURNS:
    bool
 
RAISES:
    TeradataMLException, TypeError, ValueError
 
EXAMPLES:
    >>> from teradataml import DataFrame, Feature, 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.
    # Setup FeatureStore for this repository.
    >>> fs.setup()
    True
 
    Example 1: Archive the Feature 'sales_data_Feb' in the repo 'vfs_v1' using Feature object.
    # Create Feature for Column 'Feb'.
    >>> feature = Feature(name="sales_data_Feb", column=df.Feb)
    # Apply the Feature to FeatureStore.
    >>> fs.apply(feature)
    True
 
    # List the available Features.
    >>> fs.list_features()
                                id column_name description  tags data_type feature_type  status               creation_time modified_time group_name
    name           data_domain                                                                                                                      
    sales_data_Feb ALICE         1         Feb        None  None     FLOAT   CONTINUOUS  ACTIVE  2025-07-28 04:41:01.641026          None       None
 
    # Archive Feature with name "sales_data_Feb".
    >>> fs.archive_feature(feature=feature)
    Feature 'sales_data_Feb' is archived.
    True
 
    # List the available archived Features.
    >>> fs.list_features(archived=True)
       id            name data_domain column_name description  tags data_type feature_type  status               creation_time modified_time               archived_time group_name
    0   1  sales_data_Feb       ALICE         Feb        None  None     FLOAT   CONTINUOUS  ACTIVE  2025-07-28 04:41:01.641026          None  2025-07-28 04:41:35.600000       None
 
    # Example 2: Archive the Feature 'sales_data_Feb' in the repo 'vfs_v1' using feature name.
    # Create Feature for Column 'Jan'.
    >>> feature2 = Feature(name="sales_data_Jan", column=df.Jan)
    # Apply the Feature to FeatureStore.
    >>> fs.apply(feature2)
    True
 
    # Archive Feature with name "sales_data_Jan".
    >>> fs.archive_feature(feature="sales_data_Jan")
    Feature 'sales_data_Jan' is archived.
    True
 
    # List the available archived Features.
    >>> fs.list_features(archived=True)
       id            name data_domain column_name description  tags data_type feature_type  status               creation_time modified_time               archived_time group_name
    0   1  sales_data_Feb       ALICE         Feb        None  None     FLOAT   CONTINUOUS  ACTIVE  2025-07-28 04:41:01.641026          None  2025-07-28 04:41:35.600000       None
    1   2  sales_data_Jan       ALICE         Jan        None  None     FLOAT   CONTINUOUS  ACTIVE  2025-07-28 04:42:01.641026          None  2025-07-28 04:43:35.600000       None