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 Cloud

OceanBase Database

Tools Connectors and Middleware

QUICK START

OceanBase Cloud OceanBase 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

OceanBase Database Proxy

V4.3.4

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_sock_option_flag_out
  - client_tcp_keepidle
  - client_tcp_user_timeout
  - cluster_count_high_water_mark
  - 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
  - digest_sql_length
  - enable_async_pull_location_cache
  - enable_bad_route_reject
  - enable_binlog_service
  - enable_cached_server
  - enable_causal_order_read
  - enable_cluster_checkout
  - enable_compression_protocol
  - enable_congestion
  - enable_extra_prometheus_metric
  - enable_flow_control
  - enable_full_link_trace
  - enable_get_rslist_remote
  - enable_global_ps_cache
  - enable_index_route
  - enable_monitor_stat
  - enable_primary_zone
  - enable_prometheus
  - enable_proxy_scramble
  - enable_qa_mode
  - enable_qos
  - enable_report_session_stats
  - enable_standby
  - enable_stat
  - enable_strict_kernel_release
  - enable_strict_stat_time
  - enable_syslog_wf
  - enable_trace_stats
  - enable_xa_route
  - flow_consumer_reenable_threshold
  - flow_event_queue_threshold
  - flow_high_water_mark
  - grpc_client_num
  - grpc_thread_num
  - hot_upgrade_failure_retries
  - hot_upgrade_rollback_timeout
  - idc_list_refresh_interval
  - ip_listen_mode
  - listen_port
  - log_cleanup_interval
  - log_dir_size_threshold
  - log_file_percentage
  - max_syslog_file_count
  - max_syslog_file_time
  - metadb_server_state_refresh_interval
  - min_congested_connect_timeout
  - monitor_stat_high_threshold
  - monitor_stat_middle_threshold
  - net_config_poll_timeout
  - normal_pl_update_threshold
  - partition_location_expire_relative_time
  - prometheus_cost_ms_unit
  - prometheus_listen_port
  - protocol_diagnosis_level
  - proxy_hot_upgrade_check_interval
  - qa_mode_mock_public_cloud_slb_addr
  - refresh_idc_list
  - rootservice_list
  - rpc_client_net_write_timeout
  - rpc_enable_force_srv_black_list
  - rpc_enable_parallel_handler
  - rpc_enable_retry_request_info_log
  - rpc_force_srv_black_list
  - rpc_redis_operation_timeout
  - rpc_request_timeout_delta
  - rpc_service_mode
  - rpc_sub_request_isolation_mode
  - sequence_fail_retry_count
  - sequence_prefetch_threshold
  - server_detect_mode
  - server_routing_mode
  - server_state_refresh_interval
  - server_tcp_keepintvl
  - shard_scan_thread_num
  - short_async_task_timeout
  - slow_proxy_process_time_threshold
  - slow_transaction_time_threshold
  - sock_packet_mark_out
  - sock_recv_buffer_size_out
  - sock_send_buffer_size_out
  - sql_table_cache_mem_limited
  - stack_size
  - stat_dump_interval
  - stat_table_sync_interval
  - syslog_io_bandwidth_limit
  - syslog_level
  - task_thread_num
  - tunnel_request_size_threshold
  - username_separator
  - work_thread_num
  - xflush_log_level
  - cluster_expire_time
  - enable_abort_conn_info
  - enable_async_log
  - enable_connection_diagnosis
  - enable_obproxy_rpc_service
  - enable_performance_mode
  - enable_reroute
  - enable_sync_all_stats
  - enable_syslog_file_compress
  - flow_low_water_mark
  - local_bound_ip
  - local_bound_ipv6_ip
  - max_log_file_size
  - obproxy_sys_password
  - qos_stat_clean_interval
  - qos_stat_item_limit
  - routing_cache_mem_limited
  - rpc_async_task_thread_num
  - rpc_client_net_read_timeout
  - rpc_redis_default_user_name
  - rpc_request_timeout
  - rpc_server_net_invalid_time_us
  - rpc_server_net_max_pending_request
  - rpc_support_key_partition_shard_request
  - sequence_entry_expire_time
  - server_detect_fail_threshold
  - server_tcp_keepidle
  - client_session_id_version
  - monitor_stat_dump_interval
  - obproxy_config_server_url
  - obproxy_sys_password
  - proxy_mem_limited
  - qos_stat_clean_interval
  - qos_stat_item_limit
  - routing_cache_mem_limited
  - rpc_async_task_thread_num
  - rpc_client_net_read_timeout
  - rpc_enable_reroute
  - rpc_max_server_table_entry_num
  - rpc_redis_default_user_name
  - rpc_request_timeout
  - rpc_redis_default_database_name
  - rpc_server_net_invalid_time_us
  - rpc_server_net_max_pending_request
  - rpc_support_key_partition_shard_request
  - sequence_entry_expire_time
  - server_detect_fail_threshold
  - server_tcp_init_cwnd
  - server_tcp_keepcnt
  - server_tcp_keepidle
  - skip_proxy_sys_private_check
  - skip_proxyro_check
  - sock_option_flag_out
  - sql_table_cache_expire_relative_time
  - refresh_rslist
  - tenant_location_valid_time
  - client_tcp_keepcnt
  - config_server_refresh_interval
  - rpc_max_response_batch_size
  - hot_upgrade_exit_timeout
  - internal_cmd_mem_limited
  - min_keep_congestion_interval
  - rpc_listen_port
  - refresh_json_config
  - net_accept_threads
  - server_tcp_user_timeout
  - enable_full_username
  - automatic_match_work_thread
  - ignore_local_config
  - request_buffer_length
  - sqlaudit_mem_limited
  - enable_partition_table_route
  - enable_sharding
  - server_detect_refresh_interval
  - monitor_item_max_idle_period
  - enable_cpu_isolate
  - sock_packet_tos_out
  - server_protocol
  - rpc_server_entry_expire_time
  - rpc_sub_request_weight
  - rpc_max_request_batch_size
  - rpc_enable_direct_expire_route_entry
  - fetch_proxy_bin_timeout
  - rpc_enable_congestion
  - rpc_server_net_handler_expire_time
  - need_convert_vip_to_tname
  - rpc_enable_global_index
  - rpc_net_timeout_base
  - long_async_task_timeout
  - mem_leak_check_mod_name
  - enable_sequence_prefetch
  - enable_pl_route
  - enable_trans_detail_stats
  - monitor_cost_ms_unit
  - rpc_srv_session_pool_inactive_timeout
  - enable_client_connection_lru_disconnect
  - enable_ob_protocol_v2_with_client
  - monitor_stat_low_threshold
  - proxy_id
  - proxy_info_check_interval
  - rpc_period_task_interval
  - block_thread_num
  - prometheus_sync_interval
  - proxy_local_cmd
- Multi-level parameters
  - 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
  - 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
  - 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
  - rpc_request_throttle_waiting_time
  - mysql_version
  - rpc_throttle_trigger_percentage
  - ob_max_read_stale_time
  - ssl_attributes
  - enable_read_write_split
  - observer_sys_password1
  - enable_client_ssl
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.4
    - 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.3
    - ODP Community Edition V4.2.0
    - ODP Community Edition V4.2.1
  - V4.3
    - ODP Community Edition V4.3.1
    - ODP Community Edition V4.3.2
    - ODP Community Edition V4.3.3
    - ODP Enterprise Edition V4.3.4
  - V4.0
    - ODP Community Edition V4.0.0
  - V4.1
    - ODP Community Edition V4.1.0