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

V3.2.3Enterprise Edition

  • Document Overview
  • What's New?
    • Product updates
  • Product Introduction
    • What is OceanBase Cloud Platform?
    • System architecture
    • Features
    • Limits
      • System requirements
      • Dependencies
  • Deployment Guide
    • Product Introduction
      • What is OceanBase Cloud Platform?
      • System architecture
    • Deployment
      • Overview
      • Deploy OCP on a single node
      • Deploy OCP clusters in the multi-cluster mode
    • Plan resources
      • OCP-Server specifications
      • MetaDB resources
      • MonitorDB resources
      • Host resources
    • Prepare the deployment environment
      • Standardize a host
      • Check the environment
    • Deploy OCP on a single node
      • Prepare installation media
      • Generate a configuration file
      • Multi-zone deployment
      • Deploy OCP
      • Register an OCP cluster
      • Initialize system parameters
    • Check after deployment
    • Deployment FAQ
      • Optimize MonitorDB parameters
      • F5 Big-IP LTM and alert configuration
        • Connect OBProxy to F5 Big-IP LTM
        • Connect OCP-Console to F5 Big-IP LTM
        • Monitor the OCP service health
      • Ubuntu deployment FAQ
      • EulerOS deployment FAQ
      • Client requirements
      • Start and stop OCP
  • Quick Start
    • OCP operations
    • Upload a software package
    • Add a host
    • Create a cluster
    • Create a tenant
    • Create a user
    • Create an OBProxy cluster
  • User Guide
    • OCP overview
    • Log on to the OceanBase Cloud Platform console
    • Features
      • Clusters
        • Cluster management
        • Cluster overview
        • Overview of the Cluster Details page
      • Tenants
        • Tenant and resource management
        • Tenant overview
        • Overview of the Tenant Details page
      • Hosts
        • Host overview
        • Host details
      • Packages
      • OBProxy
        • OBProxy management overview
        • OBProxy overview
        • OBProxy cluster overview
      • Backup and recovery
        • Overview
        • Backup and recovery overview
        • Backup overview
        • Restoration overview
        • Services
      • Monitoring
        • Drill-down monitoring
      • System management
        • Alert overview
        • View tasks
        • Inspection
        • Security overview
        • View system parameters
        • Historical events
        • OCP multi-cluster mode
        • Multi-zone overview
      • Personal center
        • Specify personal information
        • Change your logon password
        • Configure alert subscription
        • Password box
          • Manage connection credentials of an OceanBase cluster
          • Manage connection credentials of an OBProxy
          • Manage connection credentials of a host
        • Log off the OCP console
    • Manage clusters
      • Cluster management operations
      • Basic cluster operations
        • Take over a cluster
        • Create a cluster
        • Delete a cluster
        • Stop a cluster
        • Restart a cluster
        • Manage zones of a cluster
          • Create a zone
          • Restart a zone
          • Stop a zone
          • Delete a zone
        • Manage OBServers of a cluster
          • Add an OBServer
          • Restart an OBServer
          • Stop an OBServer
          • Replace an OBServer
          • Delete an OBServer
        • Upgrade the version of an OceanBase cluster
        • Change the password
        • Create a standby cluster
        • Routine primary/standby cluster switchover
        • Primary/Standby cluster switchover for disaster recovery
        • Disable SQL collection
        • View the SQL collection history
      • View the topology of a cluster
      • Cluster tenant management overview
      • Performance monitoring
      • Performance report
      • Cluster resource management
      • Health inspection
      • Major compaction management
        • Modify major freeze configurations
        • Major compaction details
        • Major freeze statistics
        • Perform a major compaction
      • Cluster backup and recovery
      • Manage parameters
        • View parameters
        • Modify parameters
        • Parameter types
        • View the history of parameter changes
      • Manage cluster parameter templates
    • Manage tenants
      • Tenant management operations
      • Basic tenant operations
        • Create a tenant
        • Unit specification management
        • Create a user under an Oracle tenant
        • Lock a tenant
        • Copy a tenant
        • Delete a tenant
        • Add a replica
        • Change the password of the SYS tenant
        • Edit a tenant replica of a zone
        • Delete a tenant replica from a zone
        • Modify zone priorities
        • Modify the whitelist
      • View a tenant topology
      • Database management
      • User management under a MySQL tenant
      • User management under an Oracle tenant
        • User overview under an Oracle tenant
        • Create a user under an Oracle tenant
        • Change the password of a user under an Oracle tenant
        • Delete a user under an Oracle tenant
        • Create a role under an Oracle tenant
        • Manage users
        • Manage roles
      • Performance monitoring
      • Tenant resource management
      • SQL diagnostics
        • Suspected SQL diagnosis
        • TopSQL diagnosis
        • SlowSQL diagnosis
        • View SQL statement details
        • View outlines
      • Back up and recover a tenant
      • Manage sessions
        • View tenant sessions
        • View session statistics
        • View deadlock analysis
        • Manage ASH report
      • Manage parameters
        • View the parameters
        • Modify a parameter
        • View the parameter modification history
      • Manage tenant parameter templates
    • Manage hosts
      • Host management operations
      • Add a host
      • Modify a host
      • Restart OCP Agent
      • Reinstall OCP Agent
      • Host monitoring
    • Manage software packages
      • Upload a software package
      • Download a software package
      • Delete a software package
    • Manage OBProxies
      • Create an OBProxy cluster
      • Take over an OBProxy
      • Delete an OBProxy
      • Restart an OBProxy
      • Upgrade an OBProxy
      • Add an OBProxy
      • Refresh OBProxy configurations
      • Monitor OBProxy cluster performance
      • OBProxy cluster parameter management
      • Add a connectable OceanBase cluster
      • Delete an OBProxy cluster
      • Upgrade all OBProxies in an OBProxy cluster
      • Restart all OBProxies in an OBProxy cluster
      • Delete a connected OceanBase cluster
    • Use backup and recovery
      • Backup and recovery management operations
      • Backup and recovery guide
      • Create a backup strategy
      • Back up now
      • Create a sampling strategy for recovery
      • Initiate a recovery
      • Install a service
      • Add a node
      • Upgrade the version of a service
      • Update service configurations
      • Copy a service
      • Delete a service
      • Stop a service on a node
      • Restart a service on a node
      • View operation and maintenance tasks
      • Uninstall a service on a node
    • Manage alerts
      • Alert-related concepts
      • Create an alert item
      • View alert items
      • Copy an alert item
      • Edit an alert item
      • Delete an alert item
      • Alert groups
      • Create an alert channel
      • View alert channels
      • Edit an alert channel
      • Delete an alert channel
      • View an alert event
      • View the alert notification history
      • Create a blocking condition
      • Edit alert blocking conditions
      • Delete a blocking condition
      • Add a filtering keyword
      • Modify the expiration time of a filtering keyword
      • Delete a filtering keyword
      • Create an alert subscription
      • Manage alert subscriptions
    • Use system management
      • Role overview
      • Create a role
      • Manage roles
      • Copy a role
      • Create a user
      • View users
      • Edit a user
      • Copy a user
      • Change a user password
      • Delete a user
      • Logon history
      • Manage system parameters
      • Query logs
      • Manage tasks
      • Use the inspection feature
        • Initiate an inspection
        • Create an inspection rule
        • Modify inspection scheduling
        • Modify an inspection rule
        • Delete an inspection rule
        • View inspection rules
    • Manage OCP clusters in the multi-cluster mode
      • Register an OCP cluster
      • Leader \& Follower Details
      • Manage OCP cluster parameters
      • Switch an OCP cluster in daily maintenance
      • Switch an OCP cluster in a failover
      • Delete a faulty follower OCP cluster
      • Unbind a leader and a follower OCP cluster
    • Manage OCP in multi-zone mode
      • View details of multiple zones
      • Manage parameters in multi-zone mode
    • Appendix
      • OCP configuration parameters
      • SQL performance module
      • OCP resource unit specifications
      • OCP error table
      • OCP alert template variables
      • Call an alert API
      • OCP background tasks
      • Monitoring metrics
      • Examples of alert channel configuration
      • OBProxy startup parameters
      • System privileges in a MySQL tenant
      • Component listening port list
      • OCP-Agent processes
      • Enable the OCP multi-cluster mode
      • PAM permission denied
      • Failed to upload the software package
      • Check the sudo permissions of a user
      • Default OCP roles
      • FAQ about multi-zone mode
      • FAQ about OBProxy takeover
  • Metric reference
    • Overview of metrics
    • OceanBase cluster
      • QPS
      • Query response time
      • TPS
      • Transaction response time
      • Request queue time
      • Number of sessions
      • TPS
      • Number of transaction logs
      • Transaction log volume
      • Time consumed by transaction logs
      • IOPS
      • Time consumed by I/O operations
      • I/O throughput
    • OceanBase Database tenant
      • QPS
      • Response time
      • Number of active sessions
      • SQL execution plan types
      • Wait events
      • Time consumed by waiting events
      • Request queue
      • Request queue time
      • CPU utilization
      • MemStore usage
      • Time consumed by RPC packets
      • RPC packet throughput
      • TPS
      • Transaction response time
      • Number of transaction logs
      • Transaction log volume
      • Time consumed by transaction logs
      • Lock waits
      • Time consumed by lock waits
      • TPS
      • MemStore
      • IOPS
      • Time consumed by I/O operations
      • I/O throughput
      • Cache size
      • Cache hit rates
    • OBProxy cluster
      • TPS
      • Requests per second
      • Client connections
      • Server connections
      • Average response time for each SQL statement
      • Average error packets per second
      • Average route table queries per second
      • Average bytes in a network request or response
    • Host
      • Linux system load
      • CPU utilization
      • IOPS
      • Time consumed by I/O operations
      • I/O throughput
      • Network throughput
      • Memory
      • Disk
  • Troubleshooting
    • Failed to upload the software package
    • Do IO Bench error
    • Check the sudo permissions of a user
    • Log error PAM Permission Denied
    • Resolve the problem of no sudo permissions when adding a host
    • Questions about OCP-Agent
      • Exceptions of the ocp_agent processes
      • System resource constraints and PAM
    • Appendix
      • Processes
      • OCP-Agent O\&M script
  • Alert Reference
    • Overview
    • OceanBase alerts
      • ob_cannot_connected
      • ob_cluster_rs_not_same
      • ob_cluster_status_check_failed
      • ob_cluster_exists_inactive_server
      • ob_cluster_exists_index_fail_table
      • ob_cluster_frozen_version_delta_over_threshold
      • ob_cluster_merge_error
      • ob_cluster_merge_timeout
      • ob_cluster_no_frozen
      • ob_cluster_no_merge
      • ob_cluster_operation_info
      • ob_cluster_sync_failed
      • ob_cpu_assigned_percent_over_threshold
      • ob_cpu_percent_over_threshold
      • ob_host_connection_percent_over_threshold
      • ob_host_disk_percent_over_threshold
      • ob_host_disk_readonly
      • ob_host_exists_expired_trans
      • ob_host_load1_per_cpu_over_threshold
      • ob_host_partition_count_over_threshold
      • ob_log_alarm
      • ob_mem_assigned_percent_over_threshold
      • ob_server_sstable_percent_over_threshold
      • ob_server_exists_long_lived_trans
      • ob_tenant_operation_info
      • ob_tenant500_mem_hold_over_threshold
      • ob_tenant500_mem_hold_percent_over_threshold
      • ob_zone_sstable_percent_over_threshold
      • tenant_active_memstore_percent_over_threshold
      • tenant_cpu_percent_over_threshold
      • tenant_memstore_percent_over_threshold
      • obproxy_process_dead
      • obproxyd_process_dead
      • obproxy_cannot_connected
      • ob_cluster_sync_delay_time_too_long
      • ob_host_data_disk_percent_over_threshold
      • ob_host_log_disk_percent_over_threshold
      • ob_host_install_disk_percent_over_threshold
      • ob_tenant_exists_expired_xa_trans
      • ob_cluster_active_session_count_over_threshold
      • ob_tenant_active_session_count_over_threshold
      • ob_host_active_session_count_over_threshold
      • ob_tenant_full_clog_sync_delay
      • ob_tenant_readonly_clog_sync_delay
      • ob_tenant_logonly_clog_sync_delay
    • Application alerts
      • ob_cluster_inspection_not_passed
      • ob_host_ssd_wear_indicator_over_threshold
      • ob_host_mem_percent_over_threshold
      • ob_host_net_recv_percent_over_threshold
      • ob_host_net_send_percent_over_threshold
      • ob_host_tcp_retrans_percent_over_threshold
      • ob_host_cpu_percent_over_threshold
      • no_enough_exporter
      • inc_backup_delay
      • base_backup_fail
      • base_backup_too_long_time_no_one_success_task
      • backup_process_dead
      • backup_storage_capacity_over_threshold
      • backup_storage_capacity_retry_times_exceeded
      • backup_storage_capacity_timeout_or_interrupted
      • ocp_remote_server_time_diff_too_large
      • monitor_exporter_unavaliable
      • system_obproxy_unavailable
      • host_unavailable
      • host_ntp_offset_too_large
      • host_ntp_service_not_exist
      • host_agent_res_memory_over_threshold
      • host_agent_open_fd_count_over_threshold
      • host_agent_goroutine_count_over_threshold
      • partition_create_failed
      • obagent_dead
      • host_disk_readonly
      • ic_server_connect_failed
      • vpc_connect_failed
    • Appendix
      • Set an alert-blocking condition
      • Modify alert thresholds
      • Exception handling for OceanBase cluster compaction
      • OCP-Agent script
      • Apply throttling to an OceanBase cluster
      • Network troubleshooting
      • Tables managed by the daemon
  • API Reference
    • Overview
    • API call description
    • Cluster information
      • Query clusters
      • Create an OceanBase cluster
      • Delete an OceanBase cluster
      • Stop an OceanBase cluster
      • Start an OceanBase cluster
      • Restart an OceanBase cluster
      • Upgrade an OceanBase cluster
      • Query zones of an OceanBase cluster
      • Create a zone for an OceanBase cluster
      • Delete a zone from an OceanBase cluster
      • Stop a zone in an OceanBase cluster
      • Start a zone in an OceanBase cluster
      • Restart a zone in an OceanBase cluster
      • Add an OBServer
      • Delete multiple OBServers at a time
      • Stop an OBServer
      • Start an OBServer
      • Restart an OBServer
      • Replace an OBServer
      • Change the password of an OceanBase cluster
      • Query the parameter metadata of an OceanBase cluster
      • Query parameters of an OceanBase cluster
      • Modify parameters of an OceanBase cluster
      • Query servers
      • Query servers in a zone
    • Tenant information
      • Query tenants of a cluster
      • Query all tenants
      • Query details about a tenant
      • Create a tenant
      • Delete a tenant
      • Lock a tenant
      • Unlock a tenant
      • Query units of a tenant
      • Delete a unit from a tenant
      • Add a replica for a tenant
      • Delete a replica of a tenant
      • Modify a replica of a tenant
      • Modify zone priorities of a tenant
      • Change the administrator password of a tenant
      • Modify the whitelist of a tenant
      • Query parameters of a tenant
      • Modify parameters of a tenant
      • OceanBase database management
        • Query databases
        • Create a database
        • Modify a database
        • Delete a database
    • Hosts
      • Query regions
      • Query details about a region
      • Add a region
      • Delete a region
      • Query IDCs
      • Query details about an IDC
      • Add an IDC
      • Delete an IDC
      • Query host types
      • Query details about a host type
      • Add a host type
      • Delete a host type
      • Query hosts
      • Query details about a host
      • Add multiple hosts at a time
      • Delete a host
      • Delete multiple hosts at a time
    • Software packages
      • Query software packages
      • Upload a software package
      • Delete a software package
    • OBProxy management
      • Create an OBProxy cluster
      • Delete an OBProxy cluster
      • Query OBProxy clusters
      • Query details about an OBProxy cluster
      • Update configurations of an OBProxy cluster
      • Add an OBProxy
      • Take over an OBProxy
      • Delete an OBProxy
      • Restart an OBProxy
      • Upgrade an OBProxy
      • Add a connectable OceanBase cluster for an OBProxy cluster
      • Remove a connectable OceanBase cluster from an OBProxy cluster
      • Query the parameter metadata of an OBProxy
      • Query parameters of an OBProxy cluster
    • Monitoring
      • Query the metadata of a monitoring metric
      • Query monitoring data
      • Query monitoring data and attach a tag to the data
    • Alerts
      • Alert events
        • Query the alert event list
        • Query alert events
      • Alert notifications
        • Query alert notifications
    • Task management
      • Query tasks
      • Query details about a task
      • Retry a task
      • Roll back a task
      • Query logs of a subtask instance
      • Retry a subtask
      • Skip a subtask
      • Cancel a subtask
    • OCP event history
      • Query event history
    • OceanBase user and privilege management
      • Query database user details
      • Query database user details
      • Create a database user
      • Delete a database user
      • Change the password of a database user
      • Lock a database user
      • Unlock a database user
      • Query the database role details
      • Query database role details
      • Create a database role
      • Delete a database role
      • Query database objects
      • Grant global privileges to a user
      • Revoke global privileges of a user
      • Change global privileges of a user
      • Grant global privileges to a role
      • Revoke global privileges of a role
      • Change global privileges of a role
      • Grant roles to a user
      • Revoke roles of a user
      • Change roles of a user
      • Grant roles to a role
      • Revoke roles of a role
      • Change roles of a role
      • Grant database privileges to a user
      • Revoke database privileges of a user
      • Change database privileges of a user
      • Grant object privileges to a user
      • Revoke object privileges of a user
      • Change object privileges of a user
      • Grant object privileges to a role
      • Revoke object privileges of a role
      • Change object privileges of a role
    • OCP Agent management
      • Query OCP Agent details on a host
      • Stop basic OCP Agent processes on a host
      • Batch stop basic OCP Agent processes on a host
      • Restart basic OCP Agent processes on a host
      • Batch restart basic OCP Agent processes on a host
      • Query OCP Agent processes on a host
      • Restart OCP Agent processes on a host
      • Stop OCP Agent processes on a host
    • SQL performance
      • Query performance indicators of an SQL statement
      • Query the performance indicator trend of an SQL statement
      • Query SQL text
      • Query performance indicators of an execution plan
      • Query the performance indicator trend of an execution plan
      • Query the operator structure of an execution plan
    • Backup and recovery
      • Query backup capabilities of a cluster
      • Create a backup strategy for a cluster
      • Modify the backup strategy of a cluster
      • Delete the backup strategy of a cluster
      • Query the backup strategy of a cluster
      • Query the backup overview of a cluster
      • Query data backup tasks of a cluster
      • Query log backup tasks of a cluster
      • Query recovery tasks of a cluster
      • Immediately back up a cluster
      • Parse cluster backup data
      • Initiate tenant recovery
    • Others
      • Query the basic information of an OCP application
      • Query OCP server time
      • Query OCP application status
    • Appendix
      • Task information
      • View alerts through APIs
  • FAQ
    • FAQ on deployment
    • FAQ on upgrade
    • FAQ on monitoring
      • FAQ on monitoring metrics
      • FAQ on SQL monitoring
      • FAQ about resource usage
    • FAQ on alerts
    • FAQ on O&M
      • FAQ on accounts and passwords
      • FAQ on host management
      • FAQ on OceanBase clusters
      • FAQ on OceanBase tenants
      • FAQ on OBProxy
      • FAQ on the OCP software package
      • FAQ on backup and recovery
    • FAQ on the OCP system
    • OCP multi-cluster FAQ

