singlestoredb.management.stage.Stage.download_folder

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

Download a Stage folder to a local directory.

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

Parameters:

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

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

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