Merge branch 'main' into feat/NullableEnums

Author: sbres

docs/reference/config.md

@@ -20,6 +20,8 @@ packages:
     emit_result_struct_pointers: false
     emit_params_struct_pointers: false
     emit_methods_with_db_argument: false
+    emit_enum_valid_method: false
+    emit_all_enum_values: false
     json_tags_case_style: "camel"
     output_db_file_name: "db.go"
     output_models_file_name: "models.go"
@@ -60,6 +62,12 @@ Each package document has the following keys:
   - If true, parameters are passed as pointers to structs. Defaults to `false`.
 - `emit_methods_with_db_argument`:
   - If true, generated methods will accept a DBTX argument instead of storing a DBTX on the `*Queries` struct. Defaults to `false`.
+- `emit_enum_valid_method`:
+  - If true, generate a Valid method on enum types,
+    indicating whether a string is a valid enum value.
+- `emit_all_enum_values`:
+  - If true, emit a function per enum type
+    that returns all valid enum values.
 - `json_tags_case_style`:
   - `camel` for camelCase, `pascal` for PascalCase, `snake` for snake_case or `none` to use the column name in the DB. Defaults to `none`.
 - `output_db_file_name`:
@@ -106,7 +114,7 @@ packages: [...]
 overrides:
   - db_type: "uuid"
     go_type:
-    - import: "a/b/v2"
+      import: "a/b/v2"
       package: "b"
       type: "MyType"
       pointer: false # or true

go.mod

