ALTER TENANT

描述

ALTER TENANT 语句用来修改用户租户的属性，包括修改 Locality、主 Zone、资源池列表以及系统变量值等。

如果需要修改用户租户的名称，可以使用 ALTER TENANT ... RENAME 语句。

如果需要锁定或解锁用户租户，可以使用 ALTER TENANT ... LOCK / UNLOCK 语句，使用 ALTER TENANT ... LOCK 语句执行锁定操作后，系统将不允许用户再在被锁定的租户上创建新的连接，已存在的连接不受影响。

权限要求

仅 sys 租户的 root 用户（root@sys）可以修改租户，其他租户不支持修改租户。

语法

ALTER TENANT

ALTER TENANT tenant_name
    [SET] [tenant_option_list] [set_sys_var];

tenant_option_list:
    tenant_option [, tenant_option ...]

tenant_option:
      LOCALITY [=] 'locality_description'
    | PRIMARY_ZONE [=] zone
    | RESOURCE_POOL_LIST [=](pool_name [, pool_name...])
    | ENABLE_ARBITRATION_SERVICE [=] {True | False}
    | [DEFAULT] TABLEGROUP [=] {NULL | tablegroup_name}
    | ENABLE_EXTENDED_ROWID [=] {true | false}  
    | COMMENT [=]'string'   

set_sys_var:
    VARIABLES var_name {TO | =} var_value [,var_name {TO | =} var_value...]

ALTER TENANT ... RENAME

ALTER TENANT tenant_name RENAME GLOBAL_NAME TO new_tenant_name;

ALTER TENANT ... LOCK / UNLOCK

ALTER TENANT tenant_name LOCK | UNLOCK;

参数说明

示例

• 修改租户 tenant1 的 Primary Zone 为 zone2。

  obclient [oceanbase]> ALTER TENANT tenant1 primary_zone='zone2';
  

• 修改资源池通常用于租户副本数升级和降级的场景中，并且修改资源池时，每次只能添加或删除一个资源池，不能执行以下语句直接将租户的资源池 pool1 替换为 pool2，否则将出现以下错误。

  obclient [oceanbase]> ALTER TENANT tenant1 resource_pool_list=('pool2');
  

  报错信息如下：

  ERROR 1210 (HY000): Incorrect arguments to resource pool list
  

  如果您是希望调整租户的可用资源，例如，需要对租户进行扩容，可以调大资源单元的规格。

  obclient [oceanbase]> ALTER RESOURCE UNIT unit1 MAX_CPU 15, MEMORY_SIZE '20G', MAX_IOPS 1280, MIN_CPU=10, MIN_IOPS=1024;
  

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

  1. 创建资源单元 unit2。

     obclient [oceanbase]> CREATE RESOURCE UNIT unit2, MAX_CPU=5, MIN_CPU=2.5, MEMORY_SIZE= '32G', MAX_IOPS=10000, MIN_IOPS=5000, LOG_DISK_SIZE=5301023539200;
     

  2. 创建资源池 pool2。

     obclient [oceanbase]> CREATE RESOURCE POOL pool2 unit='unit2',unit_num=1,zone_list=('B_4');
     

  3. 为租户添加资源池 pool2。

     obclient [oceanbase]> ALTER TENANT tenant1 resource_pool_list=('pool1','pool2');
     

  4. 修改租户的 Locality。

     obclient [oceanbase]> ALTER TENANT tenant1 locality="F@B_1,F@B_2,F@B_3,F@B_4";
     

• 部署了仲裁服务的场景下，为 tenant1 开启仲裁服务。

  obclient [oceanbase]> ALTER TENANT tenant1 ENABLE_ARBITRATION_SERVICE=true;
  

• 将普通租户 tenant1 的名称重命名为 tenant101。

  obclient [oceanbase]> ALTER TENANT tenant1 RENAME GLOBAL_NAME TO tenant101;
  

• 锁定租户 tenant1。

  obclient [oceanbase]> ALTER TENANT tenant1 LOCK;