all: add support for custom Go struct tags

This change adds a new type of override: go_struct_tag.
When provided for a field, it adds that struct tag to the generated code.
The provided struct tag is parsed according to the standard
package reflect rules, and its components are updated independently.
This allows struct tag overrides to be compatible with (and optionally
override) autogenerated json and db struct tags.

Fixes #534

Author: josharian

docs/howto/structs.md

@@ -46,3 +46,7 @@ type Author struct {
 	CreatedAt time.Time `json:"created_at"`
 }
 ```
+
+## More control
+
+See the Type Overrides section of the Configuration File docs for fine-grained control over struct field types and tags.

docs/reference/config.md

@@ -95,6 +95,9 @@ Each override document has the following keys:
   - The PostgreSQL or MySQL type to override. Find the full list of supported types in [postgresql_type.go](https://github.com/kyleconroy/sqlc/blob/main/internal/codegen/golang/postgresql_type.go#L12) or [mysql_type.go](https://github.com/kyleconroy/sqlc/blob/main/internal/codegen/golang/mysql_type.go#L12). Note that for Postgres you must use the pg_catalog prefixed names where available.
 - `go_type`:
   - A fully qualified name to a Go type to use in the generated code.
+- `go_struct_tag`:
+  - A reflect-style struct tag to use in the generated code, e.g. `a:"b" x:"y,z"`.
+    If you want general json/db tags for all fields, use `emit_db_tags` and/or `emit_json_tags` instead.
 - `nullable`:
   - If true, use this type when a column is nullable. Defaults to `false`.
 

internal/cmd/shim.go

@@ -106,6 +106,7 @@ func pluginGoType(o config.Override) *plugin.ParsedGoType {
 		Package:    o.GoPackage,
 		TypeName:   o.GoTypeName,
 		BasicType:  o.GoBasicType,
+		StructTags: o.GoStructTags,
 	}
 }
 

internal/codegen/golang/go_type.go

@@ -5,6 +5,26 @@ import (
 	"github.com/kyleconroy/sqlc/internal/plugin"
 )
 
+func addExtraGoStructTags(tags map[string]string, req *plugin.CodeGenRequest, col *plugin.Column) {
+	for _, oride := range req.Settings.Overrides {
+		if oride.GoType.StructTags == nil {
+			continue
+		}
+		if !sdk.Matches(oride, col.Table, req.Catalog.DefaultSchema) {
+			// Different table.
+			continue
+		}
+		if !sdk.MatchString(oride.ColumnName, col.Name) {
+			// Different column.
+			continue
+		}
+		// Add the extra tags.
+		for k, v := range oride.GoType.StructTags {
+			tags[k] = v
+		}
+	}
+}
+
 func goType(req *plugin.CodeGenRequest, col *plugin.Column) string {
 	// Check if the column's type has been overridden
 	for _, oride := range req.Settings.Overrides {

internal/codegen/golang/result.go

@@ -79,6 +79,7 @@ func buildStructs(req *plugin.CodeGenRequest) []Struct {
 				if req.Settings.Go.EmitJsonTags {
 					tags["json"] = JSONTagName(column.Name, req.Settings)
 				}
+				addExtraGoStructTags(tags, req, column)
 				s.Fields = append(s.Fields, Field{
 					Name:    StructName(column.Name, req.Settings),
 					Type:    goType(req, column),

internal/config/config.go

@@ -159,6 +159,10 @@ type Override struct {
 	// name of the golang type to use, e.g. `github.com/segmentio/ksuid.KSUID`
 	GoType GoType `json:"go_type" yaml:"go_type"`
 
+	// additional Go struct tags to add to this field, in raw Go struct tag form, e.g. `validate:"required" x:"y,z"`
+	// see https://github.com/kyleconroy/sqlc/issues/534
+	GoStructTag GoStructTag `json:"go_struct_tag" yaml:"go_struct_tag"`
+
 	// name of the python type to use, e.g. `mymodule.TypeName`
 	PythonType PythonType `json:"python_type" yaml:"python_type"`
 
@@ -185,6 +189,9 @@ type Override struct {
 	GoPackage    string
 	GoTypeName   string
 	GoBasicType  bool
+
+	// Parsed form of GoStructTag, e.g. {"validate:", "required"}
+	GoStructTags map[string]string
 }
 
 func (o *Override) Matches(n *ast.TableName, defaultSchema string) bool {
@@ -297,6 +304,13 @@ func (o *Override) Parse() (err error) {
 	o.GoTypeName = parsed.TypeName
 	o.GoBasicType = parsed.BasicType
 
+	// validate GoStructTag
+	tags, err := o.GoStructTag.Parse()
+	if err != nil {
+		return err
+	}
+	o.GoStructTags = tags
+
 	return nil
 }
 

internal/config/go_type.go

@@ -22,6 +22,7 @@ type ParsedGoType struct {
 	Package    string
 	TypeName   string
 	BasicType  bool
+	StructTag  string
 }
 
 func (o *GoType) UnmarshalJSON(data []byte) error {
@@ -154,3 +155,31 @@ func (gt GoType) Parse() (*ParsedGoType, error) {
 	}
 	return &o, nil
 }
+
+// GoStructTag is a raw Go struct tag.
+type GoStructTag string
+
+// Parse parses and validates a GoStructTag.
+// The output is in a form convenient for codegen.
+//
+// Sample valid inputs/outputs:
+//
+// In                    Out
+// empty string      {}
+// `a:"b"`           {"a": "b"}
+// `a:"b" x:"y,z"`   {"a": "b", "x": "y,z"}
+func (s GoStructTag) Parse() (map[string]string, error) {
+	m := make(map[string]string)
+	fields := strings.Fields(string(s))
+	for _, f := range fields {
+		k, v, ok := strings.Cut(f, ":")
+		if !ok {
+			return nil, fmt.Errorf("Failed to parse Go struct tag: no colon in field %q", f)
+		}
+		if len(v) < 2 || v[0] != '"' || v[len(v)-1] != '"' {
+			return nil, fmt.Errorf("Failed to parse Go struct tag: missing quotes around value in field %q", f)
+		}
+		m[k] = v[1 : len(v)-1] // trim quotes off of v
+	}
+	return m, nil
+}

internal/endtoend/testdata/overrides_go_struct_tags/invalid_tags/query.sql

@@ -0,0 +1 @@
+SELECT 1;

internal/endtoend/testdata/overrides_go_struct_tags/invalid_tags/schema.sql

@@ -0,0 +1,14 @@
+CREATE TABLE foo (
+    other     text NOT NULL,
+    tagged    text NOT NULL
+);
+
+CREATE TABLE bar (
+    other          text NOT NULL,
+    also_tagged    text NOT NULL
+);
+
+CREATE TABLE baz (
+    other          text NOT NULL,
+    also_tagged    text NOT NULL
+);

internal/endtoend/testdata/overrides_go_struct_tags/invalid_tags/sqlc.json

@@ -0,0 +1,22 @@
+{
+  "version": "1",
+  "packages": [
+    {
+      "path": "go",
+      "name": "override",
+      "engine": "mysql",
+      "schema": "schema.sql",
+      "queries": "query.sql",
+      "overrides": [
+        {
+          "go_struct_tag": "abc",
+          "column": "foo.tagged"
+        },
+        {
+          "go_struct_tag": "a:b",
+          "column": "*.also_tagged"
+        }
+      ]
+    }
+  ]
+}

internal/endtoend/testdata/overrides_go_struct_tags/invalid_tags/stderr.txt

@@ -0,0 +1 @@
+error parsing sqlc.json: Failed to parse Go struct tag: no colon in field "abc"

internal/endtoend/testdata/overrides_go_struct_tags/mysql/go/db.go

@@ -0,0 +1 @@
+SELECT 1;

internal/endtoend/testdata/overrides_go_struct_tags/mysql/go/models.go

@@ -0,0 +1,14 @@
+CREATE TABLE foo (
+    other     text NOT NULL,
+    tagged    text NOT NULL
+);
+
+CREATE TABLE bar (
+    other          text NOT NULL,
+    also_tagged    text NOT NULL
+);
+
+CREATE TABLE baz (
+    other          text NOT NULL,
+    also_tagged    text NOT NULL
+);

internal/endtoend/testdata/overrides_go_struct_tags/mysql/query.sql

@@ -0,0 +1,22 @@
+{
+  "version": "1",
+  "packages": [
+    {
+      "path": "go",
+      "name": "override",
+      "engine": "mysql",
+      "schema": "schema.sql",
+      "queries": "query.sql",
+      "overrides": [
+        {
+          "go_struct_tag": "a:\"b\" x:\"y,z\"",
+          "column": "foo.tagged"
+        },
+        {
+          "go_struct_tag": "also:\"tagged\"",
+          "column": "*.also_tagged"
+        }
+      ]
+    }
+  ]
+}

internal/endtoend/testdata/overrides_go_struct_tags/mysql/schema.sql

@@ -0,0 +1 @@
+SELECT 1;

internal/endtoend/testdata/overrides_go_struct_tags/mysql/sqlc.json

@@ -0,0 +1,13 @@
+CREATE TABLE foo (
+    id       text,
+    other_id text,
+    about    text,
+    other    text
+);
+
+CREATE TABLE bar (
+    id       text,
+    other_id text,
+    about    text,
+    other    text
+);

internal/endtoend/testdata/overrides_go_struct_tags/postgresql/pgx/go/db.go

@@ -0,0 +1,39 @@
+{
+  "version": "1",
+  "packages": [
+    {
+      "path": "go",
+      "engine": "postgresql",
+      "sql_package": "pgx/v4",
+      "name": "override",
+      "schema": "schema.sql",
+      "queries": "query.sql",
+      "overrides": [
+        {
+          "column": "*.id",
+          "go_struct_tag": "type:\"id\""
+        },
+        {
+          "column": "*.*_id",
+          "go_struct_tag": "type:\"other_id\""
+        },
+        {
+          "column": "foo.about",
+          "go_struct_tag": "type:\"about\""
+        },
+        {
+          "column": "foo.id",
+          "go_struct_tag": "source:\"foo\""
+        },
+        {
+          "column": "*.other",
+          "go_struct_tag": "type:\"other\""
+        },
+        {
+          "column": "foo.other",
+          "go_struct_tag": "type:\"this\""
+        }
+      ]
+    }
+  ]
+}