Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

feat: add BigQuery dry run support in SQL Editor (#18079)

Vincent Huang1366352e121e
diff --git a/backend/plugin/db/bigquery/bigquery.go b/backend/plugin/db/bigquery/bigquery.go
index 2e44f4ae27..4db89c31fc 100644
--- a/backend/plugin/db/bigquery/bigquery.go
+++ b/backend/plugin/db/bigquery/bigquery.go
@@ -106,8 +106,9 @@ func (d *Driver) Execute(ctx context.Context, statement string, _ db.ExecuteOpti
// QueryConn queries a SQL statement in a given connection.
func (d *Driver) QueryConn(ctx context.Context, _ *sql.Conn, statement string, queryContext db.QueryContext) ([]*v1pb.QueryResult, error) {
+ // For BigQuery, interpret Explain as dry run (BigQuery doesn't support EXPLAIN)
if queryContext.Explain {
- return nil, errors.New("BigQuery does not support EXPLAIN")
+ return d.dryRunQuery(ctx, statement, queryContext)
}
statements, err := util.SanitizeSQL(statement)
@@ -210,6 +211,91 @@ func (d *Driver) QueryConn(ctx context.Context, _ *sql.Conn, statement string, q
return results, nil
}
+// dryRunQuery performs a dry run validation of the query without executing it.
+// Returns validation status and estimated bytes to be processed.
+func (d *Driver) dryRunQuery(ctx context.Context, statement string, queryContext db.QueryContext) ([]*v1pb.QueryResult, error) {
+ statements, err := util.SanitizeSQL(statement)
+ if err != nil {
+ return nil, err
+ }
+
+ var results []*v1pb.QueryResult
+ for _, stmt := range statements {
+ startTime := time.Now()
+
+ q := d.client.Query(stmt)
+ q.DefaultDatasetID = d.databaseName
+ q.DryRun = true
+
+ if queryContext.OperatorEmail != "" {
+ q.Labels = map[string]string{"operator_email": encodeOperatorEmail(queryContext.OperatorEmail)}
+ }
+
+ job, err := q.Run(ctx)
+ if err != nil {
+ results = append(results, &v1pb.QueryResult{
+ Statement: stmt,
+ Error: err.Error(),
+ Latency: durationpb.New(time.Since(startTime)),
+ })
+ continue
+ }
+
+ // For dry run, the job completes immediately - use Status() instead of Wait()
+ status := job.LastStatus()
+ if status == nil {
+ results = append(results, &v1pb.QueryResult{
+ Statement: stmt,
+ Error: "failed to get job status",
+ Latency: durationpb.New(time.Since(startTime)),
+ })
+ continue
+ }
+
+ if err := status.Err(); err != nil {
+ results = append(results, &v1pb.QueryResult{
+ Statement: stmt,
+ Error: err.Error(),
+ Latency: durationpb.New(time.Since(startTime)),
+ })
+ continue
+ }
+
+ // Extract dry run results
+ result := &v1pb.QueryResult{
+ Statement: stmt,
+ Latency: durationpb.New(time.Since(startTime)),
+ }
+
+ if stats, ok := status.Statistics.Details.(*bigquery.QueryStatistics); ok {
+ bytesProcessed := stats.TotalBytesProcessed
+
+ // Format output similar to bq CLI
+ message := fmt.Sprintf(
+ "Query successfully validated. Assuming the tables are not modified, "+
+ "running this query will process %d bytes (%.2f MB).",
+ bytesProcessed,
+ float64(bytesProcessed)/(1024*1024),
+ )
+
+ result.ColumnNames = []string{"Validation Result"}
+ result.ColumnTypeNames = []string{"STRING"}
+ result.Rows = []*v1pb.QueryRow{
+ {
+ Values: []*v1pb.RowValue{
+ {Kind: &v1pb.RowValue_StringValue{StringValue: message}},
+ },
+ },
+ }
+ result.RowsCount = 1
+ }
+
+ results = append(results, result)
+ }
+
+ return results, nil
+}
+
// encodeOperatorEmail encodes email to valid format of resource label value.
// https://cloud.google.com/compute/docs/labeling-resources#requirements
func encodeOperatorEmail(email string) string {
diff --git a/frontend/src/views/sql-editor/EditorPanel/StandardPanel/SQLEditor.vue b/frontend/src/views/sql-editor/EditorPanel/StandardPanel/SQLEditor.vue
index 47bab1488f..1caf79342d 100644
--- a/frontend/src/views/sql-editor/EditorPanel/StandardPanel/SQLEditor.vue
+++ b/frontend/src/views/sql-editor/EditorPanel/StandardPanel/SQLEditor.vue
@@ -60,6 +60,7 @@ import {
} from "@/store";
import type { SQLDialect, SQLEditorQueryParams } from "@/types";
import { dialectOfEngineV1 } from "@/types";
+import { Engine } from "@/types/proto-es/v1/common_pb";
import {
nextAnimationFrame,
useInstanceV1EditorLanguage,
@@ -213,7 +214,7 @@ const handleEditorReady = (
label: "Run Query",
keybindings: [monaco.KeyMod.CtrlCmd | monaco.KeyCode.Enter],
contextMenuGroupId: "operation",
- contextMenuOrder: 0,
+ contextMenuOrder: 1,
run: () => runQueryAction({ explain: false, newTab: false }),
});
editor.addAction({
@@ -223,7 +224,7 @@ const handleEditorReady = (
monaco.KeyMod.CtrlCmd | monaco.KeyMod.Shift | monaco.KeyCode.Enter,
],
contextMenuGroupId: "operation",
- contextMenuOrder: 0,
+ contextMenuOrder: 1,
run: () => runQueryAction({ explain: false, newTab: true }),
});
editor.addCommand(monaco.KeyMod.CtrlCmd | monaco.KeyCode.KeyS, () => {
@@ -272,11 +273,24 @@ const handleEditorReady = (
watch(
() => instance.value.engine,
() => {
- if (instanceV1AllowsExplain(instance.value)) {
+ const shouldShowAction =
+ instanceV1AllowsExplain(instance.value) ||
+ instance.value.engine === Engine.BIGQUERY;
+
+ if (shouldShowAction) {
+ const isBigQuery = instance.value.engine === Engine.BIGQUERY;
+ const label = isBigQuery ? "Dry Run Query" : "Explain Query";
+
+ // Remove existing action if label changed
+ if (explainQueryAction) {
+ explainQueryAction.dispose();
+ explainQueryAction = undefined;
+ }
+
if (!editor.getAction("ExplainQuery")) {
explainQueryAction = editor.addAction({
id: "ExplainQuery",
- label: "Explain Query",
+ label: label,
keybindings: [monaco.KeyMod.CtrlCmd | monaco.KeyCode.KeyE],
contextMenuGroupId: "operation",
contextMenuOrder: 0,
@@ -285,6 +299,7 @@ const handleEditorReady = (
}
} else {
explainQueryAction?.dispose();
+ explainQueryAction = undefined;
}
},
{ immediate: true }
diff --git a/frontend/src/views/sql-editor/EditorPanel/TerminalPanel/CompactSQLEditor.vue b/frontend/src/views/sql-editor/EditorPanel/TerminalPanel/CompactSQLEditor.vue
index 8f4b7dcc78..b71a5004f7 100644
--- a/frontend/src/views/sql-editor/EditorPanel/TerminalPanel/CompactSQLEditor.vue
+++ b/frontend/src/views/sql-editor/EditorPanel/TerminalPanel/CompactSQLEditor.vue
@@ -49,6 +49,7 @@ import {
} from "@/store";
import type { SQLDialect, SQLEditorQueryParams } from "@/types";
import { dialectOfEngineV1 } from "@/types";
+import { Engine } from "@/types/proto-es/v1/common_pb";
import { useInstanceV1EditorLanguage, instanceV1AllowsExplain } from "@/utils";
import { useSQLEditorContext } from "../../context";
import {
@@ -148,11 +149,24 @@ const handleEditorReady = (_: MonacoModule, editor: IStandaloneCodeEditor) => {
watch(
() => instance.value.engine,
() => {
- if (instanceV1AllowsExplain(instance.value)) {
+ const shouldShowAction =
+ instanceV1AllowsExplain(instance.value) ||
+ instance.value.engine === Engine.BIGQUERY;
+
+ if (shouldShowAction) {
+ const isBigQuery = instance.value.engine === Engine.BIGQUERY;
+ const label = isBigQuery ? "Dry Run Query" : "Explain Query";
+
+ // Remove existing action if label changed
+ if (explainQueryAction) {
+ explainQueryAction.dispose();
+ explainQueryAction = undefined;
+ }
+
if (!editor.getAction("ExplainQuery")) {
explainQueryAction = editor.addAction({
id: "ExplainQuery",
- label: "Explain Query",
+ label: label,
keybindings: [monaco.KeyMod.CtrlCmd | monaco.KeyCode.KeyE],
contextMenuGroupId: "operation",
contextMenuOrder: 1,
@@ -162,6 +176,7 @@ const handleEditorReady = (_: MonacoModule, editor: IStandaloneCodeEditor) => {
}
} else {
explainQueryAction?.dispose();
+ explainQueryAction = undefined;
}
},
{ immediate: true }