Query.download_files(path=os.cwd(), *, overwrite=False, max_results=None, file_id_variable=None, progress=True) → list<File>

Downloads files associated with the query to the directory specified at path. Only relevant for queries against file index tables (the query result must also contain the file_id variable).


path : str The path of the directory to download files. Will automatically create the directory if it doesn't exist. If not specified, defaults to the current working directory.

overwrite : bool, default False Whether to overwrite any existing files when downloading. If False, will throw an error if a file with the same name already exists at the provided path.

max_results : int, default None If specified, will only download up to the specified number of files

file_id_variable : str, default None The variable in the query results containing file ids. Only required if the query results contains more than one file id variable.

progress : bool, default True Whether to show progress bar.



Last updated