DESCRIBE COMPUTE POOL¶

Describes the properties of a compute pool.

DESCRIBE can be abbreviated to DESC.

See also:

CREATE COMPUTE POOL , ALTER COMPUTE POOL, DROP COMPUTE POOL , SHOW COMPUTE POOLS

Syntax¶

DESC[RIBE] COMPUTE POOL <name>
Copy

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

name

Compute pool name.

state

Current state of the compute pool.

min_nodes

Minimum number of nodes in the compute pool.

max_nodes

Maximum number of nodes in the compute pool.

instance_family

Specifies the machine type of nodes in the compute pool.

num_services

The number of services and jobs running on the compute pool.

num_jobs

Number of jobs running on the compute pool.

auto_suspend_secs

Specifies the number of seconds of inactivity after which the compute pool is automatically suspended.

auto_resume

Specifies whether to automatically resume a compute poll when Snowflake attempts to start a service or job.

active_nodes

Number of nodes in the compute pool that are active (one or more services or jobs are running).

created_on

Date and time when the compute pool was created.

resumed_on

Date and time when the suspended compute pool was resumed.

updated_on

Date and time when the compute pool was updated using ALTER COMPUTE POOL.

owner

Role that owns the compute pool.

comment

Specifies a comment for the compute pool.

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;
Copy

Sample output:

+-----------------------+--------+-----------+-----------+-----------------+--------------+----------+-------------------+-------------+--------------+------------+-------------------------------+-------------------------------+-------------------------------+--------------+---------+
| name                  | state  | min_nodes | max_nodes | instance_family | num_services | num_jobs | auto_suspend_secs | auto_resume | active_nodes | idle_nodes | created_on                    | resumed_on                    | updated_on                    | owner        | comment |
|-----------------------+--------+-----------+-----------+-----------------+--------------+----------+-------------------+-------------+--------------+------------+-------------------------------+-------------------------------+-------------------------------+--------------+---------|
| TUTORIAL_COMPUTE_POOL | ACTIVE |         1 |         1 | CPU_X64_XS      |            1 |        0 |                 0 | false       |            1 |          0 | 2023-05-01 11:42:20.323 -0700 | 2023-05-01 11:42:20.326 -0700 | 2023-08-27 17:35:52.761 -0700 | ACCOUNTADMIN | NULL    |
+-----------------------+--------+-----------+-----------+-----------------+--------------+----------+-------------------+-------------+--------------+------------+-------------------------------+-------------------------------+-------------------------------+--------------+---------+
Language: English