Add VEXPLAIN KEYS for improved sharding key selection (#16830)

Signed-off-by: Andres Taylor <[email protected]>

changelog/21.0/21.0.0/summary.md

@@ -17,6 +17,7 @@
     - **[New Backup Engine](#new-backup-engine)**
     - **[Dynamic VReplication Configuration](#dynamic-vreplication-configuration)**
     - **[Reference Table Materialization](#reference-table-materialization)**
+    - **[New VEXPLAIN Modes: TRACE and KEYS](#new-vexplain-modes)**
 
 ## <a id="major-changes"/>Major Changes
 
@@ -172,3 +173,27 @@ There is a new option in [`Materialize` workflows](https://vitess.io/docs/refere
 a synced copy of [reference or lookup tables](https://vitess.io/docs/reference/vreplication/reference_tables/) 
 (countries, states, zip_codes, etc) from an unsharded keyspace, which holds the source of truth for the reference 
 table, to all shards in a sharded keyspace.
+### <a id="new-vexplain-modes"/>New VEXPLAIN Modes: TRACE and KEYS
+
+#### VEXPLAIN TRACE
+
+The new TRACE mode for VEXPLAIN provides a detailed execution trace of queries, showing how they're processed through various operators and interactions with tablets. This mode is particularly useful for:
+
+- Identifying performance bottlenecks
+- Understanding query execution patterns
+- Optimizing complex queries
+- Debugging unexpected query behavior
+
+TRACE mode runs the query and logs all interactions, returning a JSON representation of the query execution plan with additional statistics like number of calls, average rows processed, and number of shards queried.
+
+#### VEXPLAIN KEYS
+
+The KEYS mode for VEXPLAIN offers a concise summary of query structure, highlighting columns used in joins, filters, and grouping operations. This information is crucial for:
+
+- Identifying potential sharding key candidates
+- Optimizing query performance
+- Analyzing query patterns to inform database design decisions
+
+KEYS mode analyzes the query structure without executing it, providing JSON output that includes grouping columns, join columns, filter columns (potential candidates for indexes, primary keys, or sharding keys), and the statement type.
+
+These new VEXPLAIN modes enhance Vitess's query analysis capabilities, allowing for more informed decisions about sharding strategies and query optimization.

go/vt/sqlparser/ast_funcs.go

@@ -1925,6 +1925,8 @@ func (ty VExplainType) ToString() string {
 		return AllVExplainStr
 	case TraceVExplainType:
 		return TraceStr
+	case KeysVExplainType:
+		return KeysStr
 	default:
 		return "Unknown VExplainType"
 	}

go/vt/sqlparser/constants.go

@@ -277,6 +277,7 @@ const (
 	AllVExplainStr = "all"
 	PlanStr        = "plan"
 	TraceStr       = "trace"
+	KeysStr        = "keys"
 
 	// Lock Types
 	ReadStr             = "read"
@@ -848,6 +849,7 @@ const (
 	PlanVExplainType
 	AllVExplainType
 	TraceVExplainType
+	KeysVExplainType
 )
 
 // Constant for Enum Type - SelectIntoType

go/vt/sqlparser/parse_test.go

@@ -2574,8 +2574,9 @@ var (
 		input:  "vexplain select * from t",
 		output: "vexplain plan select * from t",
 	}, {
-		input:  "vexplain trace select * from t",
-		output: "vexplain trace select * from t",
+		input: "vexplain trace select * from t",
+	}, {
+		input: "vexplain keys select * from t",
 	}, {
 		input: "explain analyze select * from t",
 	}, {