singlestoredb.management.workspace.WorkspaceManager.create_workspace

WorkspaceManager.create_workspace(name: str, workspace_group: str | WorkspaceGroup, size: str | None = None, auto_suspend: Dict[str, Any] | None = None, cache_config: int | None = None, enable_kai: bool | None = None, wait_on_active: bool = False, wait_interval: int = 10, wait_timeout: int = 600) → Workspace

Create a new workspace.

Parameters:

  • name (str) – Name of the workspace

  • workspace_group (str or WorkspaceGroup) – The workspace ID of the workspace

  • size (str, optional) – Workspace size in workspace size notation (S-00, S-1, etc.)

  • auto_suspend (Dict[str, Any], optional) – Auto suspend settings for the workspace. If this field is not provided, no settings will be enabled.

  • cache_config (int, optional) – Specifies the multiplier for the persistent cache associated with the workspace. If specified, it enables the cache configuration multiplier. It can have one of the following values: 1, 2, or 4.

  • enable_kai (bool, optional) – Whether to create a SingleStore Kai-enabled workspace

  • wait_on_active (bool, optional) – Wait for the workspace to be active before returning

  • wait_timeout (int, optional) – Maximum number of seconds to wait before raising an exception if wait=True

  • wait_interval (int, optional) – Number of seconds between each polling interval

Return type:

Workspace