singlestoredb.management.cluster.StarterCluster

class singlestoredb.management.cluster.StarterCluster(name: str, id: str, database_name: str, endpoint: str | None = None, mysql_dml_port: int | None = None, websocket_port: int | None = None, project: str | Project | None = None)

SingleStoreDB starter (shared tier) cluster definition.

This object is not instantiated directly. Existing starter clusters are accessed by either ClusterManager.starter_clusters or by calling ClusterManager.get_starter_cluster().

See also

ClusterManager.get_starter_cluster(), ClusterManager.create_starter_cluster(), ClusterManager.starter_clusters

__init__(name: str, id: str, database_name: str, endpoint: str | None = None, mysql_dml_port: int | None = None, websocket_port: int | None = None, project: str | Project | None = None)

Methods

__init__(name, id, database_name[, ...])
connect(**kwargs)	Create a connection to the database server for this starter cluster.
create_user(username[, password])	Create a new user for this starter cluster.
from_dict(obj, manager)	Construct a StarterCluster from a dictionary of values.
refresh()	Update the object to the current state.
terminate()	Terminate the starter cluster.

Attributes

organization	Return the organization the starter cluster belongs to.
project	Project the starter cluster belongs to, or None if it reported no project.
stage	Stage manager.
stages	Stage manager.
starter_clusters	Return a list of available starter clusters.
name	Name of the starter cluster
id	Unique ID of the starter cluster
database_name	Name of the database associated with the starter cluster
endpoint	Endpoint to connect to the starter cluster, in the form hostname:port
mysql_dml_port	MySQL DML port for the starter cluster
websocket_port	WebSocket port for the starter cluster