Directory

class Directory

Any table or query result on Redivis that contains file ids can be read as a directory, where the file names are parsed according to any / separators, and a directory tree is created.

This virtual directory can then be used to navigate, download, and even mount a given file tree.

Constructors

Directory$get(path)	Returns a subdirectory within a directory.
Query$to_directory(name)	Load query results that contain a file_id variable as a directory.
Table$to_directory(name)	Load any table contains a file_id variable as a directory.

Examples

Basics

dir <- redivis$table("table_ref")$to_directory()
print(dir$list()) # list files + directories within this directory
all_files <- dir$list(mode="files", recursive=True)

file <- dir$get("path/to/file.txt") # Will return None if doesn't exist
subdir <- dir$get("path/to/subdir")

Mount & Download files

dir <- redivis$table("table_ref")$to_directory()

# Download all files to the provided path
dir$download("/download/path")

# dir$mount() behaves the same as dir$download() was called (all files appear on disk)
# However, this doesn't actually download the files until they're needed, 
#    and as such is much faster, particularly when all files may not need to be read.
dir$mount("/download/path")

Attributes

path	The path of this directory relative to the root directory in the current tree. The path of the top-level directory (that is, any directory returned from table / query $to_directory() ) will always be "/"
query	A reference to the Query that constructed this directory. Will be None if the directory is derived from a table.
table	A reference to the Table that constructed this directory. Will be None if the directory is derived from a query.

Methods

Directory$download([path, overwrite, ...])	Downloads files in the directory to the specified path.
Directory$get(path)	Get a file or directory relative to this directory
Directory$list([max_results, mode, recursive])	List the contents of a directory
Directory$mount([path, foreground])	Mount the directory as a volume at the provided path, allowing files to be lazily loaded as they're accessed.
Directory$unmount([path, foreground])	Unmounts a previously mounted directory.