singlestoredb.management.workspace.WorkspaceManager

class singlestoredb.management.workspace.WorkspaceManager(access_token: str | None = None, version: str | None = None, base_url: str | None = None, *, organization_id: str | None = None)

SingleStoreDB workspace manager.

This class should be instantiated using singlestoredb.manage_workspaces().

Parameters:

• access_token (str, optional) – The API key or other access token for the workspace management API

• version (str, optional) – Version of the API to use

• base_url (str, optional) – Base URL of the workspace management API

See also

singlestoredb.manage_workspaces()

__init__(access_token: str | None = None, version: str | None = None, base_url: str | None = None, *, organization_id: str | None = None)

Methods

__init__([access_token, version, base_url, ...])
create_starter_workspace(name, ...)	Create a new starter (shared tier) workspace.
create_workspace(name, workspace_group[, ...])	Create a new workspace.
create_workspace_group(name, region, ...[, ...])	Create a new workspace group.
get_starter_workspace(id)	Retrieve a starter workspace definition.
get_workspace(id)	Retrieve a workspace definition.
get_workspace_group(id)	Retrieve a workspace group definition.
regions	Return a list of available regions.
shared_tier_regions	Return a list of regions that support shared tier workspaces.

Attributes

billing	Return the current billing information.
default_base_url	Base URL if none is specified.
default_version	Workspace management API version if none is specified.
obj_type	Object type
organization	Return the current organization.
organizations	Return the organizations.
starter_workspaces	Return a list of available starter workspaces.
workspace_groups	Return a list of available workspace groups.