featurebyte.BatchRequestTable.download

download(

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

overwrite: bool=False

) -> Path

Description

Downloads the batch request 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

>>> batch_request_table = catalog.get_batch_request_table(
...     "batch_request_table_name"
... )  # doctest: +SKIP

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