Create a tenant

This topic describes how to create a business tenant of OceanBase Database by using SQL statements. OceanBase Database allows you to create resource units, resource pools, and business tenants under the sys tenant.

Description

When you create a tenant, if the current resource pool is occupied by another tenant, you need to create a new resource pool. Before you create a resource pool, you must determine the resource unit configurations and range of resources available to the tenant.

Procedure

1. Create a resource unit

A resource unit only defines the specifications but does not allocate resources.

Syntax

CREATE RESOURCE UNIT unit_name
MAX_CPU [=] cpu_num,
[MIN_CPU [=] cpu_num,]
MEMORY_SIZE [=] mem_size,
[LOG_DISK_SIZE = disk_size,]
[MAX_IOPS [=] iops_num,MIN_IOPS [=] iops_num,IOPS_WEIGHT [=] weight_num];

Parameters

Note

By default, you do not need to specify the IOPS parameters. The system automatically calculates the parameter values based on the CPU specification. The following calculation rules are used:

• The minimum value of MAX_IOPS and MIN_IOPS is 1024, and the value of MAX_IOPS must be greater than or equal to that of MIN_IOPS.
• If both MIN_IOPS and MAX_IOPS are not specified, the system automatically calculates their values based on the value of MIN_CPU by using this rule: One CPU core corresponds to 10,000 IOPS.
  • MAX_IOPS = MIN_IOPS = MIN_CPU * 10000.
  • If IOPS_WEIGHT is not specified, IOPS_WEIGHT = MIN_CPU.
  • If IOPS_WEIGHT is specified, the specified value is used.
• If only MAX_IOPS is specified, the value of MAX_IOPS is used for MIN_IOPS and vice versa.
  • If you do not specify IOPS_WEIGHT, the default value 0 is used.

Examples

Create a resource unit named unit001 and allocate 2 CPU cores and 6 GB of memory to the unit:

obclient> CREATE RESOURCE UNIT unit001
     MAX_CPU 2,MEMORY_SIZE '6G';
Query OK, 0 rows affected

or

obclient> CREATE RESOURCE UNIT unit001
     MAX_CPU 2,MEMORY_SIZE 6442450944;
Query OK, 0 rows affected

2. Create a resource pool

The resource pool allocates resources based on the resource unit specifications.

Syntax

CREATE RESOURCE POOL pool_name
UNIT [=] unit_name,
UNIT_NUM [=] unit_num,
ZONE_LIST [=] ('zone' [, 'zone' ...]);

Parameters

Examples

Create a resource pool named pool001.

obclient> CREATE RESOURCE POOL pool001
     UNIT='unit001',UNIT_NUM=1,ZONE_LIST=('zone1','zone2','zone3');
Query OK, 0 rows affected

3. Create a tenant

Allocate the resource pool to the corresponding tenant.

Syntax

CREATE TENANT [IF NOT EXISTS] tenant_name
    [tenant_characteristic_list] [opt_set_sys_var];

tenant_characteristic_list:
    tenant_characteristic [, tenant_characteristic...]

tenant_characteristic:
      COMMENT 'string'  
    | {CHARACTER SET | CHARSET} [=] charset_name
    | COLLATE [=] collation_name
    | PRIMARY_ZONE [=] zone  
    | DEFAULT TABLEGROUP [=] {NULL | tablegroup}
    | RESOURCE_POOL_LIST [=](pool_name [, pool_name...])
    | LOCALITY [=] 'locality description'

opt_set_sys_var:
  {SET | SET VARIABLES | VARIABLES} system_var_name = expr [,system_var_name = expr] ...

Parameters

Examples

• Create a tenant in MySQL mode.

  obclient> CREATE TENANT IF NOT EXISTS mysql001
       CHARSET='utf8mb4',
       PRIMARY_ZONE='zone1;zone2,zone3',
       RESOURCE_POOL_LIST=('pool001')
       SET ob_tcp_invited_nodes='%';
  Query OK, 0 rows affected
  

• Create a tenant in Oracle mode.

  obclient> CREATE TENANT IF NOT EXISTS oracle002
       CHARSET='utf8mb4',
       PRIMARY_ZONE='zone1;zone2,zone3',
       RESOURCE_POOL_LIST=('pool002')
       SET ob_tcp_invited_nodes='%',ob_compatibility_mode='oracle';
  Query OK, 0 rows affected
  

4. Set the password of the administrator user

Notice

For a tenant created by using an SQL statement, the password of the tenant administrator is empty. Set a password before you use the tenant administrator.

Example:

Set the password of the root user under the mysql001 tenant to **1***.

$ obclient -h10.10.10.1 -P2881 -uroot@mysql001 -p -A
Enter password:

obclient> SET PASSWORD = PASSWORD('**1***');
Query OK, 0 rows affected