---
title: 常用命令汇总-OceanBase数据库使用指南
description: 了解OceanBase数据库在实际应用中关于 常用命令汇总相关的常见问题和使用技巧，帮助您快速解决 常用命令汇总的难题。
---
切换语言

- 简体中文
- English

划线反馈

# 常用命令汇总

更新时间：2024-11-29 02:56

## 运维相关命令

| 命令 | 说明 | 备注 |
| --- | --- | --- |
| `SHOW CHARACTER SET;` | 获取字符集 | 相关文档：   - MySQL 租户：[字符集](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222178) - Oracle 租户：[SHOW](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222041) |
| `ALTER SYSTEM ADD server <svr_ip:svr_port> zone <zone_name>;` | 新增 OBServer | 相关文档：[SERVER](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221271) |
| `ALTER SYSTEM DELETE server <svr_ip:svr_port>;` | 删除 OBServer | 相关文档：[SERVER](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221271) |
| `ALTER SYSTEM STOP server <svr_ip:svr_port>;` | 停止 OBServer | 相关文档：[SERVER](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221271) |
| `ALTER SYSTEM START server <svr_ip:svr_port>;` | 启动 OBServer | 相关文档：[SERVER](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221271) |
| `ALTER SYSTEM ADD zone <zone_name> region <region_name>` | 新增 zone | 相关文档：[ZONE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221278) |
| `ALTER SYSTEM DELETE zone <zone_name>;` | 删除 Zone | 相关文档：[ZONE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221278) |
| `ALTER SYSTEM STOP zone <zone_name>;` | 主动下线 Zone | 相关文档：[ZONE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221278) |
| `ALTER SYSTEM START zone <zone_name>;` | 主动上线 Zone | 相关文档：[ZONE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221278) |
| `ALTER SYSTEM ALTER zone <zone_name> set region = <region_name>;`   `ALTER SYSTEM ALTER zone <zone_name> set idc = <idc_name>;` | 设置 zone 的地域和机房 | 相关文档：[ZONE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221278) |
| `ALTER SYSTEM RUN JOB 'io_calibration' SERVER = <svr_ip:svr_port>;` | 磁盘 IO 性能统计 | 相关文档：[磁盘性能校准](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220916) |
| `ALTER SYSTEM ADD ARBITRATION SERVICE <svr_ip:svr_port>;` | 为 OBServer 集群添加仲裁服务 | 相关文档：[ARBITRATION](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221272) |
| `ALTER SYSTEM REMOVE ARBITRATION SERVICE <svr_ip:svr_port>;` | 删除 OBServer 集群的仲裁服务 | 相关文档：[ARBITRATION](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221272) |
| `ALTER SYSTEM REPLACE ARBITRATION SERVICE <old_svr_ip:old_svr_port> WITH <new_svr_ip:new_svr_port>;` | OBServer 集群替换仲裁服务 | 相关文档：[ARBITRATION](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221272) |
| `ALTER TENANT <tenant_name> SET ENABLE_ARBITRATION_SERVICE = true;` | 给某个租户开启仲裁服务 | 相关文档：[ALTER TENANT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220295) |

## 合并管理

| 命令 | 说明 | 备注 |
| --- | --- | --- |
| `ALTER SYSTEM MAJOR FREEZE;` | 普通租户下执行租户合并 | 相关文档：[合并](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000218992) |
| `ALTER SYSTEM CLEAR MERGE ERROR;` | 普通租户下清理合并失败状态 | 相关文档：   - MySQL 租户：[MERGE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221396) - Oracle 租户：[ALTER SYSTEM MAJOR FREEZE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222077) |
| `ALTER SYSTEM MAJOR FREEZE TENANT = <tenant_name>;` | sys 租户下同时执行某些租户的合并 | 相关文档：[合并](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000218992) |
| `ALTER SYSTEM CLEAR MERGE ERROR TENANT = <tenant_name>;` | sys 租户下同时清理某些租户的合并失败状态 | 相关文档：[MERGE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221281) |

## 租户管理

