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

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

Download PDF

What is ODP? Overview Deploy ODP by using obd Deploy ODP by using OCP Deploy ODP by using the CLI Deployment modes Basic operations View and modify parameters Parameter summary automatic_match_work_thread block_thread_num cache_cleaner_clean_interval check_tenant_locality_change client_max_connections client_max_memory_size client_session_id_version client_sock_option_flag_out client_tcp_keepcnt client_tcp_keepidle client_tcp_keepintvl client_tcp_user_timeout cluster_count_high_water_mark cluster_expire_time config_server_refresh_interval congestion_fail_window congestion_failure_threshold congestion_retry_interval connection_diagnosis_option connect_observer_max_retries current_local_config_version default_buffer_water_mark default_inactivity_timeout delay_exit_time delay_update_entry_interval detect_server_timeout digest_sql_length enable_abort_conn_info enable_async_log enable_async_pull_location_cache enable_bad_route_reject enable_binlog_service enable_cached_server enable_causal_order_read enable_client_connection_lru_disconnect enable_client_ip_checkout enable_cluster_checkout enable_compression_protocol enable_congestion enable_connection_diagnosis enable_cpu_isolate enable_cpu_topology enable_extra_prometheus_metric enable_flow_control enable_full_link_trace enable_full_username enable_get_rslist_remote enable_global_ps_cache enable_index_route enable_monitor_stat enable_ob_protocol_v2 enable_ob_protocol_v2_with_client enable_obproxy_rpc_service enable_partition_table_route enable_performance_mode enable_pl_route enable_primary_zone enable_prometheus enable_proxy_scramble enable_qa_mode enable_qos enable_report_session_stats enable_reroute enable_sequence_prefetch enable_sharding enable_single_leader_node_routing enable_standby enable_stat enable_strict_kernel_release enable_strict_stat_time enable_sync_all_stats enable_syslog_file_compress enable_syslog_wf enable_trace enable_trace_stats enable_trans_detail_stats enable_transaction_internal_routing enable_xa_route fetch_proxy_bin_random_time fetch_proxy_bin_timeout flow_consumer_reenable_threshold flow_event_queue_threshold flow_high_water_mark flow_low_water_mark grpc_client_num grpc_thread_num hot_upgrade_exit_timeout hot_upgrade_failure_retries hot_upgrade_rollback_timeout idc_list_refresh_interval ignore_local_config
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.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

Parameter summary

Last Updated:2026-04-14 01:41:30  Updated
share
What is on this page
Parameters related to configurations
Parameters related to intervals
Parameters related to hot upgrade
Parameters related to logs
Parameters related to resource pools
Parameters related to sessions
Parameters related to connections
Parameters related to the network
Parameters related to initialization
Parameters related to request response conversion
Parameters related to statistics
Startup parameters
Parameters related to tenants
Parameters related to blocklists
Parameters related to congestion
Parameters related to audit
Parameters related to debugging
Parameters related to LDCs
Parameters related to monitoring
Parameters related to Prometheus
Parameters related to cache
Parameters related to SSL
Parameters related to QoS
Parameters related to primary and standby databases
Parameters related to sequences
Parameters related to passwords
Parameters related to O&M
Parameters related to RPC
Parameters related to Routing
Others
Deleted parameters

folded

share

This topic summarizes the parameters in OceanBase Database Proxy (ODP).

Parameters related to configurations

Parameter Description
refresh_json_config Specifies whether to force update the JavaScript Object Notation (JSON) information when the Config Server is refreshed.
refresh_rslist Specifies whether to update all RootService lists when the Config Server is refreshed.
refresh_idc_list Specifies whether to update all Internet Data Center (IDC) lists when the Config Server is refreshed.

Parameters related to intervals

