OceanBase logo

OceanBase

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

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

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

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

V4.2.2

  • What is ODP?
  • Installation and deployment
    • Deployment modes
    • Deploy ODP by using OCP
    • Overview
    • Deploy ODP by using the CLI
    • Use OBD to deploy ODP
  • Basic operations
  • Configuration parameter
    • Parameter summary
    • View and modify parameters
    • Parameters that take effect dynamically
      • check_tenant_locality_change
      • client_max_connections
      • client_sock_option_flag_out
      • client_tcp_keepcnt
      • client_tcp_keepintvl
      • cluster_count_high_water_mark
      • cluster_expire_time
      • congestion_fail_window
      • congestion_retry_interval
      • default_buffer_water_mark
      • digest_sql_length
      • enable_async_log
      • enable_binlog_service
      • enable_cluster_checkout
      • enable_connection_diagnosis
      • enable_full_username
      • enable_ob_protocol_v2
      • enable_pl_route
      • enable_prometheus
      • enable_proxy_scramble
      • enable_trace_stats
      • enable_weak_reroute
      • flow_high_water_mark
      • hot_upgrade_failure_retries
      • idc_list_refresh_interval
      • long_async_task_timeout
      • max_syslog_file_time
      • monitor_stat_high_threshold
      • observer_sys_password
      • partition_location_expire_relative_time
      • routing_cache_mem_limited
      • sequence_fail_retry_count
      • server_detect_mode
      • server_tcp_keepcnt
      • server_tcp_user_timeout
      • skip_proxyro_check
      • slow_query_time_threshold
      • sock_recv_buffer_size_out
      • sql_table_cache_mem_limited
      • stat_dump_interval
      • syslog_level
      • tenant_location_valid_time
      • username_separator
      • xflush_log_level
      • congestion_failure_threshold
      • default_inactivity_timeout
      • enable_qos
      • enable_stat
      • enable_syslog_file_compress
      • hot_upgrade_exit_timeout
      • internal_cmd_mem_limited
      • log_cleanup_interval
      • monitor_stat_dump_interval
      • need_convert_vip_to_tname
      • obproxy_read_only
      • proxy_mem_limited
      • sequence_prefetch_threshold
      • server_routing_mode
      • slow_proxy_process_time_threshold
      • sock_packet_mark_out
      • enable_reroute
      • fetch_proxy_bin_timeout
      • current_local_config_version
      • enable_transaction_internal_routing
      • metadb_server_state_refresh_interval
      • short_async_task_timeout
      • enable_client_ip_checkout
      • client_tcp_keepidle
      • enable_standby
      • config_server_refresh_interval
      • enable_trace
      • qos_stat_clean_interval
      • enable_trans_detail_stats
      • enable_primary_zone
      • prometheus_sync_interval
      • obproxy_sys_password
      • enable_async_pull_location_cache
      • enable_congestion
      • client_tcp_user_timeout
      • net_config_poll_timeout
      • proxy_route_policy
      • enable_sequence_prefetch
      • qa_mode_mock_public_cloud_slb_addr
      • fetch_proxy_bin_random_time
      • enable_causal_order_read
      • enable_extra_prometheus_metric
      • ignore_local_config
      • sequence_entry_expire_time
      • enable_sharding
      • max_log_file_size
      • server_tcp_init_cwnd
      • delay_exit_time
      • monitor_cost_ms_unit
      • server_detect_fail_threshold
      • sock_packet_tos_out
      • enable_partition_table_route
      • refresh_json_config
      • refresh_rslist
      • observer_sys_password1
      • flow_consumer_reenable_threshold
      • proxy_info_check_interval
      • monitor_item_max_idle_period
      • binlog_service_ip
      • proxy_tenant_name
      • min_congested_connect_timeout
      • flow_event_queue_threshold
      • proxy_hot_upgrade_check_interval
      • ldg_info_refresh_interval
      • enable_abort_conn_info
      • mysql_version
      • query_digest_time_threshold
      • enable_strict_stat_time
      • refresh_idc_list
      • proxy_idc_name
      • min_keep_congestion_interval
      • enable_performance_mode
      • enable_get_rslist_remote
      • enable_cloud_full_username
      • monitor_stat_low_threshold
      • enable_cached_server
      • enable_server_ssl
      • enable_read_write_split
      • enable_report_session_stats
      • tunnel_request_size_threshold
      • monitor_log_level
      • enable_client_ssl
      • server_tcp_keepintvl
      • read_stale_retry_interval
      • delay_update_entry_interval
      • enable_sync_all_stats
      • enable_flow_control
      • observer_query_timeout_delta
      • connect_observer_max_retries
      • enable_transaction_split
      • obproxy_force_parallel_query_dop
      • flow_low_water_mark
      • normal_pl_update_threshold
      • route_diagnosis_level
      • sock_send_buffer_size_out
      • monitor_item_limit
      • ssl_attributes
      • server_state_refresh_interval
      • max_syslog_file_count
      • log_dir_size_threshold
      • hot_upgrade_rollback_timeout
      • proxy_local_cmd
      • server_detect_refresh_interval
      • ob_max_read_stale_time
      • sqlaudit_mem_limited
      • server_tcp_keepidle
      • qos_stat_item_limit
      • target_db_server
      • enable_ob_protocol_v2_with_client
      • slow_transaction_time_threshold
      • detect_server_timeout
      • enable_index_route
      • sock_option_flag_out
      • connection_diagnosis_option
      • cache_cleaner_clean_interval
      • enable_xa_route
      • client_max_memory_size
      • request_buffer_length
      • enable_bad_route_reject
      • skip_proxy_sys_private_check
      • enable_qa_mode
      • stat_table_sync_interval
      • obproxy_read_consistency
      • proxy_primary_zone_name
      • enable_monitor_stat
      • enable_compression_protocol
      • monitor_stat_middle_threshold
      • log_file_percentage
      • enable_client_connection_lru_disconnect
      • sql_table_cache_expire_relative_time
    • Parameters that take effect after a restart
      • ip_listen_mode
      • enable_global_ps_cache
      • local_bound_ipv6_ip
      • rootservice_list
      • rootservice_cluster_name
      • obproxy_config_server_url
      • stack_size
      • block_thread_num
      • listen_port
      • enable_strict_kernel_release
      • shard_scan_thread_num
      • local_bound_ip
      • grpc_thread_num
      • prometheus_listen_port
      • enable_cpu_isolate
      • grpc_client_num
      • work_thread_num
      • enable_cpu_topology
      • prometheus_cost_ms_unit
      • net_accept_threads
      • task_thread_num
      • automatic_match_work_thread
  • Connection management
    • Principles
    • Connection diagnostics
    • Client session
    • Session status synchronization
    • Server session
  • Data routing
    • Factors affecting data routing
    • ODP routing
    • Follower latency threshold
    • Read/Write separation
    • Intra-tenant routing
      • IP address-based routing
      • Global index table-based routing for strong-consistency reads
      • Partitioned table-based routing for strong-consistency reads
      • Replication table-based routing for strong-consistency reads
      • Strategy-based routing
      • Distributed transaction routing
      • Primary zone-based routing for strong-consistency reads
      • Forcible routing
      • Overview
      • Rerouting
  • High availability mechanism
    • High availability testing
    • Overview
    • High availability of ODP services
    • High availability of OceanBase Database
  • Security and protocols
  • Operation and maintenance
    • Troubleshooting
      • Troubleshooting logic
      • Monitoring logs
    • Performance analysis
    • Show Trace
    • Routing diagnostics
      • Overview
      • Examples
      • Obtain diagnostic information
      • Diagnostic point troubleshooting
        • PARTITION_ENTRY_LOOKUP_DONE
        • PARTITION_ID_CALC_DONE
        • ROUTE_POLICY
        • HANDLE_RESPONSE
        • ROUTE_INFO
        • EXPR_PARSE
        • Overview
        • CONGESTION_CONTROL
        • RESOLVE_TOKEN
        • SQL_PARSE
        • FETCH_TABLE_RELATED_DATA
        • LOCATION_CACHE_LOOKUP
        • ROUTINE_ENTRY_LOOKUP_DONE
        • RESOLVE_EXPR
        • CALC_ROWID
        • CALC_PARTITION_ID
        • TABLE_ENTRY_LOOKUP_DONE
        • RETRY
  • Release Notes
    • Versioning rules
    • Enterprise Edition
      • V3.2
        • ODP V3.2.11
        • ODP Enterprise Edition V3.2.3.5
      • V4.0
        • ODP Enterprise Edition V4.0.0
      • V4.1
        • ODP Enterprise Edition V4.1.0
      • V4.2
        • ODP Enterprise Edition V4.2.2
        • ODP Enterprise Edition V4.2.1
    • Community Edition
      • V4.0
        • ODP Community Edition V4.0.0
      • V4.2
        • ODP Community Edition V4.2.0
        • ODP Community Edition V4.2.1
      • V4.1
        • ODP Community Edition V4.1.0

