Skip to content

featurebyte.HistoricalFeatureTable.download

download(
output_path: Union[str, Path, NoneType]=None,
overwrite: bool=False
) -> Path

Description

Downloads the historical feature table from the database.

Parameters

  • output_path: Union[str, Path, NoneType]
    Location to save downloaded parquet file.

  • overwrite: bool
    default: False
    Overwrite the file if it already exists.

Returns

  • Path

Raises

  • FileExistsError
    File already exists at output path.

  • RecordRetrievalException
    Error retrieving record from API.

Examples

>>> historical_feature_table = catalog.get_historical_feature_table(
...     "historical_feature_table_name"
... )  # doctest: +SKIP

>>> downloaded_path = historical_feature_table.download(
...     output_path="path/to/download"
... )  # doctest: +SKIP