Parameter Description
proxy_info_check_interval Specifies the interval for ODP to detect configuration updates.
proxy_hot_upgrade_check_interval Specifies the interval for ODP to detect the hot upgrade status.
cache_cleaner_clean_interval Specifies the interval for the cache cleaner to clear the cache.
server_state_refresh_interval Specifies the interval for refreshing the status of OceanBase Database to obtain the latest status of zones or OBServer nodes.
metadb_server_state_refresh_interval Specifies the interval for refreshing the status of the MetaDB node to obtain the latest status of zones or OBServer nodes.
config_server_refresh_interval Specifies the interval for refreshing the Config Server.
idc_list_refresh_interval Specifies the interval for refreshing the IDC list to obtain the latest region and IDC information.
stat_table_sync_interval Specifies the interval for synchronizing statistics to the ob_all_proxy_stat table.
stat_dump_interval Specifies the interval for recording statistics in logs.
cluster_count_high_water_mark Specifies the maximum number of OceanBase clusters that can be accessed. When the number of accessed clusters exceeds this value, ODP evicts clusters based on the least recently used (LRU) algorithm.
cluster_expire_time Specifies the expiration time of cluster information.
ldg_info_refresh_interval Specifies the interval for refreshing server information.
read_stale_retry_interval Specifies the retry interval for reading stale data.

Parameters related to hot upgrade

Parameter Description
fetch_proxy_bin_random_time Specifies the maximum random wait time for obtaining binary files during a hot upgrade.
fetch_proxy_bin_timeout Specifies the timeout period for obtaining binary files during a hot upgrade.
hot_upgrade_failure_retries Specifies the number of retries allowed after a hot upgrade fails.
hot_upgrade_rollback_timeout Specifies the timeout period for rolling back a hot upgrade.
hot_upgrade_exit_timeout Specifies the timeout period for a graceful exit.
delay_exit_time Specifies the delay time for ODP to exit.

Parameters related to logs

Parameter Description
log_file_percentage Specifies the maximum percentage of available space occupied by log files of ODP.
log_cleanup_interval Specifies the interval for clearing log files.
log_dir_size_threshold Specifies the maximum available space of the directory where ODP logs are stored.
max_syslog_file_time Specifies the maximum retention period of archive logs.
max_syslog_file_count Specifies the maximum number of archive log files that can be retained.
enable_syslog_file_compress Specifies whether to enable compression for archive logs.
enable_syslog_wf Specifies whether to print logs at or above the WARN level in obproxy.log to a separate log file (obproxy.log.wf).

Parameters related to resource pools

Parameter Description
need_convert_vip_to_tname Specifies whether to convert a virtual IP address (VIP) into the tenant name.
long_async_task_timeout Specifies the timeout period of long asynchronous tasks.
short_async_task_timeout Specifies the timeout period of short asynchronous tasks.
username_separator Specifies the separator for usernames used by the client to connect to ODP.

Parameters related to sessions

Parameter Description
enable_client_connection_lru_disconnect Specifies whether to accept new connections when the number of client connections reaches the upper limit.
client_max_connections Specifies the maximum number of client connections supported by ODP.
observer_query_timeout_delta Specifies the value added to the ob_query_timeout parameter of OceanBase Database to adapt to the delay in network transmission.
enable_cluster_checkout Specifies whether to enable cluster name verification.
enable_proxy_scramble Specifies whether to enable proxy scrambling.
enable_client_ip_checkout Specifies whether to verify the client IP address.
enable_check_cluster_name Specifies whether to verify the cluster name in a three-segment string used for login.
proxy_id Specifies the ID of an ODP to ensure that the client session IDs generated by different ODPs do not conflict with each other.
client_session_id_version Specifies the version of the format used for generating client session IDs.

Parameters related to connections

Parameter Description
connect_observer_max_retries Specifies the maximum number of retries for ODP to connect to OceanBase Database.
connection_diagnosis_option Specifies an option that allows you to enable diagnostics for the current connection by using a bit.

Parameters related to the network