Download PDF

What is ODP? Deployment modes Deploy ODP by using OCP Overview Deploy ODP by using the CLI Use OBD to deploy ODP Basic operations Parameter summary View and modify parameters check_tenant_locality_change client_max_connections client_sock_option_flag_out client_tcp_keepcnt client_tcp_keepintvl cluster_count_high_water_mark cluster_expire_time congestion_fail_window congestion_retry_interval default_buffer_water_mark digest_sql_length enable_async_log enable_binlog_service enable_cluster_checkout enable_connection_diagnosis enable_full_username enable_ob_protocol_v2 enable_pl_route enable_prometheus enable_proxy_scramble enable_trace_stats enable_weak_reroute flow_high_water_mark hot_upgrade_failure_retries idc_list_refresh_interval long_async_task_timeout max_syslog_file_time monitor_stat_high_threshold observer_sys_password partition_location_expire_relative_time routing_cache_mem_limited sequence_fail_retry_count server_detect_mode server_tcp_keepcnt server_tcp_user_timeout skip_proxyro_check slow_query_time_threshold sock_recv_buffer_size_out sql_table_cache_mem_limited stat_dump_interval syslog_level tenant_location_valid_time username_separator xflush_log_level congestion_failure_threshold default_inactivity_timeout enable_qos enable_stat enable_syslog_file_compress hot_upgrade_exit_timeout internal_cmd_mem_limited log_cleanup_interval monitor_stat_dump_interval need_convert_vip_to_tname obproxy_read_only proxy_mem_limited sequence_prefetch_threshold server_routing_mode slow_proxy_process_time_threshold sock_packet_mark_out enable_reroute fetch_proxy_bin_timeout current_local_config_version enable_transaction_internal_routing metadb_server_state_refresh_interval short_async_task_timeout enable_client_ip_checkout client_tcp_keepidle enable_standby config_server_refresh_interval enable_trace qos_stat_clean_interval enable_trans_detail_stats enable_primary_zone prometheus_sync_interval obproxy_sys_password enable_async_pull_location_cache enable_congestion client_tcp_user_timeout net_config_poll_timeout proxy_route_policy enable_sequence_prefetch qa_mode_mock_public_cloud_slb_addr fetch_proxy_bin_random_time enable_causal_order_read enable_extra_prometheus_metric ignore_local_config sequence_entry_expire_time enable_sharding max_log_file_size server_tcp_init_cwnd
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
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. V4.2.2
iconOceanBase Database Proxy
V 4.2.2
  • 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

