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.3

  • 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_async_log
      • enable_binlog_service
      • enable_cached_server
      • enable_flow_control
      • enable_global_ps_cache
      • enable_index_route
      • enable_monitor_stat
      • enable_primary_zone
      • enable_prometheus
      • enable_qa_mode
      • enable_qos
      • enable_reroute
      • enable_standby
      • sock_packet_mark_out
      • sql_table_cache_mem_limited
      • stack_size
      • 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_async_log
      • enable_global_ps_cache
      • enable_monitor_stat
      • enable_qa_mode
      • enable_qos
      • enable_syslog_wf
      • flow_event_queue_threshold
      • hot_upgrade_failure_retries
      • hot_upgrade_rollback_timeout
      • ip_listen_mode
      • local_bound_ip
      • log_dir_size_threshold
      • monitor_stat_high_threshold
      • normal_pl_update_threshold
      • protocol_diagnosis_level
      • proxy_hot_upgrade_check_interval
      • rpc_enable_retry_request_info_log
      • server_detect_mode
      • server_tcp_keepidle
      • sock_send_buffer_size_out
      • tunnel_request_size_threshold
      • username_separator
      • rpc_force_srv_black_list
      • partition_location_expire_relative_time
      • server_state_refresh_interval
      • rpc_server_net_max_pending_request
      • log_file_percentage
      • digest_sql_length
      • sock_recv_buffer_size_out
      • sequence_prefetch_threshold
      • current_local_config_version
      • client_sock_option_flag_out
      • rpc_redis_operation_timeout
      • rpc_support_key_partition_shard_request
      • monitor_stat_middle_threshold
      • enable_congestion
      • delay_update_entry_interval
      • enable_extra_prometheus_metric
      • enable_get_rslist_remote
      • stat_table_sync_interval
      • prometheus_listen_port
      • metadb_server_state_refresh_interval
      • qos_stat_item_limit
      • monitor_item_max_idle_period
      • enable_sync_all_stats
      • rpc_enable_congestion
      • max_log_file_size
      • task_thread_num
      • flow_low_water_mark
      • rpc_enable_global_index
      • enable_connection_diagnosis
      • sock_packet_tos_out
      • enable_performance_mode
      • enable_full_username
      • client_tcp_keepidle
      • rpc_server_net_invalid_time_us
      • rpc_server_entry_expire_time
      • enable_syslog_file_compress
      • rpc_sub_request_weight
      • server_detect_fail_threshold
      • rpc_enable_direct_expire_route_entry
      • sequence_entry_expire_time
      • fetch_proxy_bin_timeout
      • server_tcp_init_cwnd
      • automatic_match_work_thread
      • enable_single_leader_node_routing
      • rpc_server_net_handler_expire_time
      • congestion_fail_window
      • need_convert_vip_to_tname
      • fetch_proxy_bin_random_time
      • short_async_task_timeout
      • monitor_item_limit
      • rpc_net_timeout_base
      • client_session_id_version
      • ignore_local_config
      • monitor_cost_ms_unit
      • rpc_max_server_table_entry_num
      • long_async_task_timeout
      • ldg_info_refresh_interval
      • mem_leak_check_mod_name
      • sock_option_flag_out
      • request_buffer_length
      • rpc_redis_default_database_name
      • server_tcp_keepintvl
      • proxy_mem_limited
      • sqlaudit_mem_limited
      • block_thread_num
      • enable_transaction_internal_routing
      • enable_sequence_prefetch
      • detect_server_timeout
      • rootservice_list
      • enable_cpu_topology
      • enable_pl_route
      • skip_proxy_sys_private_check
      • enable_bad_route_reject
      • client_tcp_keepintvl
      • rpc_enable_force_srv_black_list
      • tenant_location_valid_time
      • enable_partition_table_route
      • config_server_refresh_interval
      • routing_cache_mem_limited
      • hot_upgrade_exit_timeout
      • enable_sharding
      • proxy_local_cmd
      • min_keep_congestion_interval
      • enable_async_pull_location_cache
      • rpc_listen_port
      • syslog_io_bandwidth_limit
      • refresh_json_config
      • shard_scan_thread_num
      • net_accept_threads
      • rpc_max_request_batch_size
      • server_tcp_user_timeout
      • enable_xa_route
      • enable_cpu_isolate
      • skip_proxyro_check
      • enable_strict_kernel_release
      • connect_observer_max_retries
      • prometheus_cost_ms_unit
      • enable_abort_conn_info
      • stat_dump_interval
      • enable_obproxy_rpc_service
      • enable_compression_protocol
      • enable_trans_detail_stats
      • enable_trace_stats
      • rpc_srv_session_pool_inactive_timeout
      • connection_diagnosis_option
      • enable_ob_protocol_v2_with_client
      • rpc_request_timeout_delta
      • monitor_stat_low_threshold
      • default_buffer_water_mark
      • proxy_info_check_interval
      • obproxy_sys_password
      • rpc_period_task_interval
      • cluster_expire_time
      • prometheus_sync_interval
      • rpc_max_response_batch_size
      • monitor_log_level
      • rpc_redis_default_user_name
      • monitor_stat_dump_interval
      • rpc_async_task_thread_num
      • enable_ob_protocol_v2
      • client_tcp_keepcnt
      • rpc_request_timeout
      • internal_cmd_mem_limited
      • enable_report_session_stats
      • server_detect_refresh_interval
      • slow_proxy_process_time_threshold
      • enable_client_connection_lru_disconnect
      • qos_stat_clean_interval
      • enable_proxy_scramble
      • local_bound_ipv6_ip
      • enable_causal_order_read
      • mem_leak_check_class_name
      • max_syslog_file_count
      • server_tcp_keepcnt
      • idc_list_refresh_interval
      • flow_high_water_mark
      • min_congested_connect_timeout
      • obproxy_config_server_url
      • log_cleanup_interval
      • delay_exit_time
      • grpc_client_num
      • rpc_enable_parallel_handler
      • sql_table_cache_expire_relative_time
      • enable_cluster_checkout
      • rpc_service_mode
      • enable_strict_stat_time
      • flow_consumer_reenable_threshold
      • enable_client_ip_checkout
      • sequence_fail_retry_count
      • enable_full_link_trace
      • slow_transaction_time_threshold
      • rpc_enable_reroute
      • congestion_retry_interval
      • refresh_rslist
      • net_config_poll_timeout
    • Multi-level parameters
      • ob_max_read_stale_time
      • 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
      • ssl_attributes
      • enable_standby_read_write_split
      • query_digest_time_threshold
      • enable_server_ssl
      • compression_algorithm
      • obproxy_read_only
      • enable_cloud_full_username
      • route_target_replica_type
      • enable_read_write_split
      • observer_query_timeout_delta
      • enable_check_cluster_name
      • rpc_throttle_limit_qps_qa
      • enable_weak_reroute
      • target_db_server
      • slow_query_time_threshold
      • observer_sys_password
      • observer_sys_password1
      • rpc_request_throttle_waiting_time
      • mysql_version
      • enable_client_ssl
      • rpc_throttle_trigger_percentage
  • 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
        • SHOW
        • SHOW PROXYPS
    • 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
    • OBKV-Redis
    • Throttling
    • RPC service port
  • 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.3
        • 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.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_async_log enable_binlog_service enable_cached_server enable_flow_control enable_global_ps_cache enable_index_route enable_monitor_stat enable_primary_zone enable_prometheus enable_qa_mode enable_qos enable_reroute enable_standby sock_packet_mark_out sql_table_cache_mem_limited stack_size 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_async_log enable_global_ps_cache enable_monitor_stat enable_qa_mode enable_qos enable_syslog_wf flow_event_queue_threshold hot_upgrade_failure_retries hot_upgrade_rollback_timeout ip_listen_mode local_bound_ip log_dir_size_threshold monitor_stat_high_threshold normal_pl_update_threshold protocol_diagnosis_level proxy_hot_upgrade_check_interval rpc_enable_retry_request_info_log server_detect_mode server_tcp_keepidle sock_send_buffer_size_out tunnel_request_size_threshold username_separator rpc_force_srv_black_list partition_location_expire_relative_time server_state_refresh_interval rpc_server_net_max_pending_request log_file_percentage digest_sql_length sock_recv_buffer_size_out sequence_prefetch_threshold current_local_config_version client_sock_option_flag_out rpc_redis_operation_timeout rpc_support_key_partition_shard_request monitor_stat_middle_threshold enable_congestion delay_update_entry_interval enable_extra_prometheus_metric enable_get_rslist_remote stat_table_sync_interval prometheus_listen_port metadb_server_state_refresh_interval qos_stat_item_limit monitor_item_max_idle_period enable_sync_all_stats rpc_enable_congestion max_log_file_size task_thread_num flow_low_water_mark rpc_enable_global_index enable_connection_diagnosis sock_packet_tos_out enable_performance_mode enable_full_username client_tcp_keepidle rpc_server_net_invalid_time_us rpc_server_entry_expire_time enable_syslog_file_compress rpc_sub_request_weight
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.3
iconOceanBase Database Proxy
V 4.3.3
  • 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

