planner: support EXPLAIN ANALYZE FORMAT='ru' (#70371)

ref #70373

Author: qw4990

pkg/executor/explain_test.go

@@ -186,6 +186,22 @@ func checkActRows(t *testing.T, tk *testkit.TestKit, sql string, expected []stri
 	}
 }
 
+func checkAnalyzeRUFormat(t *testing.T, tk *testkit.TestKit, sql string, expectedActRows []string) {
+	t.Helper()
+	rows := tk.MustQuery("explain analyze format = 'ru' " + sql).Rows()
+	require.Equal(t, len(expectedActRows), len(rows))
+	for id, row := range rows {
+		require.Len(t, row, 7)
+		require.NotEmpty(t, row[0])
+		require.NotEmpty(t, row[1])
+		require.Equal(t, expectedActRows[id], row[2], fmt.Sprintf("error comparing %s", sql))
+		require.Equal(t, "", row[3])
+		require.Equal(t, "", row[4])
+		require.Equal(t, "", row[5])
+		require.Equal(t, "", row[6])
+	}
+}
+
 func TestCheckActRowsWithUnistore(t *testing.T) {
 	defer config.RestoreFunc()()
 	config.UpdateGlobal(func(conf *config.Config) {
@@ -260,6 +276,9 @@ func TestCheckActRowsWithUnistore(t *testing.T) {
 	for _, test := range tests {
 		checkActRows(t, tk, test.sql, test.expected)
 	}
+
+	checkAnalyzeRUFormat(t, tk, "select * from t_unistore_act_rows", []string{"4", "4"})
+	checkAnalyzeRUFormat(t, tk, "select * from t_unistore_act_rows where b > 0", []string{"1", "1", "4"})
 }
 
 func TestExplainAnalyzeCTEMemoryAndDiskInfo(t *testing.T) {
@@ -496,6 +515,7 @@ func TestExplainFormatInCtx(t *testing.T) {
 		types.ExplainFormatTiDBJSON,
 		types.ExplainFormatCostTrace,
 		types.ExplainFormatPlanCache,
+		types.ExplainFormatRU,
 	}
 
 	tk.MustExec("select * from t")

pkg/parser/parser.go

@@ -6070,6 +6070,7 @@ ExplainFormatType:
 |	"VERBOSE"
 |	"TRUE_CARD_COST"
 |	"TIDB_JSON"
+|	"RU"
 
 SavepointStmt:
 	"SAVEPOINT" Identifier

pkg/parser/parser.y

@@ -735,6 +735,9 @@ func (e *Explain) prepareSchema() error {
 		fieldNames = []string{"binary plan"}
 	case format == types.ExplainFormatTiDBJSON:
 		fieldNames = []string{"TiDB_JSON"}
+	case format == types.ExplainFormatRU:
+		// TODO: Populate RU-specific columns after per-operator RU attribution is available.
+		fieldNames = []string{"id", "task", "actRows", "selfRU", "cumRU", "cumRU%", "detail"}
 	case e.Explore:
 		fieldNames = []string{"statement", "binding_hint", "plan", "plan_digest", "avg_latency", "exec_times", "avg_scan_rows",
 			"avg_returned_rows", "latency_per_returned_row", "scan_rows_per_returned_row", "recommend", "reason",
@@ -932,6 +935,9 @@ func (e *Explain) RenderResult() error {
 			return err
 		}
 		e.Rows = append(e.Rows, []string{str})
+	case types.ExplainFormatRU:
+		flat := FlattenPhysicalPlan(e.TargetPlan, true)
+		e.Rows = ExplainFlatPlanInRUFormat(flat, e.RuntimeStatsColl)
 	default:
 		return errors.Errorf("explain format '%s' is not supported now", e.Format)
 	}
@@ -1106,6 +1112,38 @@ func prepareOperatorInfo(flatOp *FlatOperator, format string, analyze bool,
 	return append(rows, row)
 }
 
+// ExplainFlatPlanInRUFormat returns the explain analyze result with RU columns.
+func ExplainFlatPlanInRUFormat(flat *FlatPhysicalPlan, runtimeStatsColl *execdetails.RuntimeStatsColl) (rows [][]string) {
+	if flat == nil || len(flat.Main) == 0 || flat.InExplain {
+		return
+	}
+	for _, flatOp := range flat.Main {
+		rows = prepareRUOperatorInfo(flatOp, runtimeStatsColl, rows)
+	}
+	for _, cte := range flat.CTEs {
+		for _, flatOp := range cte {
+			rows = prepareRUOperatorInfo(flatOp, runtimeStatsColl, rows)
+		}
+	}
+	for _, subQ := range flat.ScalarSubQueries {
+		for _, flatOp := range subQ {
+			rows = prepareRUOperatorInfo(flatOp, runtimeStatsColl, rows)
+		}
+	}
+	return
+}
+
+func prepareRUOperatorInfo(flatOp *FlatOperator, runtimeStatsColl *execdetails.RuntimeStatsColl, rows [][]string) [][]string {
+	p := flatOp.Origin
+	if p.ExplainID().String() == "_0" {
+		return rows
+	}
+	taskType, id := getExplainIDAndTaskTp(flatOp)
+	actRows, _, _, _ := getRuntimeInfoStr(p.SCtx(), p, runtimeStatsColl)
+	// TODO: Replace the empty RU columns with real selfRU, cumRU, cumRU%, and detail values.
+	return append(rows, []string{id, taskType, actRows, "", "", "", ""})
+}
+
 func (e *Explain) prepareOperatorInfoForJSONFormat(p base.Plan, taskType, explainID string) *ExplainInfoForEncode {
 	if p.ExplainID().String() == "_0" {
 		return nil

pkg/planner/core/common_plans.go

@@ -5718,6 +5718,9 @@ func (b *PlanBuilder) buildExplainPlan(targetPlan base.Plan, format string, expl
 	if format == types.ExplainFormatTrueCardCost && !analyze {
 		return nil, errors.Errorf("'explain format=%v' cannot work without 'analyze', please use 'explain analyze format=%v'", format, format)
 	}
+	if format == types.ExplainFormatRU && !analyze {
+		return nil, errors.Errorf("'explain format=%v' cannot work without 'analyze', please use 'explain analyze format=%v'", format, format)
+	}
 
 	p := &Explain{
 		TargetPlan:       targetPlan,

pkg/planner/core/planbuilder.go

@@ -41,6 +41,8 @@ var (
 	ExplainFormatPlanCache = "plan_cache"
 	// ExplainFormatPlanTree displays the plan in a tree structure format
 	ExplainFormatPlanTree = "plan_tree"
+	// ExplainFormatRU is reserved for RU cost output in explain analyze.
+	ExplainFormatRU = "ru"
 
 	// ExplainFormats stores the valid formats for explain statement, used by validator.
 	ExplainFormats = []string{
@@ -57,5 +59,6 @@ var (
 		ExplainFormatCostTrace,
 		ExplainFormatPlanCache,
 		ExplainFormatPlanTree,
+		ExplainFormatRU,
 	}
 )