| 命令 | 说明 | 备注 |
| --- | --- | --- |
| `CREATE TENANT <tenant_name> resource_pool_list=<poolname>;` | 创建租户 | 相关文档：[CREATE TENANT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220306) |
| `DROP TENANT IF EXISTS <tenant_name>;` | 删除租户 | 相关文档：[DROP TENANT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220302) |
| `ALTER TENANT <tenant_name> LOCK;` | 锁定租户 | 相关文档：[ALTER TENANT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220295) |
| `ALTER TENANT <tenant_name> UNLOCK;` | 解锁租户 | 相关文档：[ALTER TENANT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220295) |
| `ALTER TENANT <tenant_name> PRIMARY_ZONE = RANDOM;`   `ALTER TENANT '<tenant_name>' PRIMARY_ZONE = <primary zone>;` | 修改租户 primary zone | 相关文档：[ALTER TENANT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220295) |
| `ALTER TENANT <tenant_name> LOCALITY = <locality>;` | 修改租户 locality | 相关文档：[ALTER TENANT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220295) |
| `ALTER TENANT <tenant_name> RESOURCE_POOL_LIST=<poolname>;` | 修改租户资源池 | 相关文档：[修改资源池属性](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000218354) |
| `ALTER TENANT <tenant_name> SET VARIABLES ob_tcp_invited_nodes = <Value>;` | 修改租户白名单 | 相关文档：[查看和设置租户白名单](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000218364) |

## 资源管理

| 命令 | 说明 | 备注 |
| --- | --- | --- |
| `CREATE RESOURCE UNIT <unit_name> MAX_CPU = <cpu_num>, MIN_CPU = <cpu_num>, MEMORY_SIZE = <size_value>;` | 创建 unit 规格 | 相关文档：[CREATE RESOURCE UNIT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220297) |
| `DROP RESOURCE UNIT IF EXISTS <unit_name>;` | 删除 unit 规格 | 相关文档：[DROP RESOURCE UNIT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220305) |
| `CREATE RESOURCE POOL <poolname> UNIT = <unit_name>, UNIT_NUM = <unitnum>, ZONE_LIST=<zone>;` | 创建资源池 | 相关文档：[CREATE RESOURCE POOL](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220296) |
| `ALTER RESOURCE POOL <poolname> UNIT = <unit_name>;` | 修改资源池 unit 规格 | 相关文档：[ALTER RESOURCE POOL](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220307) |
| `ALTER RESOURCE TENANT <tenant_name> UNIT_NUM = <unitnum>;` | 修改租户 unit 数量 | 相关文档：[ALTER RESOURCE TENANT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220304) |
| `ALTER RESOURCE POOL <poolname> SPLIT INTO <new_poolname> ON <zone_name>;` | 分裂资源池 | 相关文档：[合并和分裂资源池](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000218793) |
| `DROP RESOURCE POOL IF EXISTS <poolname>;` | 删除资源池 | 相关文档：[DROP RESOURCE POOL](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220298) |

## 参数管理

| 命令 | 说明 | 备注 |
| --- | --- | --- |
| `SHOW PARAMETERS WHERE scope = 'cluster';`   `SHOW PARAMETERS WHERE scope = 'cluster' AND name LIKE <parameters_name>;` | 获取集群配置项（sys 租户） | 相关文档：[查看集群配置项](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000218342) |
| `SHOW PARAMETERS WHERE scope = 'TENANT';`   `SHOW PARAMETERS WHERE scope = 'TENANT' AND name LIKE <parameters_name>;`   `SHOW PARAMETERS WHERE scope = 'TENANT' AND name in (<parameters_name>);` | 获取租户配置项（普通租户） | 相关文档：   - MySQL 租户：[SHOW](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221381) - Oracle 租户：[SHOW](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222041) |
| `ALTER SYSTEM SET <parameters_name> = <parameters_val>;`   `ALTER SYSTEM SET <parameters_name> = <parameters_val> ZONE = <zone_name>;`   `ALTER SYSTEM SET <parameters_name> = <parameters_val> SERVER = <svr_ip:svr_port>;` | 设置集群配置项（sys 租户） | 相关文档：[PARAMETER](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221286) |
| `ALTER SYSTEM SET <parameters_name> = <parameters_val> TENANT = all;`   `ALTER SYSTEM SET <parameters_name> = <parameters_val> TENANT = <tenant_name>;` | 设置租户配置项（sys 租户） | 相关文档：[PARAMETER](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221286) |
| `ALTER SYSTEM SET <parameters_name> = <parameters_val>;`   `ALTER SYSTEM SET <parameters_name> = <parameters_val> ZONE = <zone_name>;`   `ALTER SYSTEM SET <parameters_name> = <parameters_val> SERVER = <svr_ip:svr_port>;` | 设置租户配置项（普通租户） | 相关文档：[修改集群配置项](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000218337) |