@@ -10,7 +10,7 @@ require (
 	github.com/jackc/pgconn v1.12.1
 	github.com/jackc/pgx/v4 v4.16.1
 	github.com/jinzhu/inflection v1.0.0
-	github.com/lib/pq v1.10.5
+	github.com/lib/pq v1.10.6
 	github.com/pganalyze/pg_query_go/v2 v2.1.0
 	github.com/pingcap/parser v0.0.0-20210914110036-002913dd28ec
 	github.com/spf13/cobra v1.4.0

go.sum

@@ -112,8 +112,8 @@ github.com/lib/pq v1.0.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo=
 github.com/lib/pq v1.1.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo=
 github.com/lib/pq v1.2.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo=
 github.com/lib/pq v1.10.2/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
-github.com/lib/pq v1.10.5 h1:J+gdV2cUmX7ZqL2B0lFcW0m+egaHC2V3lpO8nWxyYiQ=
-github.com/lib/pq v1.10.5/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
+github.com/lib/pq v1.10.6 h1:jbk+ZieJ0D7EVGJYpL9QTz7/YW6UHbmdnZWYyK5cdBs=
+github.com/lib/pq v1.10.6/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
 github.com/mattn/go-colorable v0.1.1/go.mod h1:FuOcm+DKB9mbwrcAfNl7/TZVBZ6rcnceauSikq3lYCQ=
 github.com/mattn/go-colorable v0.1.6/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
 github.com/mattn/go-isatty v0.0.5/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=

internal/cmd/shim.go

@@ -86,6 +86,8 @@ func pluginGoCode(s config.SQLGo) *plugin.GoCode {
 		EmitResultStructPointers:  s.EmitResultStructPointers,
 		EmitParamsStructPointers:  s.EmitParamsStructPointers,
 		EmitMethodsWithDbArgument: s.EmitMethodsWithDBArgument,
+		EmitEnumValidMethod:       s.EmitEnumValidMethod,
+		EmitAllEnumValues:         s.EmitAllEnumValues,
 		JsonTagsCaseStyle:         s.JSONTagsCaseStyle,
 		Package:                   s.Package,
 		Out:                       s.Out,

internal/codegen/golang/gen.go

@@ -32,6 +32,8 @@ type tmplCtx struct {
 	EmitInterface             bool
 	EmitEmptySlices           bool
 	EmitMethodsWithDBArgument bool
+	EmitEnumValidMethod       bool
+	EmitAllEnumValues         bool
 	UsesCopyFrom              bool
 	UsesBatch                 bool
 }
@@ -84,6 +86,8 @@ func generate(req *plugin.CodeGenRequest, enums []Enum, structs []Struct, querie
 		EmitPreparedQueries:       golang.EmitPreparedQueries,
 		EmitEmptySlices:           golang.EmitEmptySlices,
 		EmitMethodsWithDBArgument: golang.EmitMethodsWithDbArgument,
+		EmitEnumValidMethod:       golang.EmitEnumValidMethod,
+		EmitAllEnumValues:         golang.EmitAllEnumValues,
 		UsesCopyFrom:              usesCopyFrom(queries),
 		UsesBatch:                 usesBatch(queries),
 		SQLPackage:                SQLPackageFromString(golang.SqlPackage),

internal/codegen/golang/imports.go

@@ -376,11 +376,14 @@ func (i *importer) queryImports(filename string) fileImports {
 }
 
 func (i *importer) copyfromImports() fileImports {
-	std, pkg := buildImports(i.Settings, i.Queries, func(name string) bool {
-		for _, q := range i.Queries {
-			if q.Cmd != metadata.CmdCopyFrom {
-				continue
-			}
+	copyFromQueries := make([]Query, 0, len(i.Queries))
+	for _, q := range i.Queries {
+		if q.Cmd == metadata.CmdCopyFrom {
+			copyFromQueries = append(copyFromQueries, q)
+		}
+	}
+	std, pkg := buildImports(i.Settings, copyFromQueries, func(name string) bool {
+		for _, q := range copyFromQueries {
 			if q.hasRetType() {
 				if strings.HasPrefix(q.Ret.Type(), name) {
 					return true

internal/codegen/golang/templates/template.tmpl

@@ -87,6 +87,23 @@ func (e *{{.Name}}) Scan(src interface{}) error {
 	return nil
 }
 
+{{ if $.EmitEnumValidMethod }}
+func (e {{.Name}}) Valid() bool {
+  switch e {
+  case {{ range $idx, $name := .Constants }}{{ if ne $idx 0 }},{{ "\n" }}{{ end }}{{ .Name }}{{ end }}:
+    return true
+  }
+  return false
+}
+{{ end }}
+
+{{ if $.EmitAllEnumValues }}
+func All{{ .Name }}Values() []{{ .Name }} {
+	return []{{ .Name }}{ {{ range .Constants}}{{ "\n" }}{{ .Name }},{{ end }}
+	}
+}
+{{ end }}
+
 type Null{{.Name}} struct {
 	{{.Name}} {{.Name}}
 	Valid  bool // Valid is true if String is not NULL
@@ -109,7 +126,6 @@ func (ns Null{{.Name}}) Value() (driver.Value, error) {
 	}
 	return ns.{{.Name}}, nil
 }
-
 {{end}}
 
 {{range .Structs}}

internal/config/config.go

@@ -128,6 +128,8 @@ type SQLGo struct {
 	EmitResultStructPointers  bool              `json:"emit_result_struct_pointers" yaml:"emit_result_struct_pointers"`
 	EmitParamsStructPointers  bool              `json:"emit_params_struct_pointers" yaml:"emit_params_struct_pointers"`
 	EmitMethodsWithDBArgument bool              `json:"emit_methods_with_db_argument,omitempty" yaml:"emit_methods_with_db_argument"`
+	EmitEnumValidMethod       bool              `json:"emit_enum_valid_method,omitempty" yaml:"emit_enum_valid_method"`
+	EmitAllEnumValues         bool              `json:"emit_all_enum_values,omitempty" yaml:"emit_all_enum_values"`
 	JSONTagsCaseStyle         string            `json:"json_tags_case_style,omitempty" yaml:"json_tags_case_style"`
 	Package                   string            `json:"package" yaml:"package"`
 	Out                       string            `json:"out" yaml:"out"`

internal/config/v_one.go

@@ -32,6 +32,8 @@ type v1PackageSettings struct {
 	EmitResultStructPointers  bool       `json:"emit_result_struct_pointers" yaml:"emit_result_struct_pointers"`
 	EmitParamsStructPointers  bool       `json:"emit_params_struct_pointers" yaml:"emit_params_struct_pointers"`
 	EmitMethodsWithDBArgument bool       `json:"emit_methods_with_db_argument" yaml:"emit_methods_with_db_argument"`
+	EmitEnumValidMethod       bool       `json:"emit_enum_valid_method,omitempty" yaml:"emit_enum_valid_method"`
+	EmitAllEnumValues         bool       `json:"emit_all_enum_values,omitempty" yaml:"emit_all_enum_values"`
 	JSONTagsCaseStyle         string     `json:"json_tags_case_style,omitempty" yaml:"json_tags_case_style"`
 	SQLPackage                string     `json:"sql_package" yaml:"sql_package"`
 	Overrides                 []Override `json:"overrides" yaml:"overrides"`
@@ -126,6 +128,8 @@ func (c *V1GenerateSettings) Translate() Config {
 					EmitResultStructPointers:  pkg.EmitResultStructPointers,
 					EmitParamsStructPointers:  pkg.EmitParamsStructPointers,
 					EmitMethodsWithDBArgument: pkg.EmitMethodsWithDBArgument,
+					EmitEnumValidMethod:       pkg.EmitEnumValidMethod,
+					EmitAllEnumValues:         pkg.EmitAllEnumValues,
 					Package:                   pkg.Name,
 					Out:                       pkg.Path,
 					SQLPackage:                pkg.SQLPackage,

internal/endtoend/testdata/codegen_json/gen/codegen_request.json

@@ -41,7 +41,9 @@
       "output_db_file_name": "",
       "output_models_file_name": "",
       "output_querier_file_name": "",
-      "output_files_suffix": ""
+      "output_files_suffix": "",
+      "emit_enum_valid_method": false,
+      "emit_all_enum_values": false
     },
     "json": {
       "out": "gen",