CREATE RESOURCE UNIT

Purpose

OceanBase Database manages physical resources by using units. The sys tenant can create units and specify the resource specifications of the units by using the CREATE RESOURCE UNIT statement. The resource specifications of a unit define the total amount of common physical resources, including CPU, memory, log disk storage space, IOPS, and so on.

The resource specifications of a unit define the total amount of resources that can be allocated to a single OBServer node within a single zone. A tenant can use the resources of a node only when it has a unit on that node.

The total amount of resources allocated to a tenant is equal to the unit specification multiplied by the number of units.

Limitations and considerations

The resource specifications of a unit cannot exceed the total amount of resources that can be allocated to a single node.

Privilege requirements

Only the root user of the sys tenant (root@sys) can create units. Other tenants are not supported to create units.

Syntax

CREATE RESOURCE UNIT [IF NOT EXISTS] unit_name
MEMORY_SIZE [=] 'size_value',
MAX_CPU [=] cpu_num,
[MAX_IOPS [=] iops_num,]
[MIN_CPU [=] cpu_num,]
[MIN_IOPS [=] iops_num,]
[IOPS_WEIGHT [=]iopsweight,]
[MAX_NET_BANDWIDTH [=] bandwidth_num,]
[NET_BANDWIDTH_WEIGHT [=] bandwidth_weight_num,]
[DATA_DISK_SIZE [=] 'size_value',]
[LOG_DISK_SIZE [=] 'size_value'];

Parameters

Examples

• Create a unit named unit1 with 4 CPU cores, 5G memory, 10G log disk space, IOPS limits of 1280 and 1024, and an IOPS weight of 1. Each unit can use up to 5M of network bandwidth with a weight of 10.

  obclient(root@sys)[(none)]> CREATE RESOURCE UNIT unit1 MAX_CPU 4, MEMORY_SIZE '5G', MAX_IOPS 1280, MIN_IOPS=1024, IOPS_WEIGHT=1, MAX_NET_BANDWIDTH '5M',NET_BANDWIDTH_WEIGHT 10, LOG_DISK_SIZE '10G';
  

  After the unit is created, you can confirm the result by querying the view. The statement is as follows:

  obclient(root@sys)[oceanbase]> SELECT * FROM oceanbase.DBA_OB_UNIT_CONFIGS WHERE NAME='unit1';
  

  The query result is as follows:

  +----------------+-------+----------------------------+----------------------------+---------+---------+-------------+---------------+----------------+----------+----------+-------------+-------------------+----------------------+
  | UNIT_CONFIG_ID | NAME  | CREATE_TIME                | MODIFY_TIME                | MAX_CPU | MIN_CPU | MEMORY_SIZE | LOG_DISK_SIZE | DATA_DISK_SIZE | MAX_IOPS | MIN_IOPS | IOPS_WEIGHT | MAX_NET_BANDWIDTH | NET_BANDWIDTH_WEIGHT |
  +----------------+-------+----------------------------+----------------------------+---------+---------+-------------+---------------+----------------+----------+----------+-------------+-------------------+----------------------+
  |           1001 | unit1 | 2025-05-28 11:19:39.116490 | 2025-05-28 11:19:39.116490 |       4 |       4 |  5368709120 |   10737418240 |           NULL |     1280 |     1024 |           1 |           5242880 |                   10 |
  +----------------+-------+----------------------------+----------------------------+---------+---------+-------------+---------------+----------------+----------+----------+-------------+-------------------+----------------------+
  1 row in set
  

• In SS mode, create a unit named unit1 with 4 CPU cores, 5G memory, and 100G of local disk space per unit.

  obclient(root@sys)[(none)]> CREATE RESOURCE UNIT unit1 MAX_CPU 4, MEMORY_SIZE '5G', DATA_DISK_SIZE '100G';
  

References

• Tenant introduction

• Create a tenant

• View resource specifications

• DROP RESOURCE UNIT