## MySQL 数据库管理

| 命令 | 说明 | 备注 |
| --- | --- | --- |
| `CREATE DATABASE IF NOT EXISTS <database_name>;` | 创建数据库 | 相关文档：[CREATE DATABASE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221424) |
| `DROP DATABASE IF EXISTS <database_name>;` | 删除数据库 | 相关文档：[DROP DATABASE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221371) |
| `SHOW DATABASES;` | 获取数据库列表 | 相关文档：[SHOW](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221381) |
| `ALTER DATABASE <database_name> SET DEFAULT COLLATE = <collation_name>;` | 修改数据库字符集 | 相关文档：[ALTER DATABASE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221393) |
| `ALTER DATABASE <database_name> SET READ ONLY;`   `ALTER DATABASE <database_name> SET READ WRITE;` | 修改数据库只读 | 相关文档：[ALTER DATABASE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221393) |

## 用户及权限管理

| 命令 | 说明 | 备注 |
| --- | --- | --- |
| `CREATE USER IF NOT EXISTS <user_name> IDENTIFIED BY <password>;` | 创建用户（MySQL 租户） | 相关文档：[CREATE USER](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221376) |
| `DROP USER <user_name>;` | 删除用户（MySQL 租户） | 相关文档：[DROP USER](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221378) |
| `ALTER USER <user_name> IDENTIFIED BY <password>;` | 修改密码（MySQL 租户） | 相关文档：[ALTER USER](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221379) |
| `CREATE USER <user_name> IDENTIFIED BY "<password>";` | 创建用户（Oracle 租户） | 相关文档：[CREATE USER](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222061) |
| `DROP USER <user_name> CASCADE;` | 删除用户（Oracle 租户） | 相关文档：[DROP USER](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222090) |
| `ALTER USER <user_name> IDENTIFIED BY "<password>";` | 修改密码（Oracle 租户） | 相关文档：[ALTER USER](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222075) |
| `ALTER USER <user_name> ACCOUNT LOCK;` | 锁定用户 | 相关文档：   - MySQL 租户：[锁定和解锁用户](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220871) - Oracle 租户：[锁定和解锁用户](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220867) |
| `ALTER USER <user_name> ACCOUNT UNLOCK;` | 解锁用户 | 相关文档：   - MySQL 租户：[锁定和解锁用户](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220871) - Oracle 租户：[锁定和解锁用户](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220867) |
| `GRANT <priv_type> ON *.* TO <user_name>;` | 授予全局权限（MySQL 租户） | 相关文档：[GRANT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221383) |
| `REVOKE <priv_type> ON *.* FROM <user_name>;` | 撤销全局权限（MySQL 租户） | 相关文档：[REVOKE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221382) |
| `GRANT <priv_type> ON '%s'.* TO <user_name>;` | 授予数据库权限（MySQL 租户） | 相关文档：[GRANT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221383) |
| `REVOKE <priv_type> ON '%s'.* FROM <user_name>;` | 撤销数据库权限（MySQL 租户） | 相关文档：[REVOKE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221382) |
| `CREATE ROLE <role_name>;` | 创建角色（Oracle 租户） | 相关文档：[CREATE ROLE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222099) |
| `DROP ROLE <role_name>;` | 删除角色（Oracle 租户） | 相关文档：[DROP ROLE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222088) |
| `GRANT <obj_with_col_priv_list> TO <grant_list>;` | 授予系统权限、授予角色（Oracle 租户） | 相关文档：[GRANT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222051) |
| `REVOKE <obj_privileges> FROM <user_list>;` | 撤销系统权限、撤销角色（Oracle 租户） | 相关文档：[REVOKE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222036) |
| `GRANT <obj_with_col_priv_list> ON <obj_clause > TO <grant_list>;` | 授予对象权限（Oracle 租户） | 相关文档：[GRANT](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222051) |
| `REVOKE <obj_privileges> ON <obj_clause > FROM <user_list>;` | 撤销对象权限（Oracle 租户） | 相关文档：[REVOKE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222036) |

