--- title: "工具命令组 - 安装部署工具 OBD V4.0.0 | OceanBase 文档中心" description: 工具命令组 obd 提供了一系列工具命令，其中封装了一些常用命令，可用于提升开发者的使用体验。 您可以在每个命令中使用 -h/--help 选项查看子命令的帮助信息。同样的，当命令执行报错时，您亦可使用 -v/--verbose 查看命令的详细执行过程。 obd devmode enable 使用该命令可以开启开发者… image: https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*OSPzQ6GUQF4AAAAAQHAAAAgAeiGDAQ/original --- 切换语言 - 中文站 - 简体中文 - International - English - 日本站 - 日本語 文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*Qq8pT6yBPTcAAAAAAAAAAAAADiGDAQ/original) 安装部署工具 OBDV 4.0.0 # 工具命令组 更新时间：2026-01-22 12:14:03 [编辑](https://github.com/oceanbase/obd-doc/edit/V4.0.0/zh-CN/300.obd-command/400.tools-commands.md) obd 提供了一系列工具命令，其中封装了一些常用命令，可用于提升开发者的使用体验。 您可以在每个命令中使用 `-h/--help` 选项查看子命令的帮助信息。同样的，当命令执行报错时，您亦可使用 `-v/--verbose` 查看命令的详细执行过程。 ## obd devmode enable 使用该命令可以开启开发者模式，是使用工具命令组的前提。开启开发者模式后，会出现部分异常报错被降级，obd 忽略异常参数等情况。非内核开发人员请谨慎使用。 ```shell obd devmode enable ``` ## obd devmode disable 使用该命令可关闭开发者模式。 ```shell obd devmode disable ``` ## obd env show 使用该命令可展示 obd 的环境变量。 ```shell obd env show ``` 可配置变量名查看指定的变量信息，也可配置为 `-A`/`--all` 展示所有环境变量，包括系统变量。 ## obd env set 使用该命令可设置 obd 的环境变量，这些环境变量会一定程度的影响 obd 的表现，若没有特别需求不建议使用该命令。 ```shell obd env set [key] [value] ``` 可设置的环境变量有： | 环境变量 | 取值范围 | 说明 | | --- | --- | --- | | OBD_DISABLE_RSYNC | {0, 1} | 控制是否禁用 rsync 命令。在符合条件的情况下 obd 会使用 rsync 进行远程传输，当该环境变量为 `1` 时，禁止使用 rsync 命令。 | | OBD_DEV_MODE | {0, 1} | 控制开发者模式是否开启。 | | TELEMETRY_MODE | {0, 1} | 控制遥测功能是否开启。 | | TELEMETRY_LOG_MODE | {0, 1} | 控制遥测数据打印是否开启。 | | IO_DEFAULT_CONFIRM | {0, 1} | 控制是否自动确认。obd 部分命令执行过程中需要您二次确认，该参数设置为 `1` 后，后续所有命令将自动确认。 | | ENV_LOCK_MODE | {0, 1, 2} | 控制锁级别，obd 的锁有镜像仓库锁、部署配置锁和全局锁三种，默认情况下会获取全局共享锁、部署配置排它锁和镜像仓库共享锁。执行 `obd mirror` 命令和 `obd cluster deploy` 命令时会把镜像仓库共享锁改成镜像仓库排它锁。该变量可配置值为 `0`、`1`、`2`，默认取值为 `2`，各个取值的含义如下。 - `0`：表示无锁，obd 的所有命令都不会获取锁。 - `1`：表示将部署配置排他锁降为部署配置共享锁。 - `2`：表示获取全局共享锁、部署配置排它锁和镜像仓库共享锁。 | | OBD_DISABLE_RSA_ALGORITHMS | {0, 1} | 控制是否禁止使用 `rsa-sha2-512` 和 `rsa-sha2-256` 算法来登录机器。 | | OBD_INSTALL_PRE | 不涉及 | 设置 obd 安装的父目录，默认为 `/`（根目录）。 | | OBD_INSTALL_PATH | 不涉及 | obd 的安装目录，若该环境变量未设置，会根据 `OBD_INSTALL_PRE` 值自动拼接上 `usr/obd/`。 | ## obd env unset 使用该命令可删除指定环境变量。 ```shell obd env unset [key] [value] ``` ## obd env clear 使用该命令可清理 obd 的环境变量，请谨慎使用。 ```shell obd env clear ``` ## obd tool command 使用该命令可执行一些常用的命令。 ```shell obd tool command [options] ``` 命令包含： - pid：查看服务的 pid（非交互式命令） - ssh：登录到目标 server 并进入 log 目录（交互式命令） - less：查看目标服务的日志（交互式命令） - gdb：gdb attach 到模板服务（交互式命令） 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | -c/--components | 否 | string | 如果是交互式命令默认按照配置文件顺序选择第一个组件，如果是非交互式命令，则默认使用所有组件 | 需要执行命令的组件名。多个组件名以 `,` 相隔。 | | -s/--servers | 否 | string | 如果是交互式命令默认按照配置文件顺序选择当前组件的第一个节点名，如果是非交互式命令，则默认使用所有可用节点 | 指定的组件下的节点名。多个节点名以 `,` 相隔。 | ## obd tool db_connect 使用该命令可建立数据库连接。 ```shell obd tool db_connect [options] ``` 参数 `deploy name` 为部署名，可以理解为配置文件的别名。 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | -c/--component | 否 | string | 默认按照配置文件顺序选择第一个组件 | 待连接的组件名。候选项为 `obproxy`、`obproxy-ce`、`oceanbase` 和 `oceanbase-ce`。 | | -s/--server | 否 | string | 默认按照配置文件顺序选择当前组件的第一个节点名 | 指定的组件下的节点名。 | | -u/--user | 否 | string | root | 数据库连接使用的用户名。 | | -p/--password | 否 | string | 默认为空 | 数据库连接使用的密码。 | | -t/--tenant | 否 | string | sys | 数据库连接使用的租户。 | | -D/--database | 否 | string | 默认为空 | 数据库连接使用的数据库名称。 | | --obclient-bin | 否 | string | obclient | OBClient 二进制文件路径。 | ## obd tool list 使用该命令可展示通过 obd 安装的工具。 ```bash obd tool list ``` ## obd tool install 使用该命令可通过 obd 安装所需工具。 #### 说明 obd 自 V3.4.0 起支持将 obclient 进行全局安装，您可直接使用 obclient 命令。若您使用 V3.4.0 之前版本 obd，执行命令安装成功后需为 obclient 配置环境变量才可使用。 ```bash obd tool install [options] ``` 参数 `tool name` 表示待安装工具的工具名，可取值为 `obclient`、`obdiag`（`oceanbase-diagnostic-tool`）、`obtpch`、`obtpcc`、`ob-sysbench` 和 `openjdk-jre`。 #### 说明 obd 自 V2.10.0 起支持使用该命令安装 `obtpch`、`obtpcc`、`ob-sysbench` 和 `openjdk-jre`。 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | -V/--version | 否 | string | 默认为最新版本 | 待安装的工具版本。 | | -p/--prefix | 否 | string | 默认为当前用户家目录 | 待安装工具的安装路径。 | | -y/--assumeyes | 否 | bool | false | 控制是否自动确认安装过程中出现的问题。 | | -f/--force | 否 | bool | false | 控制是否在遇到冲突时强制安装。 | ## obd tool uninstall 使用该命令可以卸载通过 obd 安装的工具。 ```bash obd tool uninstall [options] ``` 参数 `tool name` 表示待卸载工具的工具名，可取值为 `obclient`、`obdiag`（`oceanbase-diagnostic-tool`）、`obtpch`、`obtpcc`、`ob-sysbench` 和 `openjdk-jre`。 #### 说明 obd 自 V2.10.0 起支持使用该命令卸载通过 obd 安装的 `obtpch`、`obtpcc`、`ob-sysbench` 和 `openjdk-jre`。 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | -y/--assumeyes | 否 | bool | false | 控制是否自动确认卸载过程中出现的问题。 | | -f/--force | 否 | bool | false | 控制是否在遇到冲突时强制卸载。 | ## obd tool update 使用该命令可以升级通过 obd 安装的工具。 ```bash obd tool update [options] ``` 参数 `tool name` 表示待升级工具的工具名，可取值为 `obclient`、`obdiag`（`oceanbase-diagnostic-tool`）、`obtpch`、`obtpcc`、`ob-sysbench` 和 `openjdk-jre`。 #### 说明 obd 自 V2.10.0 起支持使用该命令升级通过 obd 安装的 `obtpch`、`obtpcc`、`ob-sysbench` 和 `openjdk-jre`。 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | -V/--version | 否 | string | 默认为最新版本 | 工具升级的目标版本。 | | -p/--prefix | 否 | string | 默认值为工具当前的安装地址 | 工具升级后的安装路径。 | | -y/--assumeyes | 否 | bool | false | 控制是否自动确认升级过程中出现的问题。 | | -f/--force | 否 | bool | false | 控制是否在遇到冲突时强制升级。 | ## obd display-trace 使用该命令可展示任务 ID 对应日志详情，帮助用户快速查找日志。 ```bash obd display-trace # example obd display-trace 080b8ffc-9f7c-11ed-bec1-00163e030e58 ``` 参数 `trace_id` 为任务 ID，您执行其他 obd 命令后会输出对应任务 ID，并输出命令提示如何查看。例如： ```bash [admin@centos7 ~]$ obd cluster list Local deploy is empty Trace ID: a3cf9020-be42-11ed-b5b0-00163e030e58 If you want to view detailed obd logs, please run: obd display-trace a3cf9020-be42-11ed-b5b0-00163e030e58 ``` 上一篇 下一篇 ![有帮助](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) 咨询热线