Query$download_files
Query$download_files(path=getwd(), *, overwrite=FALSE, max_results=NULL, file_id_variable=NULL, 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).
Parameters:
path
: str, default getwd()
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 NULL
If specified, will only download up to the specified number of files
file_id_variable
: str, default NULL
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.
Returns:
list<File>
Last updated