Parameter Description
net_accept_threads Specifies the number of threads that run accept tasks.
net_config_poll_timeout Specifies the timeout period of network events.
default_inactivity_timeout Specifies the default timeout period of TCP connections.
sock_recv_buffer_size_out Specifies the size of the socket receive buffer.
sock_send_buffer_size_out Specifies the size of the socket send buffer.
sock_option_flag_out Specifies the parameter for the TCP connection between ODP and OceanBase Database.
sock_packet_mark_out Specifies the packet mark used when the socket sends a packet.
sock_packet_tos_out Specifies the Type of Service (TOS) used when the socket sends a packet.
server_tcp_init_cwnd Specifies the initial congestion window specified when a TCP connection to OceanBase Database was created.
server_tcp_keepidle Specifies the keepalive idle time for a TCP connection between ODP and OceanBase Database.
server_tcp_keepintvl Specifies the keepalive interval for a TCP connection between ODP and OceanBase Database.
server_tcp_keepcnt Specifies the number of keepalive detections for a TCP connection between ODP and OceanBase Database.
server_tcp_user_timeout Specifies the user timeout period for a TCP connection between ODP and OceanBase Database.
client_sock_option_flag_out Specifies the parameter for the TCP connection between a client and ODP.
client_tcp_keepidle Specifies the keepalive idle time for a TCP connection between ODP and a client.
client_tcp_keepintvl Specifies the keepalive interval for a TCP connection between ODP and a client.
client_tcp_keepcnt Specifies the number of keepalive detections for a TCP connection between ODP and a client.
client_tcp_user_timeout Specifies the user timeout period for a TCP connection between ODP and a client.
sql_firewall_config Specifies the blocking rules of the firewall.

Parameters related to initialization

Parameter Description
proxy_mem_limited Specifies the maximum runtime memory of ODP.
stack_size Specifies the size of the thread stack.
routing_cache_mem_limited Specifies the maximum memory for the ODP route cache, such as the table cache and address cache.
work_thread_num Specifies the number of worker threads. Specify this parameter when you initialize worker threads.
task_thread_num Specifies the number of task threads.
block_thread_num Specifies the number of blocked task threads. Specify this parameter when you initialize threads.
grpc_thread_num Specifies the number of GRPC threads.
grpc_client_num Specifies the number of GRPC clients.
shard_scan_thread_num Specifies the number of threads for scanning ODP shards.
automatic_match_work_thread Specifies whether to automatically create worker threads based on the number of CPU cores.
enable_strict_kernel_release Specifies whether to verify the OS kernel.
max_log_file_size Specifies the maximum size of a single log file in ODP.

Parameters related to request response conversion

Parameter Description
default_buffer_water_mark Specifies the watermark for controlling the internal buffer size of ODP. ODP processes the requests only after their size exceeds this threshold.
tunnel_request_size_threshold Specifies the maximum size of requests received by ODP.
request_buffer_length Specifies the maximum length of the request buffer allocated to each request.
flow_high_water_mark Specifies the high watermark for triggering throttling.
flow_low_water_mark Specifies the low watermark for stopping throttling.
flow_consumer_reenable_threshold Specifies the maximum number of times the configuration data for throttling in a tunnel can be forwarded.
flow_event_queue_threshold Specifies the threshold of the event queue.
enable_flow_control Specifies whether to enable throttling in a MySQL tunnel.

Parameters related to statistics

Parameter Description
enable_trans_detail_stats Specifies whether to enable transaction status statistics.
enable_sync_all_stats Specifies whether to synchronize all statistics.
enable_report_session_stats Specifies whether to report session-level statistics to the internal table.
enable_strict_stat_time Specifies whether to enable the strict statistic time.
enable_cpu_topology Specifies whether to enable the CPU topology to bind worker threads to the CPU.
enable_trace_stats Specifies whether to enable MySQL tracing statistics.
slow_transaction_time_threshold Specifies the time threshold for slow transactions.
slow_proxy_process_time_threshold Specifies the execution time threshold for ODP to pre-execute queries.
query_digest_time_threshold Specifies the time threshold for query execution.
slow_query_time_threshold Specifies the execution time threshold for slow queries.

Startup parameters

Parameter Description
ignore_local_config Specifies whether to ignore all local cache files and start ODP by using a remote JSON file.
local_bound_ip Specifies the IP address bound to ODP to listen on.
listen_port Specifies the listening port of ODP.
ip_listen_mode Specifies the listening mode of ODP.
local_bound_ipv6_ip Specifies the IPv6 address bound to ODP.
obproxy_config_server_url Specifies the URL of the Config Server. ODP can serve as a proxy for all clusters registered with the Config Server.
enable_get_rslist_remote Specifies whether to obtain the RootService list from the remote server.
rootservice_cluster_name Specifies the default name of the cluster of the RootService list.
rootservice_list Specifies the RootService lists of OceanBase Database, in the ip1:sql_port1;ip2:sql_port2 format.

