singlestoredb.manage_workspaces

singlestoredb.manage_workspaces(access_token: str | None = None, version: str | None = None, base_url: str | None = None, *, organization_id: str | None = None) → WorkspaceManager

Retrieve a SingleStoreDB workspace manager.

Deprecated since version Workspaces: and workspace groups were replaced by the flat Cluster resource in management API v2. Use singlestoredb.manage_clusters() instead.

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. Defaults to 'v1', not to the management.version option: workspaces exist only at v1, so there is no version for this function to dispatch on. Passing anything else raises. This is the one public entry point the option does not steer.

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

  • organization_id (str, optional) – ID of organization, if using a JWT for authentication

Return type:

WorkspaceManager

Raises:

ManagementError – If the caller explicitly asks for a version other than v1. Workspaces and workspace groups were replaced by clusters in v2; use singlestoredb.manage_clusters() instead.