OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

Product Overview
DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

Product Overview
DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Database Proxy

V3.1.0Enterprise Edition

  • About ODP
    • What is OceanBase Database Proxy?
    • Glossary
  • Installation and Deployment
    • Preparation
    • Install ODP by using RPM packages
    • Manage OBProxies
      • Create an OBProxy cluster
      • Take over an OBProxy
      • Delete an OBProxy
      • Restart an OBProxy
      • Upgrade an OBProxy
      • Add an OBProxy
      • Refresh OBProxy configurations
      • Monitor OBProxy cluster performance
      • OBProxy cluster parameter management
      • Add a connectable OceanBase cluster
      • Delete an OBProxy cluster
      • Upgrade all OBProxies in an OBProxy cluster
      • Restart all OBProxies in an OBProxy cluster
      • Delete a connected OceanBase cluster
  • User Guide
    • Configuration
      • Obtain and modify configurations
      • Parameters
      • Dynamically modifiable parameters
      • Parameters that are not dynamically modifiable
      • Internal and inherited parameters
      • In-memory parameters
    • SQL statement routing
      • Create and update the RootService list
      • Create and update the location cache

Download PDF

What is OceanBase Database Proxy? Glossary Preparation Install ODP by using RPM packages Create an OBProxy cluster Take over an OBProxy Delete an OBProxy Restart an OBProxy Upgrade an OBProxy Add an OBProxy Refresh OBProxy configurations Monitor OBProxy cluster performance OBProxy cluster parameter management Add a connectable OceanBase cluster Delete an OBProxy cluster Upgrade all OBProxies in an OBProxy cluster Restart all OBProxies in an OBProxy cluster Delete a connected OceanBase cluster Obtain and modify configurations Parameters Dynamically modifiable parameters Parameters that are not dynamically modifiable Internal and inherited parameters In-memory parameters Create and update the RootService list Create and update the location cache
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & CertificationTicket
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Database Proxy
  3. V3.1.0
iconOceanBase Database Proxy
V 3.1.0Enterprise Edition
Databases
  • OceanBase Database
  • OceanBase Cloud
  • OceanBase Tugraph
  • Interactive Tutorials
  • OceanBase Best Practices
Tools
  • OceanBase Cloud Platform
  • OceanBase Migration Service
  • OceanBase Developer Center
  • OceanBase Migration Assessment
  • OceanBase Admin Tool
  • OceanBase Loader and Dumper
  • OceanBase Deployer
  • Kubernetes operator for OceanBase
  • OceanBase Diagnostic Tool
  • OceanBase Binlog Service
Connectors and Middleware
  • OceanBase Database Proxy
  • Embedded SQL in C for OceanBase
  • OceanBase Call Interface
  • OceanBase Connector/C
  • OceanBase Connector/J
  • OceanBase Connector/ODBC
  • OceanBase Connector/NET
  • V 4.3.6
  • V 4.3.4
  • V 4.3.3
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.3
  • V 4.2.2
  • V 4.2.0 and earlier

Internal and inherited parameters

Last Updated:2026-04-14 01:41:29  Updated
Share
What is on this page
Share

The following table describes ODP parameters that do not need to be modified.

Parameter
Default value
Value range
Effective upon restart
Description
need_convert_vip_to_tname false / false Specifies whether to convert virtual IP address to tenant name.
username_separator ":;-;." Valid values: ':', '-', and '.' false Specifies the username used when the client connects to the ODP. Separate multiple usernames with commas (,).
max_connections 8192 [0, 65535] false Specifies the maximum allowable fd value in ODP.
enable_client_connection_lru_disconnect false / false Specifies whether to disconnect when the number of client connections reaches the upper limit.
  • true: Disconnects the lru client session.
  • false: Disconnects the new client session.
observer_min_keep_alive_connections 0 [0, 65535] false Specifies the minimum number of keepalive connections in the server session pool. If a server session has timed out but the number of server sessions in the keepalive queue has not reached the lower limit, ODP keeps the connection and resets the timeout.
local_bound_ip 0.0.0.0 / true Indicates the local IP address of ODP. This is one of the ODP startup parameters.
listen_port 6688 (1024, 65536) true Specifies the listening port of ODP. This is one of the ODP startup parameters.
rootservice_cluster_name null / true Specifies the name of the default cluster.
obproxy_config_server_url null / true This is one of the ODP startup parameters.
current_local_config_version 0 [0, +∞) false Indicates the version of the current configuration.
enable_proxy_scramble false / false Specifies whether to enable scrambling on ODP.
proxy_service_mode client
  • client (default)
  • server
true Specifies the ODP deployment and service mode.
proxy_id 0 [0, 255] true Specifies the ID of the ODP service.
app_name undefined / true Specifies the application name of the ODP service.
enable_metadb_used true / true Specifies whether to enable access to the MetaDB.
enable_get_rslist_remote true / true Specifies whether to obtain the RS list from the config server.
rootservice_cluster_name undefined / true Specifies the name of the default cluster.
rootservice_list null / true Specifies the RS list.
proxy_tenant_name null / true Specifies the name of the default tenant.
proxy_idc_name null / true Specifies the name of the IDC where ODP is hosted.

Previous topic

Parameters that are not dynamically modifiable
Last

Next topic

In-memory parameters
Next