DESCRIBE COMPUTE POOL¶
Describes the properties of a compute pool.
DESCRIBE can be abbreviated to DESC.
Syntax¶
DESC[RIBE] COMPUTE POOL <name>
Parameters¶
name
Specifies the identifier for the compute pool to describe.
If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.
For more information, see Identifier requirements.
Output¶
The command output provides compute pool properties and metadata in the following columns:
Column |
Description |
---|---|
|
Compute pool name. |
|
Current state of the compute pool. |
|
Minimum number of nodes in the compute pool. |
|
Maximum number of nodes in the compute pool. |
|
Specifies the machine type of nodes in the compute pool. |
|
The number of services and jobs running on the compute pool. |
|
Number of jobs running on the compute pool. |
|
Specifies the number of seconds of inactivity after which the compute pool is automatically suspended. |
|
Specifies whether to automatically resume a compute pool when Snowflake attempts to start a service or job. |
|
Number of nodes in the compute pool that are active (one or more services or jobs are running). |
|
Number of nodes in the compute pool that are idle (no service or job is running). |
|
Indicates the number of nodes that Snowflake is targeting for your compute pool. If The following examples demonstrate how to interpret the values in the Example 1: Suppose in a CREATE COMPUTE POOL command, you specify MIN_NODES=1 and MAX_NODES=3. While Snowflake is provisioning a node, initially the value in the After Snowflake provisions one node, the value in the Example 2: Snowflake might try to add a node to an existing compute pool due to autoscaling or changes to the minimum number of nodes (through ALTER COMPUTE POOL … SET MIN_NODES). While Snowflake is provisioning a node, the value in the For example, suppose that the value in the, |
|
Date and time when the compute pool was created. |
|
Date and time when the suspended compute pool was resumed. |
|
Date and time when the compute pool was updated using ALTER COMPUTE POOL. |
|
Role that owns the compute pool. |
|
Specifies a comment for the compute pool. |
|
|
|
Name of the Snowflake Native App if the compute pool is created exclusively for the app. Otherwise, NULL. |
|
The name of the budget monitoring the credit usage of the compute pool. |
|
Error code, if any, relevant to the STATUS_MESSAGE. Otherwise, this field is empty. For example, when you resize a compute pool:
|
|
Optional message about the status of the compute pool. For example:
|
Access control requirements¶
A role used to execute this SQL command must have the following privileges at a minimum:
Privilege |
Object |
Notes |
---|---|---|
MONITOR |
Compute pool |
For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.
For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.
Usage notes¶
To post-process the output of this command, you can use the RESULT_SCAN function, which treats the output as a table that can be queried.
Examples¶
The following example describes the compute pool named tutorial_compute_pool
:
DESCRIBE COMPUTE POOL tutorial_compute_pool;
Sample output:
+-----------------------+--------+-----------+-----------+-----------------+--------------+----------+-------------------+-------------+--------------+------------+--------------+-------------------------------+-------------------------------+-------------------------------+-----------+---------+--------------+-------------+--------+------------+----------------+
| name | state | min_nodes | max_nodes | instance_family | num_services | num_jobs | auto_suspend_secs | auto_resume | active_nodes | idle_nodes | target_nodes | created_on | resumed_on | updated_on | owner | comment | is_exclusive | application | budget | error_code | status_message |
|-----------------------+--------+-----------+-----------+-----------------+--------------+----------+-------------------+-------------+--------------+------------+--------------+-------------------------------+-------------------------------+-------------------------------+-----------+---------+--------------+-------------+--------+------------+----------------|
| TUTORIAL_COMPUTE_POOL | ACTIVE | 1 | 1 | CPU_X64_XS | 3 | 0 | 3600 | true | 1 | 0 | 1 | 2024-02-24 20:41:31.978 -0800 | 2024-08-08 11:27:01.775 -0700 | 2024-08-18 13:29:08.124 -0700 | TEST_ROLE | NULL | false | NULL | NULL | | |
+-----------------------+--------+-----------+-----------+-----------------+--------------+----------+-------------------+-------------+--------------+------------+--------------+-------------------------------+-------------------------------+-------------------------------+-----------+---------+--------------+-------------+--------+------------+----------------+