ALTER TENANT - OceanBase 数据库 V4.1.0

ALTER TENANT

更新时间：2023-07-28 10:45:58

描述

该语句用来修改租户信息。

该语句仅支持在 sys 租户中执行，同时仅 sys 租户的管理员可以执行。

语法

ALTER TENANT {tenant_name | ALL}
    [SET] [tenant_option_list] [opt_global_sys_vars_set];

tenant_option_list:
    tenant_option [, tenant_option ...]

tenant_option:
            COMMENT [=]'string' 
          | {CHARACTER SET | CHARSET} [=] charset_name 
          | COLLATE [=]  collation_name 
          | ZONE_LIST [=] (zone [, zone...]) 
          | PRIMARY_ZONE [=] zone 
          | RESOURCE_POOL_LIST [=](pool_name [, pool_name...]) 
          | DEFAULT TABLEGROUP [=] {NULL | tablegroup_name}
          | {READ ONLY | READ WRITE}
          | LOCALITY [=] 'locality_description'
          | RENAME GLOBAL_NAME TO new_tenant_name
      
opt_global_sys_vars_set:
      VARIABLES system_var_name = expr [,system_var_name = expr] ...

参数说明

参数	描述
tenant_name	指定要修改的租户名。`ALL` 表示修改所有租户。
RESOURCE_POOL_LIST	资源池列表。
DEFAULT TABLEGROUP	设置租户默认表组信息，`NULL` 表示取消数据库默认表组。
COMMENT	修改注释。
CHARACTER SET \| CHARSET	修改租户的字符集。说明当前版本暂不支持此参数。
COLLATE	修改租户的字符序。说明当前版本暂不支持此参数。
ZONE_LIST	指定要修改的 Zone 列表。说明当前版本暂不支持此参数。
PRIMARY_ZONE	指定租户的 Primary Zone。
READ ONLY \| READ WRITE	指定租户的只读或读写属性。说明当前版本暂不支持此参数。
LOCALITY	描述副本在 Zone 间的分布情况，如：`F@z1,F@z2,F@z3` 表示 `z1`、`z2` 和 `z3` 为全功能副本。
system_var_name	修改租户的系统变量值。
RENAME GLOBAL_NAME TO	修改租户名称。

示例

修改租户 tenant1 的 Primary Zone 为 zone2。

obclient> ALTER TENANT tenant1 primary_zone='zone2';
Query OK, 0 rows affected

不可直接替换租户的资源池，否则将出现以下错误。

obclient> ALTER TENANT tenant1 resource_pool_list=('pool2');
ERROR 1210 (HY000): Incorrect arguments to resource pool list

如果您希望对租户进行扩容，可以修改资源单元的规格。

obclient> ALTER RESOURCE UNIT unit1 MAX_CPU 15, MEMORY_SIZE '20G', MAX_IOPS 1280, MIN_CPU=10, MIN_IOPS=1024;
Query OK, 0 rows affected

修改租户 tenant1 的 Locality，增加副本数。其中 F 表示副本类型为全功能型副本，B_4 为新增的 Zone 名称。

obclient> CREATE RESOURCE UNIT unit1, MAX_CPU=5, MIN_CPU=2.5, MEMORY_SIZE= 34359738368, MAX_IOPS=10000, MIN_IOPS=5000, LOG_DISK_SIZE=5301023539200;
Query OK, 0 rows affected

obclient> CREATE RESOURCE POOL pool1 unit='unit1',unit_num=1,zone_list=('B_4');
Query OK, 0 rows affected

obclient> ALTER TENANT tenant1 resource_pool_list=('sys_pool','sys_pool1');
Query OK, 0 rows affected

obclient> ALTER TENANT tenant1 locality="F@B_1,F@B_2,F@B_3,F@B_4";
Query OK, 0 rows affected

修改普通租户的名称。

obclient> ALTER TENANT tenant1 RENAME GLOBAL_NAME TO tenant101;
Query OK, 0 rows affected