singlestoredb.management.cluster.ClusterManager

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

SingleStoreDB cluster manager.

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

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

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

See also

singlestoredb.manage_clusters()

__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_cluster(name[, region, provider, ...])	Create a new cluster.
create_starter_cluster(name, database_name)	Create a new starter (shared tier) cluster.
get_cluster(id)	Retrieve a cluster definition.
get_project(id)	Retrieve a project definition.
get_starter_cluster(id)	Retrieve a starter cluster definition.

Attributes

billing	Return the current billing information.
clusters	Return a list of available clusters.
default_base_url	Base URL if none is specified.
default_version	Cluster management API version if none is specified.
obj_type	Object type
organization	Return the current organization.
organizations	Return the organizations.
projects	Return a list of projects in the current organization.
regions	Return a list of available regions.
shared_tier_regions	Return a list of regions that support starter clusters.
starter_clusters	Return a list of available starter clusters.