Files
oceanbase/docs/docs-cn/10.sql-reference/5.sql-statement/9.alter-tenant.md
2022-02-10 14:51:49 +08:00

3.6 KiB

ALTER TENANT

描述

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

格式

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} [=] charsetname 
            |COLLATE [=]  collationname 
            |REPLICA_NUM [=] num 
            |ZONE_LIST [=] (zone [, zone...]) 
            |PRIMARY_ZONE [=] zone 
            |RESOURCE_POOL_LIST [=](poolname [, poolname...]) 
            |DEFAULT TABLEGROUP [=] {NULL | tablegroupname}
            |{READ ONLY | READ WRITE}
      |LOGONLY_REPLICA_NUM [=] num
      |LOCALITY [=] 'locality description'
      |LOCK|UNLOCK;
      
opt_global_sys_vars_set:
      VARIABLES system_var_name = expr [,system_var_name = expr] ...

参数解释

参数 描述
tenant_name 指定要修改的租户名。
ALTER TENANT ALL 同时修改所有租户。
RESOURCE_POOL_LIST 资源池列表,为创建租户时的必填项,暂时只支持一个 RESOURCE POOL。
DEFAULT TABLEGROUP 设置租户默认表组信息,NULL 表示取消ovtn库默认表组。
LOCK|UNLOCK 租户锁定和解锁。对租户进行锁定后,不能在该租户上创建新的连接,已有连接保持不变。通常在客户费用到期未续费的场景下使用,客户费用到期后对租户进行锁定,客户续费后再进行解锁。
COMMENT 修改注释。
CHARACTER SET | CHARSET 修改租户的字符集。
COLLATE 指定校对规则。
REPLICA_NUM 指定副本数。
ZONE_LIST 指定要修改的Zone列表。
PRIMARY_ZONE 指定主Zone。
READ ONLY | READ WRITE 指定租户的只读或读写属性。
LOGONLY_REPLICA_NUM 指定日志副本数。
LOCALITY 描述副本在Zone间的分布情况,如:F@z1,F@z2,F@z3,R@z4 表示z1, z2, z3为全功能副本,z4为只读副本。
system_var_name 修改租户的系统变量值。

示例

  • 锁定租户TENANT1。
ALTER TENANT TENANT1 LOCK;

注意事项

ALTER TENANT语句系统租户有权限执行,同时本租户的管理员能执行。