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

V4.3.2

  • What is ODP?
  • Installation and deployment
    • Deployment modes
    • Deploy ODP by using OCP
    • Overview
    • Deploy ODP by using the CLI
    • Deploy ODP by using obd
  • Basic operations
  • Configuration parameter
    • Parameter summary
    • View and modify parameters
    • Global parameters
      • cache_cleaner_clean_interval
      • check_tenant_locality_change
      • client_max_connections
      • client_max_memory_size
      • client_tcp_user_timeout
      • cluster_count_high_water_mark
      • congestion_failure_threshold
      • default_inactivity_timeout
      • enable_binlog_service
      • enable_cached_server
      • enable_extra_prometheus_metric
      • enable_flow_control
      • enable_get_rslist_remote
      • enable_global_ps_cache
      • enable_index_route
      • enable_primary_zone
      • enable_prometheus
      • enable_standby
      • enable_stat
      • rpc_sub_request_isolation_mode
      • server_routing_mode
      • sock_packet_mark_out
      • sql_table_cache_mem_limited
      • stat_table_sync_interval
      • syslog_level
      • work_thread_num
      • xflush_log_level
      • cache_cleaner_clean_interval
      • client_tcp_user_timeout
      • cluster_count_high_water_mark
      • congestion_failure_threshold
      • default_inactivity_timeout
      • enable_flow_control
      • enable_global_ps_cache
      • enable_prometheus
      • enable_syslog_wf
      • hot_upgrade_failure_retries
      • hot_upgrade_rollback_timeout
      • ip_listen_mode
      • log_dir_size_threshold
      • monitor_stat_high_threshold
      • normal_pl_update_threshold
      • partition_location_expire_relative_time
      • prometheus_listen_port
      • protocol_diagnosis_level
      • proxy_hot_upgrade_check_interval
      • rpc_enable_retry_request_info_log
      • rpc_force_srv_black_list
      • rpc_support_key_partition_shard_request
      • server_detect_mode
      • server_state_refresh_interval
      • sock_send_buffer_size_out
      • tunnel_request_size_threshold
      • username_separator
      • flow_event_queue_threshold
      • log_file_percentage
      • digest_sql_length
      • sock_recv_buffer_size_out
      • sequence_prefetch_threshold
      • current_local_config_version
      • client_sock_option_flag_out
      • monitor_stat_middle_threshold
      • enable_congestion
      • delay_update_entry_interval
      • local_bound_ip
      • enable_monitor_stat
      • refresh_idc_list
      • server_tcp_keepidle
      • stack_size
      • enable_async_log
      • enable_qos
      • enable_reroute
      • enable_qa_mode
      • rpc_server_net_max_pending_request
      • rpc_enable_congestion
      • enable_sync_all_stats
      • task_thread_num
      • max_log_file_size
      • short_async_task_timeout
      • flow_low_water_mark
      • sock_packet_tos_out
      • enable_connection_diagnosis
      • rpc_server_entry_expire_time
      • enable_performance_mode
      • request_buffer_length
      • rpc_server_net_invalid_time_us
      • rpc_sub_request_weight
      • enable_syslog_file_compress
      • ignore_local_config
      • monitor_cost_ms_unit
      • server_detect_fail_threshold
      • rpc_enable_global_index
      • sequence_entry_expire_time
      • fetch_proxy_bin_timeout
      • server_tcp_init_cwnd
      • sqlaudit_mem_limited
      • block_thread_num
      • enable_single_leader_node_routing
      • rpc_server_net_handler_expire_time
      • congestion_fail_window
      • need_convert_vip_to_tname
      • fetch_proxy_bin_random_time
      • server_tcp_keepintvl
      • monitor_item_limit
      • rpc_net_timeout_base
      • client_session_id_version
      • enable_partition_table_route
      • rpc_max_server_table_entry_num
      • long_async_task_timeout
      • ldg_info_refresh_interval
      • mem_leak_check_mod_name
      • sock_option_flag_out
      • rootservice_list
      • proxy_mem_limited
      • enable_sharding
      • proxy_local_cmd
      • enable_transaction_internal_routing
      • enable_sequence_prefetch
      • detect_server_timeout
      • enable_bad_route_reject
      • enable_cpu_topology
      • rpc_enable_direct_expire_route_entry
      • skip_proxy_sys_private_check
      • enable_async_pull_location_cache
      • client_tcp_keepintvl
      • enable_pl_route
      • tenant_location_valid_time
      • monitor_item_max_idle_period
      • config_server_refresh_interval
      • rpc_enable_force_srv_black_list
      • hot_upgrade_exit_timeout
      • enable_cpu_isolate
      • skip_proxyro_check
      • min_keep_congestion_interval
      • syslog_io_bandwidth_limit
      • rpc_listen_port
      • client_tcp_keepidle
      • refresh_json_config
      • enable_xa_route
      • net_accept_threads
      • routing_cache_mem_limited
      • server_tcp_user_timeout
      • shard_scan_thread_num
      • enable_full_username
      • rpc_max_request_batch_size
      • automatic_match_work_thread
      • connect_observer_max_retries
      • enable_compression_protocol
      • enable_abort_conn_info
      • rpc_request_timeout_delta
      • enable_obproxy_rpc_service
      • default_buffer_water_mark
      • enable_trans_detail_stats
      • enable_report_session_stats
      • rpc_srv_session_pool_inactive_timeout
      • slow_proxy_process_time_threshold
      • enable_ob_protocol_v2_with_client
      • obproxy_sys_password
      • monitor_stat_low_threshold
      • cluster_expire_time
      • proxy_info_check_interval
      • rpc_async_task_thread_num
      • rpc_period_task_interval
      • rpc_request_timeout
      • prometheus_sync_interval
      • monitor_log_level
      • qos_stat_clean_interval
      • monitor_stat_dump_interval
      • local_bound_ipv6_ip
      • enable_ob_protocol_v2
      • client_tcp_keepcnt
      • mem_leak_check_class_name
      • internal_cmd_mem_limited
      • flow_high_water_mark
      • server_detect_refresh_interval
      • grpc_client_num
      • enable_client_connection_lru_disconnect
      • server_tcp_keepcnt
      • enable_proxy_scramble
      • obproxy_config_server_url
      • enable_causal_order_read
      • sql_table_cache_expire_relative_time
      • max_syslog_file_count
      • enable_client_ip_checkout
      • idc_list_refresh_interval
      • enable_strict_stat_time
      • min_congested_connect_timeout
      • rpc_enable_reroute
      • log_cleanup_interval
      • delay_exit_time
      • enable_strict_kernel_release
      • rpc_enable_parallel_handler
      • refresh_rslist
      • enable_cluster_checkout
      • prometheus_cost_ms_unit
      • flow_consumer_reenable_threshold
      • rpc_max_response_batch_size
      • sequence_fail_retry_count
      • stat_dump_interval
      • slow_transaction_time_threshold
      • congestion_retry_interval
      • net_config_poll_timeout
      • enable_trace_stats
      • connection_diagnosis_option
      • rpc_redis_default_database_name
      • rpc_redis_default_user_name
      • rpc_redis_operation_timeout
      • rpc_service_mode
      • enable_full_link_trace
    • Multi-level parameters
      • enable_read_write_split
      • obproxy_force_parallel_query_dop
      • proxy_primary_zone_name
      • enable_transaction_split
      • weakread_weight_zone
      • obproxy_read_consistency
      • read_stale_retry_interval
      • sql_firewall_config
      • rootservice_cluster_name
      • proxy_route_policy
      • route_diagnosis_level
      • proxy_tenant_name
      • proxy_idc_name
      • enable_rpc_throttle
      • binlog_service_ip
      • query_digest_time_threshold
      • enable_server_ssl
      • compression_algorithm
      • obproxy_read_only
      • enable_cloud_full_username
      • route_target_replica_type
      • observer_sys_password1
      • observer_query_timeout_delta
      • rpc_throttle_limit_qps_qa
      • enable_weak_reroute
      • target_db_server
      • slow_query_time_threshold
      • observer_sys_password
      • enable_client_ssl
      • rpc_request_throttle_waiting_time
      • mysql_version
      • rpc_throttle_trigger_percentage
      • ob_max_read_stale_time
      • ssl_attributes
  • Connection management
    • Principles
    • Network connection
    • Client session
    • Session status synchronization
    • Configure a globally unique client session ID
    • Server session
  • Data routing
    • Automatic routing to the primary/standby tenants
    • Factors affecting data routing
    • Partitioning key types supported for routing by ODP
    • Character set-based routing
    • ODP routing
    • Follower latency threshold
    • Read/Write separation
    • Function partition key routing
      • String functions
      • Numeric calculation functions
      • Overview
      • FAQ
      • Date calculation functions
    • Intra-tenant routing
      • IP address-based routing
      • Global index table-based routing for strong-consistency reads
      • Partitioned table-based routing for strong-consistency reads
      • Replicated table-based routing for strong-consistency reads
      • Strategy-based routing
      • Distributed transaction routing
      • Primary zone-based routing for strong-consistency reads
      • Forcible routing
      • Weight-based load-balanced routing
      • Overview
      • Rerouting
  • Logs
    • obproxy.log
    • obproxy_stat.log
    • obproxy_error.log
    • obproxy_diagnosis.log
    • obproxy_digest.log
    • Overview
    • obproxy_slow.log
  • Commands
    • Overview
    • Dedicated ODP commands
      • KILL
      • ALTER
      • ping
      • SHOW
    • Compatible MySQL commands
      • SHOW RELAYLOG EVENTS
      • KILL
      • BINLOG
      • SHOW PROCESSLIST
      • SHOW SLAVE HOSTS
  • High availability mechanism
    • High availability testing
    • Overview
    • High availability of ODP services
    • High availability of OceanBase Database
  • OBKV
    • Throttling
    • RPC service port
    • OBKV-Redis
  • Security and protocols
  • Operation and maintenance
    • Troubleshooting logic
    • 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
    • Memory leak diagnostics
    • Connection diagnostics
    • Prometheus monitoring
    • SQL firewall
  • Release Notes
    • Versioning rules
    • Enterprise Edition
      • V3.2
        • ODP Enterprise Edition V3.2.11
        • ODP Enterprise Edition V3.2.3.5
      • V4.3
        • ODP Enterprise Edition V4.3.1
        • ODP Enterprise Edition V4.3.2
        • ODP Enterprise Edition V4.3.0
      • V4.2
        • ODP Enterprise Edition V4.2.3
        • ODP Enterprise Edition V4.2.2
        • ODP Enterprise Edition V4.2.1
      • V4.0
        • ODP Enterprise Edition V4.0.0
      • V4.1
        • ODP Enterprise Edition V4.1.0
    • Community Edition
      • V4.2
        • ODP Community Edition V4.2.0
        • ODP Community Edition V4.2.1
        • ODP Community Edition V4.2.3
      • V4.3
        • ODP Community Edition V4.3.2
        • ODP Community Edition V4.3.1
      • V4.0
        • ODP Community Edition V4.0.0
      • 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 Deploy ODP by using obd Basic operations Parameter summary View and modify parameters cache_cleaner_clean_interval check_tenant_locality_change client_max_connections client_max_memory_size client_tcp_user_timeout cluster_count_high_water_mark congestion_failure_threshold default_inactivity_timeout enable_binlog_service enable_cached_server enable_extra_prometheus_metric enable_flow_control enable_get_rslist_remote enable_global_ps_cache enable_index_route enable_primary_zone enable_prometheus enable_standby enable_stat rpc_sub_request_isolation_mode server_routing_mode sock_packet_mark_out sql_table_cache_mem_limited stat_table_sync_interval syslog_level work_thread_num xflush_log_level cache_cleaner_clean_interval client_tcp_user_timeout cluster_count_high_water_mark congestion_failure_threshold default_inactivity_timeout enable_flow_control enable_global_ps_cache enable_prometheus enable_syslog_wf hot_upgrade_failure_retries hot_upgrade_rollback_timeout ip_listen_mode log_dir_size_threshold monitor_stat_high_threshold normal_pl_update_threshold partition_location_expire_relative_time prometheus_listen_port protocol_diagnosis_level proxy_hot_upgrade_check_interval rpc_enable_retry_request_info_log rpc_force_srv_black_list rpc_support_key_partition_shard_request server_detect_mode server_state_refresh_interval sock_send_buffer_size_out tunnel_request_size_threshold username_separator flow_event_queue_threshold log_file_percentage digest_sql_length sock_recv_buffer_size_out sequence_prefetch_threshold current_local_config_version client_sock_option_flag_out monitor_stat_middle_threshold enable_congestion delay_update_entry_interval local_bound_ip enable_monitor_stat refresh_idc_list server_tcp_keepidle stack_size enable_async_log enable_qos enable_reroute enable_qa_mode rpc_server_net_max_pending_request rpc_enable_congestion enable_sync_all_stats task_thread_num max_log_file_size short_async_task_timeout flow_low_water_mark sock_packet_tos_out enable_connection_diagnosis rpc_server_entry_expire_time enable_performance_mode request_buffer_length rpc_server_net_invalid_time_us rpc_sub_request_weight enable_syslog_file_compress ignore_local_config monitor_cost_ms_unit server_detect_fail_threshold
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. V4.3.2
iconOceanBase Database Proxy
V 4.3.2
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

