feat(print-statements): intercept explain query plan statements

Author: douglasmdev

Diff for: internal/db/output.go

@@ -21,7 +21,8 @@ type TablePrinter struct {
 func (t TablePrinter) print(statementResult StatementResult, outF io.Writer) error {
 	data := [][]string{}
 	table := createTable(outF)
-	if !t.withoutHeader {
+	showHeader := !IsResultComingFromExplainQueryPlan(statementResult) && !t.withoutHeader
+	if showHeader {
 		table.SetHeader(statementResult.ColumnNames)
 	}
 
@@ -100,6 +101,11 @@ func appendData(statementResult StatementResult, data [][]string, mode FormatTyp
 		}
 		data = append(data, formattedRow)
 	}
+
+	if IsResultComingFromExplainQueryPlan(statementResult) {
+		data = [][]string{{"Tree goes here!"}}
+	}
+
 	return data, nil
 }
 

Diff for: internal/db/utils.go

@@ -4,6 +4,8 @@ import (
 	"net/url"
 	"strings"
 	"unicode"
+
+	"golang.org/x/exp/slices"
 )
 
 func IsUrl(uri string) bool {
@@ -45,3 +47,30 @@ func NeedsEscaping(name string) bool {
 	}
 	return false
 }
+
+var explainQueryPlanStatement = "EXPLAIN QUERY PLAN"
+var explainQueryPlanColumnNames = []string{"id", "parent", "notused", "detail"}
+
+func queryContainsExplainQueryPlanStatement(query string) bool {
+	return strings.Contains(query, explainQueryPlanStatement)
+}
+
+func columnNamesMatchExplainQueryPlan(colNames []string) bool {
+	if len(colNames) != len(explainQueryPlanColumnNames) {
+		return false
+	}
+	for _, colName := range explainQueryPlanColumnNames {
+		if !slices.Contains(colNames, colName) {
+			return false
+		}
+	}
+	return true
+}
+
+// "query" can be a string containing multiple queries separated by ";" or a single query
+func IsResultComingFromExplainQueryPlan(statementResult StatementResult) bool {
+	query := statementResult.Query
+	columnNames := statementResult.ColumnNames
+	return queryContainsExplainQueryPlanStatement(query) &&
+		columnNamesMatchExplainQueryPlan(columnNames)
+}

Diff for: test/db_root_command_shell_test.go

@@ -271,6 +271,19 @@ func (s *DBRootCommandShellSuite) Test_GivenATableNameWithSpecialCharacters_When
 	s.tc.AssertSqlEquals(outS, expected)
 }
 
+func (s *DBRootCommandShellSuite) Test_GivenATableNameWithTheSameSignatureAsExpainQueryPlan_WhenChainingItWithExplainQueryPlan_ExpectCorrectData() {
+	_, _, err := s.tc.Execute("CREATE TABLE fake_explain (ID INTEGER PRIMARY KEY, PARENT INTEGER, NOTUSED INTEGER, DETAIL TEXT)")
+	s.tc.Assert(err, qt.IsNil)
+
+	outS, errS, err := s.tc.ExecuteShell([]string{"SELECT * FROM fake_explain; EXPLAIN QUERY PLAN SELECT 1;"})
+	s.tc.Assert(err, qt.IsNil)
+	s.tc.Assert(errS, qt.Equals, "")
+
+	expected := "id     parent     notused     detail \ntree goes here!"
+
+	s.tc.AssertSqlEquals(outS, expected)
+}
+
 func (s *DBRootCommandShellSuite) Test_GivenATableWithRecordsWithSingleQuote_WhenCalllSelectAllFromTable_ExpectSingleQuoteScape() {
 	s.tc.CreateEmptySimpleTable("t")
 	_, errS, err := s.tc.Execute("INSERT INTO t VALUES (0, \"x'x\", 0)")