singlestoredb.management.workspace.Stage.download_folder

Stage.download_folder(stage_path: str | PathLike[str], local_path: str | PathLike[str] = '.', *, overwrite: bool = False) → None

Download a Stage folder to a local directory.

Parameters:

• stage_path (Path or str) – Path to the stage file

• local_path (Path or str) – Path to local directory target location

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