OceanBase Database Proxy (ODP) 镜像文档

镜像概述和主要用途

OceanBase Database Proxy (ODP，简称obproxy)是OceanBase数据库的专用代理服务器。OceanBase数据库将用户数据以多副本形式存储在不同的OBServer上，ODP的主要作用是接收用户的SQL请求，将请求转发至目标OBServer，并将执行结果返回给用户，实现请求路由与结果回传的代理功能。

核心功能和特性

• SQL请求代理：接收用户发起的SQL请求，负责请求的转发与结果返回
• 多模式配置：支持两种配置模式（configurl模式和rs_list模式），可根据部署需求选择
• 环境变量驱动：通过环境变量灵活配置连接参数，适配不同OceanBase集群环境

使用场景和适用范围

适用于OceanBase数据库集群环境，作为用户与OBServer之间的中间代理层，用于管理SQL请求的路由、分发与结果汇总，适用于需要统一处理数据库请求转发的场景。

使用方法和配置说明

环境变量说明

ODP依赖以下环境变量进行配置，具体说明如下：

部署模式说明

• configurl模式：需指定CONFIG_URL，通过配置URL获取obproxy配置
• rs_list模式：需同时指定RS_LIST（rootservice列表）和OB_CLUSTER（集群名称）

部署示例（rs_list模式）

以下为使用rs_list模式部署obproxy的示例命令：

bash
docker run -d \
  -e APP_NAME="obproxy-instance" \
  -e PROXYRO_PASSWORD="your_proxyro_password" \
  -e RS_LIST="192.168.1.10:2882;192.168.1.11:2882" \
  -e OB_CLUSTER="obcluster_prod" \
  --name obproxy \
  oceanbase/obproxy

说明：

• 替换your_proxyro_password为实际的proxyro@sys用户密码
• RS_LIST需填写OceanBase集群的rootservice地址列表（多个地址用分号分隔）
• OB_CLUSTER填写目标OceanBase集群的名称