--- title: "seekdb 命令组 - 安装部署工具 OBD V4.5.0 | OceanBase 文档中心" description: seekdb 命令组 obd 有多级命令，您可以在每个层级中使用 -h / --help 选项查看子命令的帮助信息。同样的，当各层级的子命令执行报错时，您亦可使用 -v / --verbose 查看命令的详细执行过程。 obd seekdb 命令操作的最小单位为一个部署配置。部署配置是一份 yaml 文件，里面包含整… --- 切换语言 - 中文站 - 简体中文 - International - English - 日本站 - 日本語 文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*Qq8pT6yBPTcAAAAAAAAAAAAADiGDAQ/original) 安装部署工具 OBDV 4.5.0 # seekdb 命令组 更新时间：2026-07-09 15:25:37 [编辑](https://github.com/oceanbase/obd-doc/edit/V4.5.0/zh-CN/300.obd-command/150.seekdb-commands.md) obd 有多级命令，您可以在每个层级中使用 `-h`/`--help` 选项查看子命令的帮助信息。同样的，当各层级的子命令执行报错时，您亦可使用 `-v`/`--verbose` 查看命令的详细执行过程。 obd seekdb 命令操作的最小单位为一个部署配置。部署配置是一份 `yaml` 文件，里面包含整个部署的全部配置信息，包括服务器登录信息、组件配置信息和组件服务器列表等。 在使用 obd 启动 seekdb 之前，您需要先注册 seekdb 的部署配置到 obd 中。您可以使用 `obd seekdb deploy -c ` 导入一个部署配置。 ## obd seekdb install 使用该命令可交互式部署 seekdb。 ```shell obd seekdb install [options] ``` 选项说明见下表，未配置选项的情况下，将按照单机模式进行部署。 | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | --standby | 否 | bool | false | 该选项无需传值，命令中配置即生效，配置即表示以备实例模式部署 seekdb。 | | --primary | 否 | bool | false | 该选项无需传值，命令中配置即生效，配置即表示以主实例模式部署 seekdb。以主实例模式部署时，会自动启用 RPC 功能用于同步备实例同步主实例数据。 | ## obd seekdb deploy 使用该命令可以根据 yaml 文件配置部署 seekdb，可以直接使用 obd 中已注册的 `deploy name` 部署，也可以通过传入 `yaml` 的配置信息进行部署。 ```shell obd seekdb deploy [options] # example obd seekdb deploy myseekdb -c myseekdb.yaml ``` 参数 `deploy name` 为部署名，可以理解为配置文件的别名。 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | -c/--config | 否 | string | 无 | 指定所需 yaml 文件的路径。obd 使用指定的 yaml 文件部署，并将部署配置注册到 obd 中。当 `deploy name` 存在时覆盖配置。 如果不使用该选项，则会根据 `deploy name` 查找已注册到 obd 中的配置信息。 | | -f/--force | 否 | bool | false | 该选项无需传值，命令中配置即生效。配置该选项时，obd 会强制清空工作目录。当组件要求工作目录为空且不使用该选项时，工作目录不为空会返回错误。 | | -C/--clean | 否 | bool | false | 该选项无需传值，命令中配置即生效。配置该选项时，obd 会判断工作目录（`home_path`）是否属于当前操作用户，当该目录属于当前操作用户时会清空工作目录。 | | -U/--ulp/ --unuselibrepo | 否 | bool | false | 该选项无需传值，命令中配置即生效。使用该选项将禁止 obd 自动处理依赖。不配置的情况下，obd 将在检查到缺失依赖时搜索相关的 libs 镜像并安装。 | | -A/--act/--auto-create-tenant | 否 | bool | false | 该选项目前不支持，命令中是否配置均无影响。 | ## obd seekdb list 使用该命令可显示当前 obd 内注册的全部 seekdb 实例的状态。 ```shell obd seekdb list ``` obd 中注册的 seekdb 实例状态有如下几种。 - `configured`：已配置，表示 obd 中已包含该 seekdb 实例的配置文件，但该实例还未部署，此时可执行 `obd seekdb deploy` 命令部署该实例。 - `deployed`：已部署，表示该 seekdb 实例已部署，但是还未启动，此时可执行 `obd seekdb start` 命令启动该实例。 - `running`：运行中，表示 seekdb 实例正在运行中。 - `stopped`：已停止，表示 seekdb 实例中有组件已被停止，此时可执行 `obd seekdb start` 命令启动该实例。 - `destroyed`：已销毁，表示该 seekdb 实例已被销毁。 ## obd seekdb display 使用该命令可展示指定 seekdb 实例的状态。 ```shell obd seekdb display [options] # example obd seekdb display myseekdb ``` 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | --epk/--encryption-passkey | 否 | string | 空 | 若 obd 设置了加密密钥，执行 display 命令输出的 seekdb 信息中，密码相关内容为加密状态。若需输出明文密码，可在命令中配置该选项，指定密钥用于验证。 | | -g/--graph | 否 | bool | false | 该选项无需传值，命令中配置即生效。配置后将展示主备实例拓扑图。 | ## obd seekdb destroy 使用该命令可销毁已部署的 seekdb 实例。如果 seekdb 处于运行中的状态，该命令会先尝试执行 `stop`，成功后再执行 `destroy`。 ```shell obd seekdb destroy [-f] [--confirm] # example obd seekdb destroy myseekdb -f ``` 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | -f/--force-kill | 否 | bool | false | 该选项无需传值，命令中配置即生效。obd 执行销毁命令前会检查是否还有进程在运行中，无论是哪个原因导致工作目录下有进程未退出，obd 都会直接停止执行 `obd seekdb destroy` 命令。命令中配置该选项后，检查到工作目录下有运行中的进程时，会强制停止进程，强制执行 `obd seekdb destroy`。 | | --confirm | 否 | bool | false | 该选项无需传值，命令中配置即生效。未配置该选项时，执行销毁命令会二次确认是否销毁 seekdb。 | | --igs/--ignore-standby | 否 | bool | false | 检查到 seekdb 实例中存在备实例时，强制执行 `obd seekdb destroy`，主实例销毁后备实例将无法使用。 | ## obd seekdb restart 使用该命令可重启一个运行中 seekdb 实例，重启默认是无参重启。 ```shell obd seekdb restart # example obd seekdb restart myseekdb --wp ``` 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | -s/--servers | 否 | string | 空 | 用于指定需要重启的机器列表，需配置为 `yaml` 文件中 `servers` 对应的 `name` 值，若 `servers` 后未配置 `name` 值，则可使用 `ip` 值，多个值之间使用 `,` 间隔。 | | --wp/--with-parameter | 否 | bool | false | 该选项无需传值，命令中配置即生效。配置后可使需重启生效的配置项生效。 | ## obd seekdb start 使用该命令可启动已部署的 seekdb 实例，成功时打印 seekdb 实例状态。 ```shell obd seekdb start [flags] # example obd seekdb start myseekdb -S ``` 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | -s/--servers | 否 | string | 空 | 用于指定需要启动的机器列表，需配置为 `yaml` 文件中 `servers` 对应的 `name` 值，若 `servers` 后未配置 `name` 值，则可使用 `ip` 值，多个值之间使用 `,` 间隔。如果组件下的机器没有全部启动，则 start 不会执行 bootstrap。 | | --wop/--without-parameter | 否 | bool | false | 该选项无需传值，配置即表示将不带参数启动已部署的 seekdb。节点第一次的启动时，不响应此选项。 | | -S/--strict-check | 否 | bool | false | 部分组件在启动前会做相关的检查。检查不通过时，obd 将发出告警，不会强制停止流程。 命令中配置该选项可开启检查失败报错直接退出功能。建议开启，可以避免一些资源不足导致的启动失败。 | ## obd seekdb stop 使用该命令可停止一个运行中的 seekdb 实例。 ```shell obd seekdb stop # example obd seekdb stop myseekdb -s server1 ``` 参数 `deploy name` 为部署名，可以理解为配置文件的别名。若只需要停止 seekdb 中的单个节点，可使用 `-s`/`--servers` 指定需要停止的机器列表，需配置为 `yaml` 文件中 `servers` 对应的 `name` 值，若 `servers` 后未配置 `name` 值，则可使用 `ip` 值，多个值之间使用 `,` 间隔。 ## obd seekdb takeover 使用该命令可以接管非 obd 部署的 seekdb 实例。具体操作方法可参见 [使用 obd 执行接管](https://www.oceanbase.com/docs/common-obd-cn-1000000006430662) 中 **接管 seekdb 实例** 部分。 ```shell obd seekdb takeover [options] # example obd seekdb takeover myseekdb -h 10.10.10.1 -P 2881 -p ****** --ssh-user=admin --ssh-password=******* ``` 参数 `deploy name` 为接管后的实例部署名，接管成功后 obd 通过该部署名管理接管过来的 seekdb 实例。 选项说明见下表： | 选项名 | 是否必选 | 数据类型 | 默认值 | 说明 | | --- | --- | --- | --- | --- | | -h/--host | 是 | string | 127.0.0.1 | 待接管的 seekdb 实例的连接 IP。 | | -P/--mysql-port | 是 | int | 2881 | 待接管的 seekdb 实例的连接端口。 | | -p/--root-password | 否 | string | 默认为空 | seekdb 实例中 root 用户的登录密码。 #### 注意 配置密码时请勿使用引号包围密码，否则 obd 会把引号识别为密码的一部分。 | | --ssh-user | 否 | string | 默认为当前用户 | 启动 seekdb 实例中节点所用的用户。 | | --ssh-password | 否 | string | 默认为空 | `--ssh-user` 对应的密码，用于远程连接 seekdb 节点。 | | --ssh-port | 否 | int | 22 | SSH 远程端口。 | | -t/--ssh-timeout | 否 | int | 30 | 设置 SSH 连接的超时时间，单位为秒。 | | --ssh-key-file | 否 | string | 默认为空 | 指定私钥文件的路径，需配置为绝对路径，用于基于私钥的 SSH 无密码身份验证。 | ## obd seekdb switchover 使用该命令可在主实例可用的情况下，将主实例与其中一个备实例交换角色。命令的详细使用可参见 [角色切换与解耦](https://www.oceanbase.com/docs/common-obd-cn-1000000006430676)。 ```shell obd seekdb switchover # example obd seekdb switchover seekdb-standby ``` 参数 `standby deploy name` 为备实例的部署名。 ## obd seekdb failover 使用该命令可在主实例不可用的情况下，将一个备实例转换为主实例。命令的详细使用可参见 [角色切换与解耦](https://www.oceanbase.com/docs/common-obd-cn-1000000006430676)。 ```shell obd seekdb failover # example obd seekdb failover seekdb-standby ``` 参数 `standby deploy name` 为部署名，此处需填写备实例的部署名。 ## obd seekdb decouple 使用该命令可解除主备关系，将一个备实例转换为独立的实例。命令的详细使用可参见 [角色切换与解耦](https://www.oceanbase.com/docs/common-obd-cn-1000000006430676)。 ```shell obd seekdb decouple # example obd seekdb decouple seekdb-standby ``` 上一篇 下一篇 ![有帮助](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) 咨询热线