Parameters related to tenants

Parameter Description
proxy_tenant_name Specifies the default tenant name of the cloud user.

Parameters related to blocklists

Parameter Description
enable_congestion Specifies whether to enable the blocklist mechanism, which is enabled by default.
congestion_failure_threshold Specifies whether to add an OBServer node to the blocklist.
congestion_fail_window Specifies the statistical period for failures of OBServer nodes.
min_keep_congestion_interval Specifies the shortest time to wait before an OBServer node is removed from the blocklist.
congestion_retry_interval Specifies the retry interval for OBServer nodes in the alive-but-unavailable blocklist.
min_congested_connect_timeout Specifies the minimum timeout period for OBServer nodes that are alive but unavailable.

Parameters related to congestion

Parameter Description
server_detect_mode Specifies the server detection mode.
server_detect_fail_threshold Specifies the number of server detection attempts.
server_detect_refresh_interval Specifies the interval for refreshing the server status.
detect_server_timeout Specifies the timeout period for detecting whether OceanBase Database gives a response.
enable_bad_route_reject Specifies whether to reject requests that cannot be routed.
compression_algorithm Specifies the compression protocol and compression level of the OceanBase 2.0 protocol.
enable_compression_protocol Specifies whether to enable the compression protocol.
enable_ob_protocol_v2 Specifies whether to enable the OceanBase 2.0 protocol between ODP and OceanBase Database. OceanBase 2.0 is a proprietary transmission protocol developed based on the MySQL compression protocol.
enable_ob_protocol_v2_with_client Specifies whether to enable the OceanBase 2.0 protocol between ODP and the client. OceanBase 2.0 is a proprietary transmission protocol developed based on the MySQL compression protocol.
ob_max_read_stale_time Specifies the maximum latency allowed in weak-consistency reads. The default value is -1, which indicates that this feature is disabled.
enable_cached_server Specifies whether to use the cached server session in the case of no table entry.

Parameters related to audit

Parameter Description
sqlaudit_mem_limited Specifies the maximum memory for SQL audit.
internal_cmd_mem_limited Specifies the maximum memory for responses to internal commands of ODP. The value 0 indicates no limit.

Parameters related to debugging

Parameter Description
server_routing_mode Specifies the routing mode of ODP.
syslog_level Specifies the syslog level.
monitor_log_level Specifies the monitoring log level.
xflush_log_level Specifies the xflush log level.
enable_async_log Specifies whether to enable asynchronous logs.
mem_leak_check_class_name Specifies the names of classes to be monitored by the show proxymemory objpool command, which can be names in the free_list_name column of the command output.
mem_leak_check_mod_name Specifies the names of modules to be monitored by the show proxymemory command, which can be names in the mod_name column of the command output.

Parameters related to LDCs

Parameter Description
proxy_idc_name Specifies the name of the IDC for IDC-based routing in ODP.
current_local_config_version Specifies the local configuration version of the current ODP.

Parameters related to monitoring

Parameter Description
monitor_item_limit Specifies the maximum number of monitoring statistical items of ODP or the maximum number of metrics of Prometheus.
monitor_item_max_idle_period Specifies the retention period of monitoring statistical items in the memory.
monitor_cost_ms_unit Specifies whether to convert the unit of monitoring statistics to milliseconds. The default unit is microseconds.
monitor_stat_dump_interval Specifies the interval for flushing monitoring statistics to logs.
monitor_stat_low_threshold Specifies the low time threshold of tenant statistics.
monitor_stat_middle_threshold Specifies the medium time threshold of tenant statistics.
monitor_stat_high_threshold Specifies the high time threshold of tenant statistics.
enable_monitor_stat Specifies whether to enable monitoring statistics.

Parameters related to Prometheus

