Product DocumentationAppearance
sys.cluster
This system view returns state information about each cluster in the current data warehouse instance.
| Column Name | Data Type | Description |
|---|---|---|
| cluster_id | uuid | UUID for the cluster. |
| cluster_name | name | Unique name of the cluster. |
| nodes | smallint | Number of nodes requested for the cluster when it was created or modified. |
| ready_nodes | bigint | Number of hardware nodes currently available and running in this cluster. |
| ready_workers | bigint | Number of workers that have registered in for the cluster and are "online." When clusters are created or modified, the "ready" values steadily increase as hardware nodes are sourced and as workers come online. |
| default_wlm_profile_name | name | Name of the default WLM profile that was defined for the cluster. |
| active_wlm_profile_name | varchar(64000) | Name of the active WLM profile currently assigned to the cluster. |
| hardware_instance_type_id | uuid | UUID for the hardware instance type selected for the cluster. |
| hardware_instance_name | varchar(256) | Name of the hardware instance type selected for the cluster: small-v1 or large-v1. |
| is_default_cluster | boolean | Whether this cluster was created as the default cluster for the instance. |
| auto_suspend | integer | Auto-suspend timeout, in seconds. 0 means that auto-suspend is disabled (as for the default cluster). |
| auto_resume | boolean | Whether this cluster resumes automatically when a query or some other operation attempts to use it. |
| max_spill_pct | integer | Maximum percentage of total disk that can be used for spill space (temporary space). |
| max_cache_pct | integer | Maximum percentage of total disk that can be used for the data cache. |
| type | text | Always COMPUTE (virtual compute cluster). |
| state | text | Cluster state: CREATING, RUNNING, SUSPENDED. |
Example
Return clusters that are currently running in your connected instance. In this case, only the default cluster is running:
yellowbrick=# select * from sys.cluster where state='RUNNING';
-[ RECORD 1 ]-------------+-------------------------------------
cluster_id | 10d6f4b5-659b-4814-8b53-ac99d73c03f6
cluster_name | prod-rc7-cluster-01
nodes | 2
ready_nodes | 2
ready_workers | 2
default_wlm_profile_name | default
active_wlm_profile_name | default
hardware_instance_type_id | f43d64aa-828e-42cc-b402-60e008c544a3
hardware_instance_name | small-v1
is_default_cluster | t
auto_suspend | 0
auto_resume | t
max_spill_pct | 30
max_cache_pct | 70
type | COMPUTE
state | RUNNINGParent topic:System Views