启动 OBProxy | OceanBase 文档中心

启动 OBProxy

更新时间：2023-07-19 13:03:07

OBProxy 部署成功后，您可以通过命令启动单个 obproxy 进程。

前提条件

请确认已部署 OBProxy，部署 OBProxy 的具体操作请参见部署 OBProxy。

背景信息

支持通过以下两种方式来启动 obproxy 进程：

在启动命令中指定 -r 参数来指定 OceanBase 集群的 RootServer 信息

该启动方式不需要额外配置，一般用于开发调试阶段。
在启动命令中指定 obproxy_config_server_url 参数项来查询获取 OceanBase 集群的 RootServer 信息

该方式需要配置 obproxy_config_server_url，故会依赖 Config Server 的启动。推荐使用该方式启动 OBProxy。

操作步骤

使用 admin 用户登录到待启动的 OBProxy 所在的机器。
```
[xxx@xxx /]# ssh admin@10.10.10.1
admin@10.10.10.1's password:
```
注意

启动 OBProxy 时，请使用 admin 用户登录并在 OBProxy 软件的 home 目录下执行启动命令。使用其他用户或者在其他目录下启动 OBProxy 都可能带来问题。
进入 OBProxy 的安装目录。
执行以下命令，启动 OBProxy。

说明

在启动 OBProxy 前，如果需要了解 OBProxy 的启动参数有哪些，您可以通过 ./bin/obproxy -h 命令来查看。
- 在启动命令中指定 -r 参数
  
  命令如下：
```
$./bin/obproxy -p6789 -r'ip:port' -e -n appname -o obproxy_config_server_url='' -c cluster_name
```
  其中：
  - -p 用于指定 OBProxy 监听的端口号，客户端通过 MySQL 连接该端口访问 OceanBase 数据库。仅在第一次启动时需要指定该参数，后续续日常启动或升级等均不需要添加此参数。
  - -r'ip:port'：指定的 OceanBase 集群的 RootServer 信息，包括 IP 地址和端口号信息。该 Port 指的是 OBServer 的 SQL Port，不是 RPC Port。
  - -e 用于指定的建表操作，建议仅在 OBProxy 第一次启动时进行，后续日常启动或升级等均不需要添加此参数。
  - -n（可选）：用于指定待启动的 OBProxy 的应用名。
    
    OBProxy 的应用名可以通过 app_name 配置项来修改，默认为 undefined。
  - -o 用于指定硬件或者内核参数配置。如果不指定，则使用系统默认配置。
    
    obproxy_config_server_url='' 表示无需 Config Server 启动。
  - -c cluster_name 用于指定 OceanBase 集群。
  示例：
```
$./bin/obproxy -r'10.10.10.1:26506;10.10.10.2:26506' -n test -c mycluster
```
- 在启动命令中指定 obproxy_config_server_url 参数
  
  命令如下：
```
$./bin/obproxy -p6789 -e -n appname -o obproxy_config_server_url='your_config_url'
```
  其中：
  - -p 用于指定 OBProxy 监听的端口号，客户端通过 MySQL 连接该端口访问 OceanBase 数据库。仅在第一次启动时需要指定该参数，后续续日常启动或升级等均不需要添加此参数。
  - -e 用于指定的建表操作，建议仅在 OBProxy 第一次启动时进行，后续日常启动或升级等均不需要添加此参数。
  - -n：用于指定应用名。
    
    OBProxy 的应用名可以通过 app_name 配置项来修改，默认为 undefined。
  - -o 用于指定硬件或者内核参数配置。如果不指定，则使用系统默认配置。
  - obproxy_config_server_url 用于指定 Config Server 的访问地址。
  示例：
```
$./bin/obproxy -n test -o obproxy_config_server_url='http://xx.xx.xx.xx:8877/obproxy_config'
```
启动后，执行以下命令，查看 obproxy 进程是否存在。
```
$ps -ef|grep obproxy
```