aito.api.download_table

aito.api.download_table(client: AitoClient, table_name: str, output_folder: PathLike, file_name: str = None, batch_size: int = 5000, gzip_output: bool = False)

download a table to a NDJSON file or a gzipped NDJSON file

Parameters:

  • client (AitoClient) – the AitoClient instance

  • table_name (str) – the name of the table

  • output_folder (PathLike) – the folder where the output file is written to

  • batch_size (int) – the number of entries to be downloaded at once, defaults to 5000

  • gzip_output (bool) – gzip the output file, defaults to False

Parm file_name:

the name of the output file, defaults to None in which the table name is used the file name