singlestoredb.management.files.FileSpace.download_folder

FileSpace.download_folder(path: str | PathLike[str], local_path: str | PathLike[str] | None = None, *, overwrite: bool = False) → None

Download a FileSpace folder to a local directory.

The contents of path are written into local_path, which is created as the destination folder.

Parameters:

• path (Path or str) – Directory path

• local_path (Path or str, optional) – Local directory to create and download into. Defaults to the name of the path folder in the current directory.

• overwrite (bool, optional) – Should an existing directory / files be overwritten if they exist?