View outlines

On the Outlines page, you can view the outlines of an OceanBase Database tenant, including the outlines for throttling, execution plan binding, and index binding.

Features

The outline feature relies on the hint and plan cache features of OceanBase Database. The hint feature determines the selection of the physical plan generation path by specifying the index and the connection method. The plan cache caches physical plans for SQL statements. When the same SQL statement is executed again in the same environment, the system reads its execution plan from the plan cache. It does not have to go through the parser, resolver, rewriter, and optimizer modules again. This speeds up the execution of SQL statements. The outline feature uses hints to specify how to fix plans by modifying the physical execution plan in the plan cache.

Prerequisites

• Make sure that you have the following permissions:

  • Resource Permissions : Cluster Read-only or Tenant Read-only permission
  • Menu Permissions : Permission on the SQL Diagnostics menu of Tenants

• For a tenant in MySQL mode, the password box of the OceanBase Cloud Platform (OCP) user must contain the password of the tenant.

• For a tenant in Oracle mode, the password box of the OCP user must contain the password of the SYS tenant in the cluster.

  Note

  To bind indexes and execution plans and configure throttling, the logged-on tenant in the OCP console must have the permission to update the tenant .

Procedure

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

2. In the left-side navigation pane, click SQL Diagnostics to go to the SQL Diagnostics page.

   

3. Click View Outlines in the upper-right corner.

   The Outlines page that displays valid outlines automatically appears. You can perform the following operations on this page:

   • Click Disable Throttling or Unbind in the Actions column.

   • Click a value in the SQL ID/Text column to go to the details page of the corresponding SQL statement. For more information about the operations that you can perform on the SQL Details page, see View SQL statement details.

   

4. Click the All tab, and you can view information of all outlines that were created or deleted in OCP in the past 30 days.

5. Click Export Valid Outlines in the upper-right corner to export all columns except the Actions column on the page to an Excel file.