Overview

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

OceanBase Database Proxy (ODP) provides a wide range of intra-tenant routing modes. You can select a routing mode as needed. If you encounter any problems, you can view the routing process in ODP by using the routing diagnostics feature. For more information about the routing diagnostics feature, see Overview.

ODP provides the following intra-tenant routing modes:

  • IP address-based routing: In this mode, an OBServer node is specified by using the target_db_server parameter of ODP or by using a statement. ODP routes data read statements to the specified OBServer node. This routing mode has the highest priority. If an IP address is specified, ODP ignores other routing modes. For more information, see IP address-based routing.

  • Partitioned table-based routing for strong-consistency reads: In this mode, the partitioning key, partitioning key expression, or partition name is provided in a strong-consistency read statement to a partitioned table. ODP accurately routes the statement to the OBServer node of the leader of the partition where the data resides. For more information, see Partitioned table-based routing for strong-consistency reads.

  • Global index table-based routing for strong-consistency reads: In this mode, the column value, value expression, or index partition name of the global index table is provided in a strong-consistency read statement to the primary table. ODP accurately routes the statement to the OBServer node of leader of the index partition where the data resides. For more information, see Global index table-based routing for strong-consistency reads.

  • Replication table-based routing for strong-consistency reads: For a strong-consistency read statement to a replication table, ODP routes the statement to the OBServer node nearest to ODP. For more information, see Replicated table-based routing for strong-consistency reads.

  • Primary zone-based routing for strong consistency reads: In this mode, the primary zone is configured by using an ODP parameter. ODP routes a strong-consistency read statement for which routing calculation cannot be performed to an OBServer node in the primary zone. For more information, see Primary zone-based routing for strong-consistency reads.

  • Strategy-based routing: ODP routes statements based on rules of the configured routing strategy. For more information, see Strategy-based routing.

  • Distributed transaction routing: After distributed transaction routing is enabled by using the ODP parameter enable_transaction_internal_routing, statements in a transaction do not need to be force routed to the OBServer node that starts the transaction. For more information, see Distributed transaction routing.

  • Rerouting: Rerouting is enabled by using an ODP parameter. After a statement is routed to an OBServer node, if no partition is hit or the distributed transaction cannot be executed on this OBServer node, ODP can accurately reroute the statement. For more information, see Rerouting.

  • Forcible routing: ODP decides whether to perform forcible routing. Forcible routing is performed in the following cases. For more information, see Forcible routing.

    • For non-distributed transaction routing, statements in a transaction are force routed to the OBServer node that starts the transaction.

    • For session-level temporary table-based routing, a query is force routed to the OBServer node where the temporary table is queried for the first time.

    • Session reuse-based routing: If routing calculation fails and the enable_cached_server parameter is set to True, ODP force routes a query to the OBServer node where the session resides the last time.

    • Cursor/Piece-based routing: When the client uses cursors/pieces to obtain/upload data, all requests are force routed to the same OBServer node.

  • Weight-based load-balanced routing: You can use the weadread_weight_zone parameter of ODP to specify a weight for each zone in an OceanBase cluster. ODP performs load-balanced routing based on the weights. For more information, see Weight-based load-balanced routing.

This chapter provides examples to describe how to use different routing modes.

Previous topic

ODP routing
Last

Next topic

IP address-based routing
Next