Throttling

Last Updated:2026-04-14 01:41:30  Updated
share
What is on this page
Background information
Description
Considerations
Examples

folded

share

Background information

Both the client and OceanBase Database support throttling. To ensure stability throughout the link, OceanBase Database Proxy (ODP) must also support throttling. To improve stability and reduce the impact of throttling on users, ODP supports throttling on remote procedure call (RPC) requests based on the memory usage in V4.3.2 and later.

Description

Throttling is enabled when the memory usage of RPC requests reaches rpc_throttle_trigger_percentage the specified threshold , and rpc_throttle_limit_qps_qa the queries per second (QPS) value is limited to 70% of the QPS when throttling is triggered. When the specified QPS is reached, ODP reads subsequent requests based on rpc_request_throttle_waiting_time the specified wait time . No error is returned throughout the throttling process.

Considerations

  • To use this feature, make sure that the version of ODP is V4.3.2 or later.

  • Before you use this feature, make sure that enable_obproxy_rpc_service is set to true.

  • If the memory usage of RPC requests still increases constantly, ODP stops reading requests and prints logs when the memory usage of RPC requests reaches 70% of the total memory, and continues to read requests when the memory pressure decreases.

Examples

  1. Log in to OceanBase Database through ODP as the root@sys user or log in to ODP as the root@proxysys user.

    Here is an example of logging in to OceanBase Database through ODP as the root@sys user. For more information about parameters in the following command, see Connect to an OceanBase Database tenant by using OBClient.

    [admin@obtest ~]$ obclient -uroot@sys#obcluster -h10.10.10.1 -P2883 -p
    

    Notice

    To use ODP commands in OceanBase Database, the IP address (specified by -h) and the port (specified by -P) for connecting to OceanBase Database must be the IP address and listening port (specified by listen_port) of ODP.

    Here is an example of logging in to ODP as the root@proxysys user. The IP address (specified by -h) is the IP address of ODP, and the port (specified by -P) is the listening port (specified by listen_port) of ODP.

    [admin@obtest ~]$ obclient -uroot@proxysys -h10.10.10.1 -P2883 -p
    
  2. Enable throttling.

    obclient> alter proxyconfig set enable_rpc_throttle=true;
    
  3. Modify the threshold that triggers throttling.

    obclient> alter proxyconfig set rpc_throttle_trigger_percentage= 40;
    
  4. Modify the time to wait before ODP reads RPC requests after throttling is triggered.

    obclient> alter proxyconfig set rpc_request_throttle_waiting_time= 10ms;
    
  5. Modify the QPS to use after throttling is triggered.

    obclient> alter proxyconfig set rpc_throttle_limit_qps_qa= 500;
    

Previous topic

RPC service port
Last

Next topic

OBKV-Redis
Next
What is on this page
Background information
Description
Considerations
Examples