chore: explain options

Author: radim

regresql/baseline.go

@@ -38,9 +38,33 @@ func getBaselinePath(q *Query, baselineDir string, bindingName string) string {
 	return baselinePath
 }
 
-// ExecuteExplain runs EXPLAIN (FORMAT JSON) for a query and returns the parsed plan
+// ExplainOptions configures EXPLAIN execution
+type ExplainOptions struct {
+	Analyze bool // Execute query and show actual timing/rows (default: false)
+	Buffers bool // Show buffer usage statistics (default: false)
+	Verbose bool // Show additional output (default: false)
+}
+
+// DefaultExplainOptions returns safe defaults (no ANALYZE, no BUFFERS)
+func DefaultExplainOptions() ExplainOptions {
+	return ExplainOptions{
+		Analyze: false,
+		Buffers: false,
+		Verbose: false,
+	}
+}
+
+// ExecuteExplain runs EXPLAIN (FORMAT JSON) with default options (ANALYZE=false)
 func ExecuteExplain(q Querier, query string, args ...any) (*ExplainOutput, error) {
-	explainQuery := fmt.Sprintf("EXPLAIN (FORMAT JSON, ANALYZE false, VERBOSE false, COSTS true, BUFFERS false) %s", query)
+	return ExecuteExplainWithOptions(q, query, DefaultExplainOptions(), args...)
+}
+
+// ExecuteExplainWithOptions runs EXPLAIN (FORMAT JSON) with configurable options
+func ExecuteExplainWithOptions(q Querier, query string, opts ExplainOptions, args ...any) (*ExplainOutput, error) {
+	explainQuery := fmt.Sprintf(
+		"EXPLAIN (FORMAT JSON, ANALYZE %t, VERBOSE %t, COSTS true, BUFFERS %t) %s",
+		opts.Analyze, opts.Verbose, opts.Buffers, query,
+	)
 
 	rows, err := q.Query(explainQuery, args...)
 	if err != nil {