Parameter Description
prometheus_listen_port Specifies the Prometheus listening port of ODP.
prometheus_cost_ms_unit Specifies whether to convert the calculation unit of Prometheus to milliseconds. The default unit is microseconds.
prometheus_sync_interval Specifies the interval for synchronizing Prometheus monitoring metrics to Prometheus Exporter.
enable_prometheus Specifies whether to monitor Prometheus.
enable_extra_prometheus_metric Specifies whether to enable network and routing metrics of Prometheus.
enable_causal_order_read Specifies whether ODP selects a server by priority and synchronizes the security snapshot version as needed.

Parameters related to cache

Parameter Description
partition_location_expire_relative_time Specifies the expiration period of the partition location cache, in milliseconds.
enable_qa_mode Specifies whether ODP can force expire all location caches.
check_tenant_locality_change Specifies whether to enable the location cache to cache dirty data upon location changes.
enable_async_pull_location_cache Specifies whether to asynchronously pull the location cache when dirty data is cached.

Parameters related to SSL

Parameter Description
enable_client_ssl Specifies whether ODP uses SSL to connect to the client.
enable_server_ssl Specifies whether ODP uses SSL to connect to OceanBase Database.

Parameters related to QoS

Parameter Description
enable_qos Specifies whether to enable QoS for ODP.
qos_stat_clean_interval Specifies the interval for clearing QoS statistics.
qos_stat_item_limit Specifies the number of QoS statistical items of ODP.

Parameters related to primary and standby databases

Parameter Description
enable_standby Specifies whether to enable the standby database.
enable_standby_read_write_split Specifies whether to enable read/write splitting between the primary and standby tenants for a tenant logged in to by using a service name.

Parameters related to sequences

Parameter Description
sequence_entry_expire_time Specifies the validity period of sequences.
sequence_fail_retry_count Specifies the number of retry failures allowed for sequences.
enable_sequence_prefetch Specifies whether to prefetch sequences.
sequence_prefetch_threshold Specifies the maximum cost for triggering prefetch.

Parameters related to passwords

Parameter Description
obproxy_sys_password Specifies the password of the root@proxysys user.
observer_sys_password Specifies the password of the account (proxyro@sys) used by ODP to connect to the OceanBase cluster.
observer_sys_password1 Specifies the password of the account (proxyro@sys) used by ODP to connect to the OceanBase cluster.

Parameters related to O&M

Parameter Description
protocol_diagnosis_level Specifies whether to enable protocol diagnostics and whether to output diagnostic information to logs.
route_diagnosis_level Specifies the level of detail in routing diagnostics.

Parameters related to RPC