Download PDF

Document Overview Product updates What is OceanBase Cloud Platform? System architecture Features System requirementsDependencies What is OceanBase Cloud Platform? System architecture Overview Deploy OCP on a single node Deploy OCP clusters in the multi-cluster mode OCP-Server specificationsMetaDB resources MonitorDB resources Host resources Standardize a host Check the environment Prepare installation media Generate a configuration file Multi-zone deploymentDeploy OCP Register an OCP cluster Initialize system parametersCheck after deployment Optimize MonitorDB parameters Ubuntu deployment FAQ EulerOS deployment FAQ Client requirements Start and stop OCP OCP operations Upload a software package Add a host Create a cluster Create a tenant Create a user Create an OBProxy cluster OCP overview Log on to the OceanBase Cloud Platform console Packages Cluster management operationsView the topology of a cluster Cluster tenant management overview Performance monitoring Performance report Cluster resource management Health inspection Cluster backup and recovery Manage cluster parameter templates Tenant management operations View a tenant topology Database management User management under a MySQL tenant Performance monitoring Tenant resource management Back up and recover a tenant Manage tenant parameter templates Host management operations Add a host Modify a host Restart OCP Agent Reinstall OCP Agent Host monitoring Upload a software package Download a software package Delete a software package Create an OBProxy cluster Take over an OBProxy Delete an OBProxy Restart an OBProxy Upgrade an OBProxy Add an OBProxy Refresh OBProxy configurations Monitor OBProxy cluster performance OBProxy cluster parameter management Add a connectable OceanBase clusterDelete an OBProxy cluster Upgrade all OBProxies in an OBProxy cluster Restart all OBProxies in an OBProxy cluster Delete a connected OceanBase cluster Backup and recovery management operations Backup and recovery guide Create a backup strategy Back up now Create a sampling strategy for recovery Initiate a recovery Install a service Add a nodeUpgrade the version of a service Update service configurations Copy a service Delete a service Stop a service on a node Restart a service on a node View operation and maintenance tasks Uninstall a service on a node Alert-related conceptsCreate an alert item View alert items Copy an alert item
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogWhite PaperLive 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 Cloud Platform
  3. V3.2.3