## 诊断

### 会话管理

| 命令 | 说明 | 备注 |
| --- | --- | --- |
| `KILL $sessionId;` | Kill session | 相关文档：   - MySQL 租户：[KILL](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221369) - Oracle 租户：[KILL](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222048) |
| `KILL QUERY $sessionId;` | Kill Query | 相关文档：   - MySQL 租户：[KILL](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221369) - Oracle 租户：[KILL](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000222048) |

## 备份恢复

### 物理备份

| 命令 | 说明 | 备注 |
| --- | --- | --- |
| `ALTER SYSTEM set data_backup_dest = 'data_backup_path' tenant = <tenant_name>;` | 设置普通租户的数据备份路径 | 相关文档：[SET DATA_BACKUP_DEST](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000380648) |
| `ALTER SYSTEM set log_archive_dest = <log_archive_dest> tenant = <tenant_name>;` | 设置普通租户的日志备份路径 | 相关文档：[SET LOG_ARCHIVE_DEST](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000379141) |
| `ALTER SYSTEM add delete backup policy = <policy_name> recovery_window = <recovery_window> tenant = <tenant_name>;` | 设置普通租户的备份清理策略 | 相关文档：[DELETE BACKUP POLICY](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221277) |
| `ALTER SYSTEM noarchivelog;` | 停止所有租户的日志备份 | 相关文档：[NOARCHIVELOG](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000379143) |
| `ALTER SYSTEM backup database;` | 启动所有租户的全量数据备份 | 相关文档：[BACKUP](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221280) |
| `ALTER SYSTEM backup incremental database;` | 启动所有租户的增量数据备份 | 相关文档：[BACKUP](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221280) |
| `ALTER SYSTEM cancel backup;` | 停止所有租户的数据备份 | 相关文档：[CANCEL BACKUP](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000380650) |
| `ALTER SYSTEM set log_restore_concurrency = <val>;` | 设置恢复线程数 | 相关文档：[log_restore_concurrency](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000220351) |
| `ALTER SYSTEM restore <dest_tenant_name > from <uri> until %s with 'restore_option' description = 'desprition';` | 发起恢复 | 相关文档： [RESTORE](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221289) |
| `ALTER SYSTEM activate standby tenant <tenant_name>;` | 激活备租户 | 相关文档：[ACTIVATE STANDBY](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221287) |
| `ALTER SYSTEM SET data_backup_dest = 'data_backup_path';` | 设置数据备份路径 | 相关文档：[SET DATA_BACKUP_DEST](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000380648) |
| `ALTER SYSTEM SET log_archive_dest = <log_archive_dest>;` | 设置租户备份路径 | 相关文档：[SET LOG_ARCHIVE_DEST](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000379141) |
| `ALTER SYSTEM ADD delete backup policy = <policy_name> recovery_window = <recovery_window>;` | 设置清理策略 | 相关文档：[DELETE BACKUP POLICY](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221277) |
| `ALTER SYSTEM DROP delete backup policy = <policy_name>;` | 删除清理策略 | 相关文档：[DELETE BACKUP POLICY](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221277) |
| `ALTER SYSTEM BACKUP DATABASE description = 'desprition';` | 启动租户全量备份 | 相关文档：[BACKUP](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221280) |
| `ALTER SYSTEM BACKUP INCREMENTAL DATABASE description = 'desprition';` | 启动租户增量备份 | 相关文档：[BACKUP](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221280) |
| `ALTER SYSTEM ARCHIVELOG;` | 启动租户日志备份 | 相关文档：[ARCHIVELOG](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000221290) |
| `ALTER SYSTEM NOARCHIVELOG;` | 停止租户日志备份 | 相关文档：[NOARCHIVELOG](https://www.oceanbase.com/docs/common-oceanbase-database-cn-1000000000379143) |

Previous

[常用视图汇总](https://www.oceanbase.com/knowledge-base/oceanbase-database-1000000001685024)

Next

[部署 OceanBase 数据库和 OCP 推荐的网卡 Network 配置](https://www.oceanbase.com/knowledge-base/oceanbase-database-1000000000278319) ![有帮助](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) 咨询热线