Important

New database features are no longer connected to engine versions; features are now enabled independently during scheduled update windows, and “major” and “minor” releases no longer exist in Helios. Please visit the release notes to view the latest features available in your database clusters.

CREATE WORKSPACE

Syntax

CREATE WORKSPACE [ IF NOT EXISTS ] '<cluster_name>'
    [ IN GROUP { ID '<group_ID>' | '<group_name>' } ]
    WITH SIZE '<cluster_size>'
    [ AUTO SUSPEND AFTER <suspend_time> { SECONDS | MINUTES | HOURS | DAYS } WITH TYPE { IDLE | SCHEDULED | DISABLED } ]
    [ ENABLE KAI ]
    [ WITH CACHE CONFIG <multiplier> ]
    [ WAIT ON ACTIVE ]

Arguments

cluster_name: Name of the cluster.
group_ID, group_name: ID or name of the deployment (cluster group) in which the cluster is created.
cluster_size: Size of the cluster in the cluster size notation, for example, "S-1".
suspend_time: Time in the specified units after which the cluster is automatically suspended, depending on the specified suspend type.
multiplier: Specifies the multiplier for the persistent cache associated with the cluster.

Remarks

Specify the IF NOT EXISTS clause to create a new cluster only when a cluster with the specified name does not exist already. If a cluster with the specified name already exists and the IF NOT EXISTS clause is not specified, the CREATE WORKSPACE command returns an error.
If the WITH CACHE CONFIG clause is specified, it enables the cache configuration multiplier. It can have one of the following values: 1, 2, or 4.
If the WAIT ON ACTIVE clause is specified, query execution is paused for this cluster until it reaches the ACTIVE state.
Specify ENABLE KAI to enable SingleStore Kai (the MongoDB® API) for the cluster.

Example

The following command creates a new cluster named test in a cluster group named s2-group:

SQL

CREATE WORKSPACE 'test' IN GROUP 's2-group'
   WITH SIZE 'S-1' WAIT ON ACTIVE;