Query.file

Query.file(name, *, file_id_variable, file_name_variable) → File

Reference a file within the query results. Only relevant for query results that contain at least one variable with file ids. If the query result contains multiple file id variables, must specify the file_id_variable parameter.

Parameters:

name : str | pathlib.Path The full name of the file.

file_id_variable : str, optional The name of the variable in the query results containing file ids. Only required if the query results contain more than one fileId variable.

file_name_variable : str, optional The name of the variable in the query result containing the file name. If unspecified, will look for a variable file_name , or otherwise will use the file's original name.

Returns:

File

Last updated

Was this helpful?