Deployment modes

Last Updated:2026-04-14 09:41:35  Updated
share
What is on this page
Deployment on the OBServer side
Independent deployment

folded

share

This topic describes how to deploy OceanBase Database Proxy (ODP).

The deployment mode varies with the real physical environment and business requirements. When you deploy ODP in a production environment, take the following factors into consideration:

  • Delivery mode

    ODP is provided in RPM package mode and can be deployed using OceanBase Deployer (OBD), OceanBase Cloud Platform (OCP), or the CLI.

  • Quantity

    The number of ODPs that can be deployed is related with the number of applications or OBServers, depending on the specific deployment mode.

  • Deployment modes

    The response time and resource preemption strategies vary with the deployment mode, and the deployment mode significantly affects the performance. ODP supports two deployment modes: deployment on the OBServer side, and independent deployment.

Deployment on the OBServer side

ODP deployment on the OBServer side means that one ODP process on deployed on one OBServer. In this way, the number of ODPs is the same as that of OBServers. This deployment mode does not involve the correspondence between the numbers of applications and ODPs. You can also deploy one ODP in each zone.

The following figure shows a common ODP deployment mode in Apsara Stack.

Figure 2

Independent deployment

In independent deployment mode, ODP is deployed on a dedicated server. The number of ODPs is not related to the number of applications or OBServers, but depends on specific business requirements.

We recommend that you use a midrange computer, for example, a 16C 16G ECS instance. In independent deployment mode, resource preemption between the OBServer and ODP will not occur. You can better manage ODP and use ODP as a resource pool to provide external services. Currently, this deployment mode is used in a public cloud.

Figure 3

Previous topic

Deploy ODP by using the CLI
Last

Next topic

Basic operations
Next
What is on this page
Deployment on the OBServer side
Independent deployment