---
title: "ALTER TENANT | OceanBase 文档中心"
description: "ALTER TENANT 描述 该语句用来修改租户信息。 该语句仅支持在 sys 租户中执行，同时仅 sys 租户的管理员可以执行。 语法 ALTER TENANT {tenant_name | ALL} [SET] [tenant_option_list] [opt_global_sys_vars_set]; te…"
image: https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*OSPzQ6GUQF4AAAAAQHAAAAgAeiGDAQ/original
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*P8CuR4UJ_FkAAAAAAAAAAAAADiGDAQ/original) OceanBase 数据库分布式版 - V 3.1.4 社区版

# ALTER TENANT

更新时间：2023-08-03 17:20:32

[编辑](https://github.com/oceanbase/oceanbase-doc/edit/V3.1.4/zh-CN/1400.developer-guide/700.sql-reference/500.sql-statements/900.alter-tenant.md)  

## 描述

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

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

## 语法

```sql
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
          | REPLICA_NUM [=] num
          | ZONE_LIST [=] (zone [, zone...])
          | PRIMARY_ZONE [=] zone
          | RESOURCE_POOL_LIST [=](pool_name [, pool_name...])
          | DEFAULT TABLEGROUP [=] {NULL | tablegroup_name}
          | {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 | 指定要修改的租户名。 `ALL` 表示修改所有租户。 |
| RESOURCE_POOL_LIST | 资源池列表。 |
| DEFAULT TABLEGROUP | 设置租户默认表组信息，`NULL` 表示取消数据库默认表组。 |
| LOCK \| UNLOCK | 租户锁定和解锁。对租户进行锁定后，不能在该租户上创建新的连接，已有连接保持不变。通常在客户费用到期未续费的场景下使用，客户费用到期后对租户进行锁定，客户续费后再进行解锁。 |
| COMMENT | 修改注释。 |
| CHARACTER SET \| CHARSET | 修改租户的字符集。   > **说明**   >  当前版本暂不支持此参数。 |
| COLLATE | 修改租户的字符序。   > **说明**   >  当前版本暂不支持此参数。 |
| REPLICA_NUM | 指定副本数。 |
| ZONE_LIST | 指定要修改的 Zone 列表。   > **说明**   >  当前版本暂不支持此参数。 |
| PRIMARY_ZONE | 指定租户的 Primary 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`。

  ```sql
  obclient> ALTER TENANT tenant1 LOCK;

  ```
 - 修改租户 `tenant1` 的 Primary Zone 为 `zone2`。

  ```sql
  obclient> ALTER TENANT tenant1 primary_zone='zone2';

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

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

  ```

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

  ```sql
  obclient> ALTER RESOURCE UNIT unit1 max_cpu 15, max_memory '20G', max_iops 128,max_disk_size '100G', max_session_num 64, MIN_CPU=10, MIN_MEMORY='10G', MIN_IOPS=128

  ```
 - 修改租户 `tenant1` 的 Locality，增加副本数。

  其中 `F` 表示副本类型为全功能型副本，`B_4` 为新增的 Zone 名称。

  ```sql
  obclient> CREATE RESOURCE UNIT unit1,max_cpu=5,min_cpu=2.5,max_memory= 34359738368, min_memory=30064771072, max_iops=10000,min_iops=5000,max_session_num=9223372036854775807,max_disk_size=5301023539200;
  obclient> CREATE RESOURCE POOL pool1 unit='unit1',unit_num=1,zone_list=('B_4');
  obclient> ALTER TENANT tenant1 resource_pool_list=('sys_pool','sys_pool1');
  obclient> ALTER TENANT tenant1 locality="F@B_1,F@B_2,F@B_3,F@B_4";

  ```
 - 修改租户 `tenant1` 的 `replica_num`，对租户进行扩容。

  `replica_num` 表示租户在每个 Zone 中的副本数，因此需要先对集群进行扩容。

  ```sql
  obclient> ALTER SYSTEM ADD SERVER 'xxx.xxx.xxx.xx1:2882' zone 'B_1';
  obclient> ALTER SYSTEM ADD SERVER 'xxx.xxx.xxx.xx2:2882' zone 'B_2';
  obclient> ALTER SYSTEM ADD SERVER 'xxx.xxx.xxx.xx3:2882' zone 'B_3';
  obclient> ALTER RESOURCE POOL pool0 unit_num=2;
  obclient> ALTER TENANT tenant1 replica_num=2;

  ```

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线