iconOceanBase Cloud Platform
V 3.2.3Enterprise Edition
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.4.2
  • V 4.3.6
  • V 4.3.5
  • V 4.3.4
  • V 4.3.3
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.2
  • V 4.0.0 and earlier

Suspected SQL diagnosis

Last Updated:2023-08-15 11:20:56  Updated
Share
What is on this page
Procedure

folded

Share

Suspected SQL statements are statements that meet some criteria based on the statement, execution history, and table structure and may cause performance issues. You can handle suspected SQL statements based on the recommendation given.

Procedure

  1. In the left-side navigation pane, click Tenants and click a tenant in the Tenants list to go to the Overview page of the tenant.

  2. In the left-side navigation pane, click SQL Diagnosis . The SQL Diagnosis page appears.

    The SQL diagnostic data is not displayed on the SQL Diagnosis page if you do not set the values of both the cluster parameter enable_sql_audit and the tenant parameter ob_enable_sql_audit to True. You can click Change Cluster Parameters in the prompt box to modify the parameter values.

  3. Click the Suspected SQL tab.

  4. Filter the suspected SQL statements.

    1. Specify the filter conditions.

      • Time Range: You can select the last 5 minutes, last 10 minutes, last 20 minutes, last 30 minutes, last 1 hour, and last 3 hours from the drop-down list of the Duration . You can also select Custom Time from the drop-down list and specify the start time and end time as needed. By default, the information of the last 30 minutes is displayed.

      • Internal SQL: If you select this option, the SQL statements internally initiated by OceanBase Database are displayed in the query result.

      • Keywords: The SQL statements that contain the specified keywords are displayed in the query result. The keywords filter SQL statements in the same way as the SQL Like operator. The entered strings are automatically prefixed and suffixed with a percent sign (%).

      • Advanced Search: You can select SQL ID, Executions, and Executions per Second from the drop-down list, and specify the values. The SQL statements matching the metric values are displayed in the query result.

    2. Click Search to list all the SQL statements that meet the filter conditions.

  5. Click Export Suspected SQLs to export all the suspected SQL statements in the query result.

  6. View the information of suspected SQL statements.

    1. On the Suspected SQL tab, you can copy the SQL text, filter it by database, sort it by the number of executions, average CPU time, average response time, total response time, and last execution time, and view the diagnosis result.

    2. You can click the SQL text to go to the corresponding SQL text page.

      On the SQL Details page, you can view the following SQL statement details:

      • In the SQL Text section, you can view the text of the SQL statement.

      • View diagnosis result: You can view the diagnosis result for a specified time range. The following table describes some diagnoses and their suggested solutions.

        Diagnosis
        Related parameter
        Index analysis required
        SQL risk level
        Description and suggestion
        After the execution plan was changed, the performance was decreased. ocp.perf.sql-diag.performance-degradation-after-plan-changed-config No High The execution plan of the SQL statement was changed, and the performance of the new plan was decreased. Check with the DBA. You can use an outline to fix the execution plan to verify whether the SQL statement is problematic.
        Full table scan was performed because some tables had no indexes. ocp.perf.sql-diag.table-scan-index-not-exists-config Yes High During the execution of the SQL statement, a full table scan was performed on some related tables because they did not have indexes available. We recommend that you create appropriate indexes.
        Full table scan was performed because the indexes of some tables were not used. ocp.perf.sql-diag.table-scan-index-not-exists-config Yes High All tables involved in the execution of the SQL statement are indexed. However, a full table scan was performed on some of these tables because their indexes were not used. Check the data distribution and business scenario.
        Hints did not take effect. ocp.perf.sql-diag.ineffective-hint-config Yes High An index was specified in the hint of the SQL statement, but the specified index was not used during execution. Check whether the hint of the SQL statement matches the actual execution plan.
        The performance becomes lower. ocp.perf.sql-diag.performance-degradation-config No Medium During the diagnostic period, the average CPU time consumed for the execution of the SQL statement is longer than the historical average. Check the changes in data distribution and the queue in the tenant.
        Indexes were used but the performance was still low. ocp.perf.sql-diag.awful-performance-index-used-config Yes Medium The index was used for table access during the execution of the SQL statement, but the performance was poor. Check the data distribution and business scenario.
        Execution spikes. ocp.perf.sql-diag.execution-spike-config No Medium The executions of the SQL statement suddenly increased during a certain period. You can view the number of executions in the Historical Trends tab of the SQL Details . Check the business volume. A spike in the number of executions of an SQL statement may cause the overall performance to decrease.
        Row lock contention exists. ocp.perf.sql-diag.row-lock-contention-high-config No Medium Check your business scenarios, whether the SQL statements of the select for update type were executed more frequently than the specified value, and whether the CPU time was greater than the specified value.
        The proportion of CPU time consumed for executing the current SQL is too high. ocp.perf.sql-diag.cpu-time-proportion-high-config No Low The CPU utilization was too high during the diagnostic period. The CPU utilization = CPU time for executing the SQL statement/CPU time for executing all SQL statements of the tenant * 100%. Check your business scenarios, data distribution changes, request increases, and execution plan changes.

        You can search for a parameter from the System Parameters of OCP, and modify the default parameter value to customize the target and criteria for the diagnosis. For more information, see SQL performance module.

      • On the Previous Tendency tab, you can view the historical trends of the SQL statement. For more information, see View the historical trends of an SQL statement.

      • On the Execution Plans tab, you can view the execution plans of the SQL statement, or bind an execution plan to the statement. For more information, see View the execution plan of an SQL statement.

      • On the Index tab, you can view the indexes bound to the SQL statement. For more information, see View and bind indexes.

      • On the SQL Throttling tab, you can view or set throttling of the SQL statement. For more information, see Set SQL throttling.

      • You can view the binding records of the SQL statement in section ① as illustrated on the Execution Plans , Index , and SQL Throttling tabs.

        In a binding record, you can view the status of the bound execution plan, click Unbind to unbind the plan from the SQL statement, and click Bind Plan to bind the plan to the SQL statement again.

Previous topic

Tenant resource management
Last

Next topic

TopSQL diagnosis
Next
What is on this page
Procedure