featurebyte.BatchFeatureTable.download

download(

output_path: Union[str, Path, NoneType]=None

) -> Path

Description

Downloads the batch feature table from the database.

Parameters

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

Returns

• Path
  
  

Raises

• FileExistsError
  File already exists at output path.
  
  
• RecordRetrievalException
  Error retrieving record from API.
  
  

Examples

>>> batch_feature_table = catalog.get_batch_feature_table("batch_feature_table_name")
>>> downloaded_path = batch_feature_table.download(output_path="path/to/download")