Parameter Description
enable_obproxy_rpc_service Specifies whether to enable the RPC service port.
rpc_enable_congestion Specifies whether to enable OBServer blocklist processing for RPC requests.
rpc_enable_direct_expire_route_entry Specifies whether to clean up expired routing information by force and not to use dirty data for asynchronous refresh.
rpc_enable_force_srv_black_list Specifies whether to enable the blocklist for forced logon authentication.
rpc_enable_global_index Specifies whether to enable the support by RPC requests for global index routing.
rpc_enable_parallel_handler Specifies whether to enable the asynchronous execution framework.
rpc_enable_reroute Specifies whether to enable RPC rerouting.
rpc_enable_retry_request_info_log Specifies whether to print RPC request retry information.
rpc_force_srv_black_list Specifies the blocklist for forced logon authentication.
rpc_listen_port Specifies the RPC service listening port.
rpc_max_request_batch_size Specifies the maximum number of requests allowed in a single batch.
rpc_max_response_batch_size Specifies the maximum number of responses allowed in a single batch.
rpc_max_server_table_entry_num Specifies the maximum number of connections in the backend connection pool of the RPC processing module.
rpc_net_timeout_base Specifies the benchmark sending rate, that is, the time (in ms) required for sending 1 byte of data. The minimum bandwidth is 200 Bps. If the parameter is set to a value lower than 200 Bps, the backend connection is abnormal and ODP removes the connection from the connection pool.
rpc_period_task_interval Specifies the interval for ODP to execute periodic RPC processing tasks. RPC processing tasks mainly clean up requests in invalid state in the frontend and backend.
rpc_redis_default_database_name Specifies the name of an OBKV-Redis physical database.
rpc_redis_default_user_name Specifies the username to access an OBKV-Redis database with a single AUTH password.
rpc_redis_operation_timeout Specifies the default timeout period for a request to an OBKV-Redis database, in μs.
rpc_service_mode Specifies whether to enable access to OBKV-Redis databases.
rpc_request_timeout Specifies the default timeout period for sending a request, in us.
rpc_request_timeout_delta Specifies the delta value of the timeout period for processing a request within ODP.
rpc_server_entry_expire_time Specifies the idle timeout period for the backend connection pool. If there is no backend connection within the specified period of time, the backend connection pool automatically exits.
rpc_server_net_handler_expire_time Specifies the timeout period for the backend connection to process a request. If no response is received within the specified period of time after a request is sent, ODP considers the connection abnormal and removes the connection from the connection pool.
rpc_server_net_invalid_time_us Specifies the interval for sending pending requests in the backend connection.
rpc_server_net_max_pending_request Specifies the number of requests to be sent in the backend connection. When the number of requests reaches the specified value within rpc_server_net_invalid_time_us, ODP considers the backend connection invalid and removes the connection from the connection pool.
rpc_srv_session_pool_inactive_timeout Specifies the inactive timeout period for the server connection in the synchronization module.
rpc_support_key_partition_shard_request Specifies whether to send an RPC request that involves cross-partition queries to all partitions when the target table is a KEY-partitioned table.
rpc_async_task_thread_num Specifies the number of asynchronous threads for OBKV. You can set an appropriate number of asynchronous threads to reduce the impact of subrequest forwarding and large request processing on general requests.
rpc_sub_request_isolation_mode Specifies the processing mode of remote procedure call (RPC) subrequests. You can set an appropriate processing mode to control the number of threads used for processing subrequests and reduce the impact on the response time of general requests.
rpc_sub_request_weight Specifies the weight of remote procedure call (RPC) subrequests. The higher the weight, the more the general threads occupied by subrequests.
enable_rpc_throttle Specifies whether to perform throttling based on the memory usage of remote procedure call (RPC) requests.
rpc_request_throttle_waiting_time Specifies the time to wait before reading remote procedure call (RPC) requests after throttling is triggered.
rpc_throttle_limit_qps_qa Specifies the queries per second (QPS) for remote procedure call (RPC) requests after throttling is triggered.
rpc_throttle_trigger_percentage Specifies the memory usage threshold that triggers throttling. When the memory usage of remote procedure call (RPC) requests reaches the specified threshold, RPC requests are throttled.

Parameters related to Routing

Parameter Description
target_db_server Specifies the IP addresses of OBServer nodes for which ODP applies forcible routing, in the ip0:port0,ip1:port1,ip2:port2;ip3:port3;ip4:port4 format.
proxy_route_policy Specifies the routing strategy for weak-consistency read requests on OceanBase Database Proxy (ODP), which defines the backend server to which client requests are routed for processing.
proxy_primary_zone_name Specifies the name of the primary zone for logical data center (LDC)-based routing in OceanBase Database Proxy (ODP).
enable_primary_zone Specifies whether OceanBase Database Proxy (ODP) performs routing based on the primary zone priorities of the tenant when routing calculation fails.
enable_index_route Specifies whether to enable routing for the global index table based on global index keys in OceanBase Database Proxy (ODP).
enable_single_leader_node_routing specifies whether to apply more efficient routing rules when a tenant is deployed in leader concentration mode.
enable_partition_table_route Specifies whether to enable partitioned table-based routing for OceanBase Database Proxy (ODP).
enable_transaction_internal_routing Specifies whether to enable distributed transaction routing.
enable_reroute Specifies whether to enable rerouting. If rerouting is enabled, when routing fails for the first time, the request is forwarded to the corresponding OBServer node again.
enable_weak_reroute Specifies whether to enable rerouting for weak-consistency reads.
enable_pl_route Specifies whether to enable Procedural Language (PL) routing.
route_target_replica_type Specifies the replica type for routing weak-consistency read requests. This parameter takes effect only when proxy_route_policy is set to a value starting with TARGET_REPLICA_TYPE_.
weakread_weight_zone Specifies the weight of each zone in a cluster. This parameter takes effect only when proxy_route_policy is set to WEAKREAD_WEIGHT_LOAD_BALANCE.

