singlestoredb.management.workspace.Stage

class singlestoredb.management.workspace.Stage(deployment_id: str, manager: WorkspaceManager)

Stage manager.

This object is not instantiated directly. It is returned by WorkspaceGroup.stage or StarterWorkspace.stage.

__init__(deployment_id: str, manager: WorkspaceManager)

Methods

__init__(deployment_id, manager)

download_file(stage_path[, local_path, ...])

Download the content of a stage path.

download_folder(stage_path[, local_path, ...])

Download a Stage folder to a local directory.

exists(stage_path)

Does the given stage path exist?

info(stage_path)

Return information about a stage location.

is_dir(stage_path)

Is the given stage path a directory?

is_file(stage_path)

Is the given stage path a file?

listdir([stage_path, recursive])

List the files / folders at the given path.

mkdir(stage_path[, overwrite])

Make a directory in the stage.

mkdirs(stage_path[, overwrite])

Make a directory in the stage.

open(stage_path[, mode, encoding])

Open a Stage path for reading or writing.

remove(stage_path)

Delete a stage location.

removedirs(stage_path)

Delete a stage folder recursively.

rename(old_path, new_path, *[, overwrite])

Move the stage file to a new location.

rmdir(stage_path)

Delete a stage folder.

upload_file(local_path, stage_path, *[, ...])

Upload a local file.

upload_folder(local_path, stage_path, *[, ...])

Upload a folder recursively.