Statement Execution Details of TiDB Dashboard

Click any item in the list to enter the detail page of the SQL statement to view more detailed information. This information includes the following parts:

  • The overview of SQL statements, which includes the SQL template, the SQL template ID, the current time range of displayed SQL executions, the number of execution plans, the database in which the SQL statement is executed, and the fast plan binding feature (area 1 in the following figure).
  • The execution plan list: If a SQL statement has multiple execution plans, this list is displayed. Besides text information of execution plans, TiDB v6.2.0 introduces visual execution plans, through which you can learn each operator of a statement and detailed information more intuitively. You can select different execution plans, and the details of the selected plans are displayed below the list (area 2 in the following figure).
  • Execution detail of plans, which displays the detailed information of the selected execution plans. See Execution plan in details (area 3 in the following figure).

Details

Fast plan binding

Starting from v6.6.0, TiDB introduces the fast plan binding feature. You can quickly bind a SQL statement to a specific execution plan in TiDB Dashboard.

Usage

Bind an execution plan

  1. Click Plan Binding. The Plan Binding dialog box is displayed.

    Fast plan binding - not bound - entry

  2. Select a plan that you want to bind and click Bind.

    Fast plan binding - popup

  3. After the binding is completed, you can see the Bound label.

    Fast plan binding - popup - binding completed

Drop an existing binding

  1. On the page of a SQL statement that has an existing binding, click Plan Binding. The Plan Binding dialog box is displayed.

    Fast plan binding - bound - entry

  2. Click Drop.

    Fast plan binding - popup - bound

  3. After the binding is dropped, you can see the Not bound label.

    Fast plan binding - popup

Limitation

Currently, the fast plan binding feature does not support the following types of SQL statements:

  • Statements that are not SELECT, DELETE, UPDATE, INSERT, or REPLACE
  • Queries with subqueries
  • Queries that access TiFlash
  • Queries that join three or more tables

To use this feature, you must have the SUPER privilege. If you encounter permission issues while using it, refer to TiDB Dashboard User Management to add the necessary privileges.

Execution details of plans

The execution detail of plans includes the following information:

  • SQL sample: The text of a certain SQL statement that is actually executed corresponding to the plan. Any SQL statement that has been executed within the time range might be used as a SQL sample.
  • Execution plan: Complete information about execution plans, displayed in graph and text. For details of the execution plan, see Understand the Query Execution Plan. If multiple execution plans are selected, only (any) one of them is displayed.
  • For basic information, execution time, Coprocessor read, transaction, and slow query of the SQL statement, you can click the corresponding tab titles to switch among different information.

Execution details of plans

Basic Tab

The basic information of a SQL execution includes the table names, index name, execution count, and total latency. The Description column provides detailed description of each field.

Basic information

Time Tab

Click the Time tab, and you can see how long each stage of the execution plan lasts.

Execution time

Coprocessor Read Tab

Click the Coprocessor Read tab, and you can see information related to Coprocessor read.

Coprocessor read

Transaction Tab

Click the Transaction tab, and you can see information related to execution plans and transactions, such as the average number of written keys or the maximum number of written keys.

Transaction

Slow Query Tab

If an execution plan is executed too slowly, you can see its associated slow query records under the Slow Query tab.

Slow Query

The information displayed in this area has the same structure with the slow query page. See TiDB Dashboard Slow Query Page for details.