---
title: "OBClient 的 login_path 支持 - 命令行客户端 V2.2.13 | OceanBase 文档中心"
description: OBClient 的 login_path 支持 OBClient 支持使用 login_path 来存储和管理登录凭据，避免在命令行中直接输入密码。 obclient_config_editor 工具 安装 obclient 时， obclient_config_editor 工具也会一起安装。该工具用于管理 lo…
image: https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*OSPzQ6GUQF4AAAAAQHAAAAgAeiGDAQ/original
---
切换语言

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

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*1DGSQqsgFKcAAAAARrAAAAgAeiGDAQ/original) 命令行客户端V 2.2.13

# OBClient 的 login_path 支持

更新时间：2026-06-30 18:11:26

[编辑](https://github.com/oceanbase/obclient/edit/V2.2.13/zh-CN/600.advanced-features/270.login-path-support.md)  

OBClient 支持使用 `login_path` 来存储和管理登录凭据，避免在命令行中直接输入密码。

## obclient_config_editor 工具

安装 obclient 时，`obclient_config_editor` 工具也会一起安装。该工具用于管理 login_path 配置。

### 基本用法

```bash
obclient_config_editor --help

```

### 设置 login_path

创建一个名为 `test` 的 login_path：

```bash
obclient_config_editor set --login-path=test --user=test_user --host=127.0.0.1 --port=2881 --password

```

可配置项包括：

- `-h, --host=name`：添加 host 到登录文件中
 - `-G, --login-path=name`：在登录文件中为 login path 添加名字（默认为 client）
 - `-p, --password`：在登录文件中添加密码（该密码会被 obclient_config_editor 自动加密）
 - `-u, --user`：添加用户名到登录文件中
 - `-S, --socket=name`：添加 sock 文件路径到登录文件中
 - `-P, --port=name`：添加登录端口到登录文件中

#### 注意

如果密码含有特殊字符（如 `#` 等），需要在交互界面输入密码。

### 查看 login_path

查看指定的 login_path：

```bash
obclient_config_editor print --login-path=test

```

查看所有 login_path：

```bash
obclient_config_editor print --all

```

### 删除 login_path

```bash
obclient_config_editor remove --login-path=test

```

### 使用 login_path 登录

使用配置好的 login_path 登录：

```bash
obclient --login-path=test

```

若要登录其他主机、其他端口，或者添加其他额外参数，直接在上述命令后添加即可：

```bash
obclient --login-path=test --host=other_host --port=3307

```

## 相关文档

- [命令行选项参考](https://www.oceanbase.com/docs/common-obclient-doc-cn-1000000006361909)
 - [配置和环境变量](https://www.oceanbase.com/docs/common-obclient-doc-cn-1000000006361920)

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