OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Command-Line Client

V2.2.13
  • Introduction
    • Overview of OBClient
  • Quick start
    • Quick start with OBClient
  • Command-line options
    • Common OBClient command-line options
    • Reference for OBClient command-line options
    • SQL context when a script fails
  • Configuration and environment
    • Configure OBClient and set environment variables
  • User guide
    • Reference for OBClient internal commands
  • Advanced features
    • Support for Oracle-compatible mode in OBClient
    • Log in to OBClient through a socket5 proxy
    • Multi-IP connection support for OBClient
    • Client IP passthrough and tenant allowlist (F5 scenario)
    • Log in as a proxy user of OBClient
    • LOAD DATA LOCAL INFILE
    • SET variables
    • Supported login_path options for OBClient
  • Tips and troubleshooting
    • OBClient Usage Tips and Troubleshooting

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Command-Line Client
  3. V2.2.13

Supported login_path options for OBClient

Last Updated:2026-09-02 09:17:42

obclient_config_editor tool
Basic usage
Set login_path
View login_path
Delete login_path
Log in using login_path
References

OBClient supports using the login_path option to store and manage login credentials, eliminating the need to directly enter a password on the command line.

obclient_config_editor tool

When you install obclient, the obclient_config_editor tool is also installed. This tool is used to manage login_path configurations.

Basic usage

obclient_config_editor --help

Set login_path

Create a login_path named test:

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

The following parameters are supported:

  • -h, --host=name: adds a host to the login file.
  • -G, --login-path=name: adds a name to the login path in the login file (default is client).
  • -p, --password: adds a password to the login file. The password is automatically encrypted by obclient_config_editor.
  • -u, --user: adds a username to the login file.
  • -S, --socket=name: adds the path of the socket file to the login file.
  • -P, --port=name: adds the login port to the login file.

Note

If the password contains special characters (such as #), you must enter it in the interactive interface.

View login_path

View a specified login_path:

obclient_config_editor print --login-path=test

View all login_paths:

obclient_config_editor print --all

Delete login_path

obclient_config_editor remove --login-path=test

Log in using login_path

Log in using the configured login_path:

obclient --login-path=test

To log in to a different host or port, or to add additional parameters, simply append them to the command:

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

References

  • Command-line options
  • Configuration and environment variables

Previous topic

SET variables
Last

Next topic

OBClient Usage Tips and Troubleshooting
Next
on this page
obclient_config_editor tool
Basic usage
Set login_path
View login_path
Delete login_path
Log in using login_path
References