Others

Parameter Description
enable_xa_route Specifies whether to enable xa_start hold and route it to the partition accessed by the next DML statement.
normal_pl_update_threshold Specifies the maximum number of partition location update tasks processed by ODP per second.
proxy_local_cmd Specifies the hot restart of ODP.
client_max_memory_size Specifies the maximum size of memory dynamically allocated to client sessions.
delay_update_entry_interval Specifies the interval for delaying the update of table or partition entries.
tenant_location_valid_time Specifies the validity period of cached tenant information.
qa_mode_mock_public_cloud_slb_addr Specifies the SLB address of the mock public cloud.
enable_cpu_isolate Specifies whether to enable CPU isolation.
mysql_version Specifies the version returned while connecting to a MySQL tenant.
enable_performance_mode Specifies whether to enable the performance mode.
enable_full_link_trace Specifies whether to enable end-to-end tracing for query execution.
enable_trace Specifies whether to enable traces.
enable_stat Specifies whether to enable statistics.
digest_sql_length Specifies the length of recorded SQL statements. The value 0 specifies to record SQL statements with the default length.
obproxy_read_only Specifies the read/write type.
obproxy_read_consistency Specifies the target to which requests are sent.
enable_global_ps_cache Specifies whether to use the global PS cache.
enable_read_write_split Specifies whether to enable the read/write splitting mode.
enable_transaction_split Specifies whether to support transaction splitting.
binlog_service_ip Specifies the address list of the binlog service cluster. The value can be one or more IP addresses or domain names. If you specify multiple IP addresses or domain names, separate them with semicolons (;).
ssl_attributes The SSL attributes.
sql_table_cache_expire_relative_time Specifies the expiration time of the SQL table cache, in milliseconds. The value 0 indicates that the cache will never expire.
sql_table_cache_mem_limited Specifies the maximum memory usage of the SQL table cache in ODP.
enable_cloud_full_username Specifies whether to consider the account name used for logon as the username of the user. This parameter is used for cloud users.
enable_full_username Specifies whether the username must contain the tenant name and cluster name. This parameter is used for non-cloud users.
skip_proxyro_check Specifies whether to allow a client to use the proxyro@sys account for access. The value false indicates that a client cannot use this account for access.
skip_proxy_sys_private_check Specifies whether ODP skips checking the private address of the system.
obproxy_force_parallel_query_dop Used to adapt to the _force_parallel_query_dop parameter of OceanBase Database.
syslog_io_bandwidth_limit Specifies the upper limit of disk I/O bandwidth allowed for ODP logging. ODP logging is throttled when its traffic exceeds the upper bandwidth limit. When throttling is triggered, the log REACH SYSLOG RATE LIMIT will be printed in obproxy.log.
enable_sharding Specifies whether to use logical databases.

Deleted parameters

Parameter Description Remarks
enable_binlog_service Specifies whether ODP sends binlog requests to oblogproxy. This parameter is deleted since ODP V4.2.2.
enable_connection_diagnosis Specifies whether to enable connection diagnostics. This parameter is deleted since ODP V4.2.2.
enable_abort_conn_info Specifies whether ODP sends an error packet when a connection is aborted. This parameter is deleted since ODP V4.2.3.

Previous topic

View and modify parameters
Last

Next topic

automatic_match_work_thread
Next
What is on this page
Parameters related to configurations
Parameters related to intervals
Parameters related to hot upgrade
Parameters related to logs
Parameters related to resource pools
Parameters related to sessions
Parameters related to connections
Parameters related to the network
Parameters related to initialization
Parameters related to request response conversion
Parameters related to statistics
Startup parameters
Parameters related to tenants
Parameters related to blocklists
Parameters related to congestion
Parameters related to audit
Parameters related to debugging
Parameters related to LDCs
Parameters related to monitoring
Parameters related to Prometheus
Parameters related to cache
Parameters related to SSL
Parameters related to QoS
Parameters related to primary and standby databases
Parameters related to sequences
Parameters related to passwords
Parameters related to O&M
Parameters related to RPC
Parameters related to Routing
Others
Deleted parameters