feat: add query metadata comments

Author: DerekTBrown

docs/reference/config.md

@@ -42,6 +42,13 @@ Each mapping in the `sql` collection has the following keys:
   - Directory of SQL migrations or path to single SQL file; or a list of paths.
 - `queries`:
   - Directory of SQL queries or path to single SQL file; or a list of paths.
+- `query_comments`:
+  - If enabled, prepend generated SQL text with a structured block comment using query metadata.
+    Built-in generators include the comment in generated query strings. Supported formats are
+    `sqlcommenter` and `marginalia`. Supported tags are `name`, `cmd`, and `filename`.
+    Defaults to `format: sqlcommenter` and `tags: ["name"]`. These comments make generated
+    queries easier to trace in database logs, APM tools, database monitoring products, and
+    distributed tracing systems.
 - `codegen`:
   - A collection of mappings to configure code generators. See [codegen](#codegen) for the supported keys.
 - `gen`:
@@ -116,6 +123,45 @@ sql:
       out: postgresql
 ```
 
+### query_comments
+
+The `query_comments` mapping supports the following keys:
+
+- `enabled`:
+  - If true, prepend generated SQL query text with a structured comment derived from query metadata.
+    Defaults to `false`.
+- `format`:
+  - Either `sqlcommenter` or `marginalia`. Defaults to `sqlcommenter`.
+- `tags`:
+  - Query metadata tags to include in the comment. Supported values are `name`, `cmd`, and
+    `filename`. Defaults to `["name"]`.
+
+```yaml
+version: '2'
+sql:
+- schema: schema.sql
+  queries: query.sql
+  engine: postgresql
+  query_comments:
+    enabled: true
+    format: sqlcommenter
+    tags:
+      - name
+      - cmd
+      - filename
+  gen:
+    go:
+      package: authors
+      out: postgresql
+```
+
+Query comments are useful when you need to connect an expensive query sample, slow query,
+or database log entry back to the generated query that produced it. Tools and ecosystems
+that understand or generate these SQL comment formats include Datadog Database Monitoring,
+OpenTelemetry sqlcommenter libraries, Prisma ORM sql comments, and Rails applications using
+Marginalia. Other observability products that consume OpenTelemetry data or preserve SQL
+comments in query logs can also use this metadata for correlation.
+
 ### analyzer
 
 The `analyzer` mapping supports the following keys:

internal/cmd/generate.go

@@ -339,6 +339,7 @@ func codegen(ctx context.Context, combo config.CombinedSettings, sql OutputPair,
 
 	case sql.Gen.Go != nil:
 		out = combo.Go.Out
+		applyQueryComments(req, combo.Package.QueryComments)
 		handler = ext.HandleFunc(golang.Generate)
 		opts, err := json.Marshal(sql.Gen.Go)
 		if err != nil {
@@ -356,6 +357,7 @@ func codegen(ctx context.Context, combo config.CombinedSettings, sql OutputPair,
 
 	case sql.Gen.JSON != nil:
 		out = combo.JSON.Out
+		applyQueryComments(req, combo.Package.QueryComments)
 		handler = ext.HandleFunc(genjson.Generate)
 		opts, err := json.Marshal(sql.Gen.JSON)
 		if err != nil {

internal/cmd/query_comments.go

@@ -0,0 +1,77 @@
+package cmd
+
+import (
+	"strings"
+
+	"github.com/sqlc-dev/sqlc/internal/config"
+	"github.com/sqlc-dev/sqlc/internal/plugin"
+)
+
+const (
+	queryCommentFormatMarginalia   = "marginalia"
+	queryCommentFormatSQLCommenter = "sqlcommenter"
+)
+
+func applyQueryComments(req *plugin.GenerateRequest, opts config.QueryComments) {
+	if !opts.Enabled {
+		return
+	}
+	for _, query := range req.Queries {
+		if query.Text == "" {
+			continue
+		}
+		comment := queryComment(query, opts)
+		if comment == "" {
+			continue
+		}
+		query.Text = comment + " " + query.Text
+	}
+}
+
+func queryComment(query *plugin.Query, opts config.QueryComments) string {
+	tags := opts.Tags
+	if len(tags) == 0 {
+		tags = []string{"name"}
+	}
+
+	parts := make([]string, 0, len(tags))
+	for _, tag := range tags {
+		value := queryCommentValue(query, tag)
+		if value == "" {
+			continue
+		}
+		key := "sqlc_" + tag
+		if opts.Format == queryCommentFormatMarginalia {
+			parts = append(parts, key+":"+escapeQueryCommentValue(value))
+		} else {
+			parts = append(parts, key+"='"+escapeQueryCommentValue(value)+"'")
+		}
+	}
+	if len(parts) == 0 {
+		return ""
+	}
+	return "/*" + strings.Join(parts, ",") + "*/"
+}
+
+func queryCommentValue(query *plugin.Query, tag string) string {
+	switch tag {
+	case "name":
+		return query.Name
+	case "cmd":
+		return query.Cmd
+	case "filename":
+		return query.Filename
+	default:
+		return ""
+	}
+}
+
+func escapeQueryCommentValue(value string) string {
+	value = strings.ReplaceAll(value, "*/", "* /")
+	value = strings.ReplaceAll(value, "\n", " ")
+	value = strings.ReplaceAll(value, "\r", " ")
+	value = strings.ReplaceAll(value, "'", "%27")
+	value = strings.ReplaceAll(value, ",", "%2C")
+	value = strings.ReplaceAll(value, ":", "%3A")
+	return value
+}

internal/cmd/query_comments_test.go

@@ -0,0 +1,62 @@
+package cmd
+
+import (
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+
+	"github.com/sqlc-dev/sqlc/internal/config"
+	"github.com/sqlc-dev/sqlc/internal/plugin"
+)
+
+func TestApplyQueryComments(t *testing.T) {
+	req := &plugin.GenerateRequest{
+		Queries: []*plugin.Query{
+			{
+				Name:     "GetAuthor",
+				Cmd:      ":one",
+				Filename: "query.sql",
+				Text:     "SELECT * FROM authors WHERE id = $1",
+			},
+		},
+	}
+
+	applyQueryComments(req, config.QueryComments{
+		Enabled: true,
+		Tags:    []string{"name", "cmd", "filename"},
+	})
+
+	want := "/*sqlc_name='GetAuthor',sqlc_cmd='%3Aone',sqlc_filename='query.sql'*/ SELECT * FROM authors WHERE id = $1"
+	if diff := cmp.Diff(want, req.Queries[0].Text); diff != "" {
+		t.Errorf("query text differed (-want +got):\n%s", diff)
+	}
+}
+
+func TestApplyQueryCommentsMarginalia(t *testing.T) {
+	req := &plugin.GenerateRequest{
+		Queries: []*plugin.Query{
+			{
+				Name: "GetAuthor",
+				Text: "SELECT * FROM authors WHERE id = $1",
+			},
+		},
+	}
+
+	applyQueryComments(req, config.QueryComments{
+		Enabled: true,
+		Format:  "marginalia",
+	})
+
+	want := "/*sqlc_name:GetAuthor*/ SELECT * FROM authors WHERE id = $1"
+	if diff := cmp.Diff(want, req.Queries[0].Text); diff != "" {
+		t.Errorf("query text differed (-want +got):\n%s", diff)
+	}
+}
+
+func TestEscapeQueryCommentValue(t *testing.T) {
+	got := escapeQueryCommentValue("a'b,c:d\n*/")
+	want := "a%27b%2Cc%3Ad * /"
+	if diff := cmp.Diff(want, got); diff != "" {
+		t.Errorf("escaped value differed (-want +got):\n%s", diff)
+	}
+}

internal/codegen/golang/query.go

@@ -273,6 +273,7 @@ type Query struct {
 	MethodName   string
 	FieldName    string
 	ConstantName string
+	SQLComment   string
 	SQL          string
 	SourceName   string
 	Ret          QueryValue

internal/codegen/golang/result.go

@@ -217,13 +217,16 @@ func buildQueries(req *plugin.GenerateRequest, options *opts.Options, enums []En
 			}
 		}
 
+		sqlComment, sql := splitSQLComment(query.Text)
+
 		gq := Query{
 			Cmd:          query.Cmd,
 			ConstantName: constantName,
 			FieldName:    sdk.LowerTitle(query.Name) + "Stmt",
 			MethodName:   query.Name,
 			SourceName:   query.Filename,
-			SQL:          query.Text,
+			SQLComment:   sqlComment,
+			SQL:          sql,
 			Comments:     comments,
 			Table:        query.InsertIntoTable,
 		}
@@ -354,6 +357,17 @@ func buildQueries(req *plugin.GenerateRequest, options *opts.Options, enums []En
 	return qs, nil
 }
 
+func splitSQLComment(sql string) (string, string) {
+	if !strings.HasPrefix(sql, "/*sqlc_") {
+		return "", sql
+	}
+	idx := strings.Index(sql, "*/")
+	if idx == -1 {
+		return "", sql
+	}
+	return sql[:idx+2], strings.TrimLeft(sql[idx+2:], " \t\r\n")
+}
+
 var cmdReturnsData = map[string]struct{}{
 	metadata.CmdBatchMany: {},
 	metadata.CmdBatchOne:  {},

internal/codegen/golang/result_test.go

@@ -3,6 +3,8 @@ package golang
 import (
 	"testing"
 
+	"github.com/google/go-cmp/cmp"
+
 	"github.com/sqlc-dev/sqlc/internal/metadata"
 	"github.com/sqlc-dev/sqlc/internal/plugin"
 )
@@ -76,3 +78,23 @@ func TestPutOutColumns_AlwaysTrueWhenQueryHasColumns(t *testing.T) {
 		t.Error("should be true when we have columns")
 	}
 }
+
+func TestSplitSQLComment(t *testing.T) {
+	comment, sql := splitSQLComment("/*sqlc_name='GetAuthor'*/ SELECT 1")
+	if diff := cmp.Diff("/*sqlc_name='GetAuthor'*/", comment); diff != "" {
+		t.Errorf("comment differed (-want +got):\n%s", diff)
+	}
+	if diff := cmp.Diff("SELECT 1", sql); diff != "" {
+		t.Errorf("sql differed (-want +got):\n%s", diff)
+	}
+}
+
+func TestSplitSQLCommentIgnoresOtherComments(t *testing.T) {
+	comment, sql := splitSQLComment("/*application='api'*/ SELECT 1")
+	if comment != "" {
+		t.Errorf("expected empty comment, got %q", comment)
+	}
+	if diff := cmp.Diff("/*application='api'*/ SELECT 1", sql); diff != "" {
+		t.Errorf("sql differed (-want +got):\n%s", diff)
+	}
+}

internal/codegen/golang/templates/pgx/batchCode.tmpl

@@ -6,7 +6,8 @@ var (
 
 {{range .GoQueries}}
 {{if eq (hasPrefix .Cmd ":batch") true }}
-const {{.ConstantName}} = {{$.Q}}-- name: {{.MethodName}} {{.Cmd}}
+const {{.ConstantName}} = {{$.Q}}{{if .SQLComment}}{{.SQLComment}}
+{{end}}-- name: {{.MethodName}} {{.Cmd}}
 {{escape .SQL}}
 {{$.Q}}
 

internal/codegen/golang/templates/pgx/queryCode.tmpl

@@ -2,7 +2,8 @@
 {{range .GoQueries}}
 {{if $.OutputQuery .SourceName}}
 {{if and (ne .Cmd ":copyfrom") (ne (hasPrefix .Cmd ":batch") true)}}
-const {{.ConstantName}} = {{$.Q}}-- name: {{.MethodName}} {{.Cmd}}
+const {{.ConstantName}} = {{$.Q}}{{if .SQLComment}}{{.SQLComment}}
+{{end}}-- name: {{.MethodName}} {{.Cmd}}
 {{escape .SQL}}
 {{$.Q}}
 {{end}}

internal/codegen/golang/templates/stdlib/queryCode.tmpl

@@ -1,7 +1,8 @@
 {{define "queryCodeStd"}}
 {{range .GoQueries}}
 {{if $.OutputQuery .SourceName}}
-const {{.ConstantName}} = {{$.Q}}-- name: {{.MethodName}} {{.Cmd}}
+const {{.ConstantName}} = {{$.Q}}{{if .SQLComment}}{{.SQLComment}}
+{{end}}-- name: {{.MethodName}} {{.Cmd}}
 {{escape .SQL}}
 {{$.Q}}