singlestoredb.manage_clusters

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

Retrieve a SingleStoreDB cluster manager.

Parameters:

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

  • version (str, optional) – Version of the API to use. Defaults to the management.version option (the SINGLESTOREDB_MANAGEMENT_VERSION environment variable), or to DEFAULT_CLUSTER_VERSION when that is unset.

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

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

Return type:

ClusterManager

Raises:

ManagementError – If v1 is the resolved version, whether requested by the caller or by the management.version option. Clusters were introduced in v2; the v1 equivalents are workspaces, reached with singlestoredb.manage_workspaces().