---
title: "设置参数 | OceanBase 文档中心"
description: 设置参数 OceanBase 数据库的配置项分为集群级配置项和租户级配置项。您可以通过配置项的设置使 OceanBase 数据库的行为符合您业务的要求。 参数分类 OceanBase 数据库的配置项分为集群级配置项和租户级配置项。通过配置项的设置可以控制整个集群的负载均衡、合并时间、合并方式、资源分配和模块开关等功能…
---
切换语言

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

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

# 设置参数

更新时间：2026-06-12 20:03:12

[编辑](https://github.com/oceanbase/oceanbase-doc/edit/V3.1.5/zh-CN/100.users-guide/600.basic-database-management/200.configuration-management/200.set-parameters.md)  

OceanBase 数据库的配置项分为集群级配置项和租户级配置项。您可以通过配置项的设置使 OceanBase 数据库的行为符合您业务的要求。

## 参数分类

OceanBase 数据库的配置项分为集群级配置项和租户级配置项。通过配置项的设置可以控制整个集群的负载均衡、合并时间、合并方式、资源分配和模块开关等功能。

集群级配置项中，名称以 "_" 开头的配置项称为隐藏配置项，如：`_dup_table_lease_interval` 。仅供开发人员在故障排查或紧急运维时使用。

- 集群级配置项：作用范围为整个集群所有 OBServer。
 - 租户级配置项：作用范围为当前租户在集群内所在的 OBServer。

不同租户对配置项的查看和修改级别如下表所示：

| 租户类型 | 参数查看 | 参数设置 |
| --- | --- | --- |
| 系统租户 | 集群级配置项（不含隐藏配置项）、租户级配置项   > **说明**   > `SHOW PARAMETERS` 语句通过指定 `TENANT` 关键字来查看指定租户的配置项信息。 | 集群级配置项、租户级配置项   > **说明**   >  系统租户下，可以通过指定 `TENANT` 关键字来修改全部或指定租户的租户级配置项 |
| 普通租户 | 集群级配置项（不含隐藏配置项）和本租户的配置项 | 本租户的配置项 |

当前 OceanBase 数据库中配置项的主要数据类型及其相关说明如下表所示：

| 数据类型 | 说明 |
| --- | --- |
| BOOL | boolean 类型（布尔），支持 true/false。 |
| CAPACITY | 容量单位，支持 b （字节）、k （KB，千字节）、m （MB，百万字节）、 g （GB，10亿字节）、t （TB，万亿字节）、p（PB，千万亿字节）。单位不区分大小写字母，默认为 m。 |
| DOUBLE | 双精度浮点数，占用 64 bit 存储空间，精确到小数点后 15 位，有效位数为 16位 。 |
| INT | int64 整型，支持正负整数和 0。 |
| MOMENT | 时刻。格式为 `hh:mm`（例如 `02:00`）；或者特殊值 `disable`，表示不指定时间。目前仅用于 `major_freeze_duty_time` 参数。 |
| STRING | 字符串。用户输入的字符串的值。 |
| STRING_LIST | 字符串列表，即以分号 （;）分隔的多个字符串。 |
| TIME | 时间类型。支持 us （微秒）、ms （毫秒）、s （秒）, m （分钟）、h （小时）、d （天）等单位。如果不加后缀，默认为秒（s）。单位不区分大小写字母。 |

## 通过 SQL 语句修改配置项

修改配置项的 SQL 语法如下：

```sql
ALTER SYSTEM [SET]
parameter_name = expression [SCOPE = {SPFILE | BOTH}] [COMMENT [=] 'text']
[ TENANT [=] ALL|tenant_name ] {SERVER [=] 'ip:port' | ZONE [=] 'zone'};

```

参数说明：

- `parameter_name`：指定要修改的配置项名称。
 - `expression`：指定修改后的配置项的值。
 - `COMMENT 'text'`：用于添加关于本次修改的注释。该参数为可选，建议不要省略。
 - `SCOPE`：指定本次配置项修改的生效范围，默认为 `BOTH`。

     - `SPFILE`：表示只修改内部表中的配置项值，当 OBServer 重启以后才生效。仅重启生效的配置项支持。
     - `BOTH`：表示既修改内部表中的配置项值，又修改内存中的配置项值，修改立即生效，且 OBServer 重启以后配置值仍然生效。
 - `TENANT`：用于在系统租户下，修改所有或指定租户的租户级配置项。

     - `ALL`：所有租户。
     - `tenant_name`：指定租户。
 - `SERVER`：只修改指定 Server 实例的某个配置项。
 - `ZONE`：表明本配置项的修改针对指定集群的特定 Server 类型，否则，针对所有集群的特定 Server 类型。

> **说明**
>
>  
>
> - 同时修改多个配置项时，以逗号（,）分隔。
>  - 集群级配置项不能通过普通租户设置，也不可以通过系统租户（即 `sys` 租户） 指定为普通租户设置，仅支持在系统租户下配置。例如，执行 `ALTER SYSTEM SET memory_limit='100G' TENANT='test_tenant'` 语句将导致报错，因为 `memory_limit` 是集群级配置项。
>  - 租户级配置项可以直接在本租户下修改，也可以在系统租户下通过指定 `TENANT` 关键字来修改。
>  - `ALTER SYSTEM` 语句不能同时指定 Zone 和 OBServer。并且在指定 Zone 时，仅支持指定一个 Zone；指定 OBServer 时，仅支持指定一个 OBServer。如果修改时，不指定 Zone 也不指定 OBServer，则集群级配置项会在整个集群所有 OBServer 上生效；租户级配置项会在当前租户在集群内所在的 OBServer 上生效。
>  - 确认一个配置项为集群级别还是租户级别，可根据 `SHOW PARAMETERS` 语句执行结果中的 `scope` 列对应的值来判断：
>
>
>      - `scope` 值为 `CLUSTER` 则表示为集群级配置项。
>      - `scope` 值为 `TENANT` 则表示为租户级配置项。

### 示例

修改 `clog_max_unconfirmed_log_count` 配置项的示例如下：

```sql
obclient> ALTER SYSTEM SET clog_max_unconfirmed_log_count = 400;

```

修改指定 Zone 的 `clog_max_unconfirmed_log_count` 配置项的示例如下：

```sql
obclient> ALTER SYSTEM SET clog_max_unconfirmed_log_count = 400 ZONE='z1';

```

修改指定 OBServer 的 `clog_max_unconfirmed_log_count` 配置项的示例如下：

```sql
obclient> ALTER SYSTEM SET clog_max_unconfirmed_log_count = 400 SERVER='XXX.XXX.XXX.XXX:XXXXX';

```

在系统租户下，修改所有或指定租户的租户级配置项。示例如下：

```sql
obclient> ALTER SYSTEM SET clog_max_unconfirmed_log_count = 400 TENANT='ALL';
obclient> ALTER SYSTEM SET clog_max_unconfirmed_log_count = 400 TENANT='Oracle';

```

> **说明**
>
>  
>
> 执行成功以后，所有被指定租户的配置项均会被修改。

## 通过 OCP 修改集群级配置项

1. 登录 OCP 。

   默认进入 **集群概览** 页面。
 2. 在 **集群列表** 区域，选择待操作的集群并单击其集群名。
 3. 在显示的页面的左侧导航栏上，单击 **参数管理** 。
 4. （可选）在 **参数列表** 页面上方的搜索框中，输入参数名相关信息进行模糊搜索。

   ![修改参数](https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN/4716860061/p168819.png)
 5. 找到待修改的参数，在对应的 **操作** 列中，单击 **修改值** 。
 6. 在弹出的对话框中，修改参数的值及生效范围，单击 **确定** 。

   ![09071352](https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN/0260562361/p324226.png)

   由于 OceanBase 集群参数可以有全局（即 **集群** ）、Zone 和 Server 三种生效范围，故在修改值时请根据业务需要选择生效范围。

   默认生效范围是 **集群** 。如果需要调整到 Zone 或 Server 的生效范围，则可以在 **生效范围** 列取消选中 **集群** ，此时系统会显示集群下的 Zone 列表。根据提示选择 Zone 并选中，则选中了 Zone 的生效范围；如果选择 Zone 后，继续选择该 Zone 下的 Server 列表，则在 Server 范围生效。

   如果需要修改参数的值同时在不同的范围生效，例如，修改 **backup_concurrency** 在 **Zone 1** 为 **10** ；在 **Zone 2** 为 **12** ；在 **Server 1** 上为 20，则可以在 **值** 列点单击 **添加值** 后出现 3 行记录。每行记录可以选中对应的生效范围。 **说明**

   如果单击 **添加值** 后出现多行修改值时，对集群的参数修改顺序是从第一行往下依次执行，并且每次执行成功后，会在 **修改历史** 页签中产生一条历史记录。

## 通过 OCP 修改租户级配置项

1. 登录 OCP 。
 2. 在左侧导航栏上，单击 **租户** 。
 3. 在 **租户列表** 区域，选择待操作的租户并单击其租户名。
 4. 在显示的页面的左侧导航栏上，单击 **参数管理** 。
 5. （可选）在 **参数列表** 页面上方的搜索框中，输入参数名相关信息进行模糊搜索。
 6. 找到待修改的参数，单击 **修改值** 按钮。

   ![09071422](https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN/0660562361/p324249.png)
 7. 在弹出的对话框中，修改参数的值。

   ![09071420](https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN/0660562361/p324245.png)
 8. 单击 **提交** 。

## 通过 OBD 修改配置项

OBD 支持通过修改配置文件的方式来修改配置项。

1. 在 OBD 所在机器的操作用户下使用如下命令打开集群的配置文件：

   ```bash
   obd cluster edit-config <deploy_name>

   ```
 2. 修改/添加配置文件中的配置项

   配置文件各个模块的含义可参考 [配置文件说明](https://www.oceanbase.com/docs/community-obd-cn-1000000000050418)。

   若需要修改的参数配置文件中不存在，您可手动添加配置项，根据不同的生效范围选择添加到全局配置或节点配置。
 3. 保存配置后重启集群

   保存并退出配置文件后，OBD 会提示需要执行 `obd cluster reload <deploy_name>` 或 `obd cluster restart <deploy_name> --wp` 命令，根据提示执行对应命令即可完成集群参数的修改。

## 通过 SQL 语句查看配置项

查看配置项的 SQL 语法如下：

```sql
SHOW PARAMETERS [LIKE 'pattern' | WHERE expr] [TENANT = tenant_name]

```

语法说明：

- 系统租户下，可以查看本租户的租户级配置项和集群级配置项（不含隐藏配置项）信息。同时，可以通过指定 `TENANT` 关键字来查看指定租户的配置项信息。
 - 普通租户下，可以查看本租户的租户级配置项以及系统租户的集群级配置项（不含隐藏配置项）信息。
 - `WHERE expr` 中可以指定的列属性与 `SHOW PARAMETERS` 返回结果中的列属性一致。

通过 `SHOW PARAMETERS` 语句查看配置项的示例如下：

```sql
obclient> SHOW PARAMETERS WHERE scope = 'tenant';
obclient> SHOW PARAMETERS WHERE svr_ip != 'XXX.XXX.XXX.XXX';
obclient> SHOW PARAMETERS WHERE INFO like '%ara%';
obclient> SHOW PARAMETERS LIKE 'large_query_threshold';
+-------+----------+-----------------+----------+-----------------------+-----------+-------+------------------------------------------------------------------------------------------------------------------------------+---------+---------+---------+-------------------+
| zone  | svr_type | svr_ip          | svr_port | name                  | data_type | value | info                                   | section | scope   | source  | edit_level        |
+-------+----------+-----------------+----------+-----------------------+-----------+-------+------------------------------------------------------------------------------------------------------------------------------+---------+---------+---------+-------------------+
| zone1 | observer | XXX.XXX.XXX.XXX |     2882 | large_query_threshold | NULL      | 5s    | threshold for execution time beyond which a request may be paused and rescheduled as a \'large request\'. Range: [1ms, +∞)   | TENANT  | CLUSTER | DEFAULT | DYNAMIC_EFFECTIVE |
+-------+----------+-----------------+----------+-----------------------+-----------+-------+------------------------------------------------------------------------------------------------------------------------------+---------+---------+---------+-------------------+
1 row in set (0.01 sec)

```

返回结果中的列属性如下表所示：

| 列名 | 含义 |
| --- | --- |
| zone | 所在的 Zone |
| svr_type | 机器类型 |
| svr_ip | 机器 IP |
| svr_port | 机器端口 |
| name | 配置项名 |
| data_type | 配置项数据类型，包括 `NUMBER` 、`STRING` 、`CAPACITY` 等 |
| value | 配置项值   > **说明**   >  由于在修改配置项值时，支持修改指定 Zone 或 Server 的配置项值，故不同 Zone 或 Server 对应的配置项的值可能不同。 |
| info | 配置项的说明信息 |
| section | 配置项所属的分类：   - `SSTABLE`：表示 SSTable 相关的配置项。 - `OBSERVER`：表示 OBServer 相关的配置项。 - `ROOT_SERVICE`：表示 RootService 相关的配置项。 - `TENANT`：表示租户相关的配置项。 - `TRANS`：表示事务相关的配置项。 - `LOAD_BALANCE`：表示负载均衡相关的配置项。 - `DAILY_MERGE`：表示合并相关的配置项。 - `CLOG`：表示 Clog 相关的配置项。 - `LOCATION_CACHE`：表示 Location Cache 相关的配置项。 - `CACHE`：表示缓存相关的配置项。 - `RPC`：表示 RPC 相关的配置项。 - `OBPROXY`：表示 OBProxy 相关的配置项。 |
| scope | 配置项范围属性：   - `TENANT`：表示该配置项为租户级配置项 - `CLUSTER`：表示该配置项为集群级配置项 |
| source | 当前值来源：   - `TENANT` - `CLUSTER` - `CMDLINE` - `OBADMIN` - `FILE` - `DEFAULT` |
| edit_level | 定义该配置项的修改行为：   - `READONLY`：表示该参数不可修改。 - `STATIC_EFFECTIVE`：表示该参数可修改但需要重启 OBServer 才会生效。 - `DYNAMIC_EFFECTIVE`：表示该参数可修改且修改后动态生效。 |

## 通过 OCP 查看集群级配置项

1. 登录 OCP 。

   默认进入 **集群概览** 页面。
 2. 在 **集群列表** 区域，选择待操作的集群并单击其集群名。
 3. 在显示的页面的左侧导航栏上，单击 **参数管理** 。

   系统默认进入 **参数列表** 页面。 **参数列表** 中可以查看当前集群所有参数的信息。

   ![查看集群参数](https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN/2415019361/p360261.png)

   **说明**

      - **当前值** 列中，值后以 **（集群）** 标识的表示该值配置在集群范围内统一。如上图中 **backup_region** 的当前值列为 **0（集群）** ，表示 0 在集群范围内生效。
      - **当前值** 列中，值后以 **（自定义）** 标识的表示该值并非集群范围内统一，如 **2d;1d（自定义** ） 表示用户自定义 **2d** 为针对某 Zone 的值， **1d** 为针对某 OBServer 的值。如需了解这两个值各自针对的对象，可单击该值进行查看。
 4. 在 **参数列表** 页面上方的搜索框中，输入参数名相关信息进行模糊搜索。
 5. 在搜索结果中，找到指定的参数。

## 通过 OCP 查看租户级配置项

### 前提条件

检查密码箱中所存的该租户下 root 用户的密码是否正确，以及租户白名单设置是否正确。

### 操作步骤

1. 登录 OCP 。
 2. 在左侧导航栏中单击 **租户** ，并在 **租户列表** 中单击租户名称。
 3. 在显示的页面的左侧导航栏上，单击 **参数管理** 。
 4. 在 **参数列表** 页面，可以查看当前集群所有参数的信息。

      - 展示信息包括各参数的参数名称、取值类型、取值范围、默认值、当前值、说明和是否只读等信息。
      - **默认值** 表示新建租户的缺省值。只读表示该参数是否可修改，如果是可修改的参数，在 **操作** 列中会展示修改值按钮。

   ![1122](https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN/2295987361/p355952.png)

## 更多信息

更多配置项参考信息，请参见《参考指南》文档中的 **系统配置项** 。

 上一篇 下一篇 ![有帮助](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) 咨询热线