Help Center/ GaussDB(DWS)/ SQL Syntax Reference/ SQL Syntax Reference (9.1.0.x)/ DDL Syntax/ CREATE RESOURCE POOL
Updated on 2025-07-22 GMT+08:00
View PDF
Share

CREATE RESOURCE POOL

Function

CREATE RESOURCE POOL creates a resource pool and specifies the Cgroup for the resource pool.

Precautions

As long as the current user has CREATE permission, it can create a resource pool.

Syntax

1
2
 
CREATE RESOURCE POOL pool_name
    [WITH ({MEM_PERCENT=pct | CONTROL_GROUP="group_name" | ACTIVE_STATEMENTS=stmt | MAX_DOP = dop | MEMORY_LIMIT='memory_size' | io_limits=io_limits | io_priority='priority' | nodegroup='nodegroup_name' | is_foreign = boolean | except_rule='except_rule' | weight=bandwidth_weight | enable_concurrency_scaling=boolean}[, ... ])];

Parameter Description

Table 1 CREATE RESOURCE POOL parameters

Parameter

Description

Value Range

pool_name

Specifies the name of a resource pool.

The name of a resource pool cannot be same as that of an existing resource pool.

Value range: a string. It must comply with the naming convention.

group_name

Specifies the name of a Cgroup.

Value range: a string. It must comply with the rule in the description, specifying an existing Cgroup.

  • You can use either double quotation marks ("") or single quotation mark ('') in the syntax when setting the name of a Cgroup.
  • The value of group_name is case-sensitive.
  • If group_name is not specified, the string "Medium" will be used by default in the syntax, indicating the Medium Timeshare Cgroup under DefaultClass.
  • If an administrator specifies a Workload Cgroup under Class, for example, control_group set to class1:workload1, the resource pool will be associated with the workload1 Cgroup under class1. The level of Workload can also be specified. For example, control_group is set to class1:workload1:1.
  • If a database user specifies the Timeshare string (Rush, High, Medium, or Low) in the syntax, for example, if control_group is set to High, the resource pool will be associated with the High Timeshare Cgroup under DefaultClass.
  • In multi-tenant scenarios, the Cgroup associated with a group resource pool is a Class Cgroup, and that associated with a service resource pool is a Workload Cgroup. Additionally, switching Cgroups between different resource pools is not allowed.

stmt

Specifies the maximum number of statements that can be concurrently executed in a resource pool.

Value range: Numeric data ranging from -1 to INT_MAX.

dop

Specifies the maximum number of simple SQL statements that can be concurrently executed in a resource pool.

Value range: Numeric data ranging from 1 to INT_MAX.

memory_size

Specifies the estimated maximum memory for a resource pool.

Value range: a string

  • default: The memory limit is half of the resource pool memory.
  • unlimited: no limit.
  • The value is from 1 KB to 2047 GB.

mem_percent

Specifies the proportion of available resource pool memory to the total memory or group user memory.

In multi-tenant scenarios, mem_percent of group users or service users ranges from 1 to 100. The default value is 20.

In common scenarios, mem_percent of common users ranges from 0 to 100. The default value is 0.

io_limits

This parameter has been discarded in 8.1.2 and is reserved for compatibility with earlier versions.

-

io_priority

This parameter has been discarded in 8.1.2 and is reserved for compatibility with earlier versions.

-

nodegroup

Specifies the name of a logical cluster where the resource pool is. The logical cluster must already exist.

If the logical cluster name contains uppercase letters or special characters or begins with a digit, enclose the name with double quotation marks in SQL statements.

is_foreign

In logical cluster mode, the current resource pool is used to control the resources of common users who are not associated with the logical cluster specified by nodegroup.
  • nodegroup must specify an existing logical cluster, and cannot be elastic_group or the default Node Group (group_version1), which is generated during cluster installation.
  • If is_foreign is set to true, the resource pool cannot be associated with users. That is, CREATE USER... RESOURCE POOL cannot be used to configure resource pools for users. The resource pool automatically checks whether the users are associated with its logical cluster. If they are not, they will be controlled by the resource pool when performing operations on DNs in the logical cluster.

except_rule

Name of an exception rule set

-

weight

Specifies the network bandwidth weight of the resource pool.

-

enable_concurrency_scaling

Specifies whether to enable the elastic concurrency expansion function. This function is supported only by clusters of version 9.1.0.100 or later.

Value range:

  • true indicates that the elastic concurrent expansion function of jobs in the resource pool is enabled.
  • false indicates that the elastic concurrent expansion function of jobs in the resource pool is disabled.

The default value is false.

Examples

This example assumes that Cgroups have been created by users in advance.

Create a default resource pool, and associate it with the Medium Timeshare Cgroup under Workload under DefaultClass.

1
 
CREATE RESOURCE POOL pool1;

Create a resource pool, and associate it with the High Timeshare Cgroup under Workload under DefaultClass.

1
 
CREATE RESOURCE POOL pool2 WITH (CONTROL_GROUP="High");

Create a resource pool, and associate it with the Low Timeshare Cgroup under Workload under class1.

1
 
CREATE RESOURCE POOL pool3 WITH (CONTROL_GROUP="class1:Low");

Create a resource pool, and associate it with the wg1 Workload Cgroup under class1.

1
 
CREATE RESOURCE POOL pool4 WITH (CONTROL_GROUP="class1:wg1");

Create a resource pool, and associate it with the wg2 Workload Cgroup under class1.

1
 
CREATE RESOURCE POOL pool5 WITH (CONTROL_GROUP="class1:wg2:3");

Create a resource pool and enable the elastic concurrent expansion function of the resource pool.

1
 
CREATE RESOURCE POOL pool6 WITH (enable_concurrency_scaling=true);

Helpful Links

ALTER RESOURCE POOL, DROP RESOURCE POOL

Parent Topic: DDL Syntax