Workspace

class polars_cloud.Workspace(name: str | None = None, *, id: UUID | None = None)

Polars Workspace.

Parameters:

name

Name of the workspace.

id

Workspace identifier.

Attributes:

id	Workspace id.
name	Workspace name.
status	Workspace status.
defaults	Default Cluster Specification.

Methods:

load	Load the workspace details (e.g. name, status, id) from the control plane.
is_active	Whether the Workspace is active.
verify	Verify that a workspace was created correctly.
delete	Delete a workspace.
setup	Create a new workspace.
list	List all workspaces the user has access to.

property id: UUID

Workspace id.

property name: str

Workspace name.

property status: WorkspaceStatus

Workspace status.

property defaults: WorkspaceDefaultComputeSpecs | None

Default Cluster Specification.

load() → None

Load the workspace details (e.g. name, status, id) from the control plane.

Note

Depending on the input load will load the Workspace object by id / name or if neither is given it will attempt to get the users default workspace.

is_active() → bool

Whether the Workspace is active.

verify(*, interval: int = 2, timeout: int = 300) → bool

Verify that a workspace was created correctly.

Parameters:

interval

The number of seconds between each verification call.

timeout

The number of seconds before verification fails.

delete() → None

Delete a workspace.

classmethod setup(name: str, *, verify: bool = True) → Self

Create a new workspace.

Parameters:

name

Name of the workspace

verify

Wait for workspace to become active

classmethod list(

name: str | None = None,

) → list[Workspace]

List all workspaces the user has access to.

Parameters:

name

Filter workspaces by name prefix.