feat(Go):Add query_parameter_limit conf to codegen (#1558)

* feat(Go):Add query_parameter_limit conf to codegen

* Fix nil pointer reference

* Allow query_parameter_limit to be zero

* resolve conversation

* remove qpl check

* docs: Remove duplicate config entry

---------

Co-authored-by: go-mez <cristobal.gomez@mercadolibre.cl>
Co-authored-by: Kyle Conroy <kyle@conroy.org>

Author: 3 people

.gitignore

@@ -1,2 +1,3 @@
 /.idea/
 __pycache__
+.DS_Store

docs/reference/config.md

@@ -121,7 +121,9 @@ The `gen` mapping supports the following keys:
   - Customize the name of the querier file. Defaults to `querier.go`.
 - `output_files_suffix`:
   - If specified the suffix will be added to the name of the generated files.
-- `rename`:
+- `query_parameter_limit`:
+  - Positional arguments that will be generated in Go functions (>= `1` or `-1`). To always emit a parameter struct, you would need to set it to `-1`. `0` is invalid. Defaults to `1`.
+`rename`:
   - Customize the name of generated struct fields. Explained in detail on the `Renaming fields` section.
 - `overrides`:
   - It is a collection of definitions that dictates which types are used to map a database types. Explained in detail on the  `Type overriding` section.
@@ -403,6 +405,8 @@ Each mapping in the `packages` collection has the following keys:
   - Customize the name of the querier file. Defaults to `querier.go`.
 - `output_files_suffix`:
   - If specified the suffix will be added to the name of the generated files.
+- `query_parameter_limit`:
+  - Positional arguments that will be generated in Go functions (`>= 0`). To always emit a parameter struct, you would need to set it to `0`. Defaults to `1`.
 
 ### overrides
 

internal/cmd/shim.go

@@ -75,6 +75,11 @@ func pluginCodegen(s config.Codegen) *plugin.Codegen {
 }
 
 func pluginGoCode(s config.SQLGo) *plugin.GoCode {
+	if s.QueryParameterLimit == nil {
+		s.QueryParameterLimit = new(int32)
+		*s.QueryParameterLimit = 1
+	}
+
 	return &plugin.GoCode{
 		EmitInterface:               s.EmitInterface,
 		EmitJsonTags:                s.EmitJSONTags,
@@ -98,6 +103,7 @@ func pluginGoCode(s config.SQLGo) *plugin.GoCode {
 		OutputQuerierFileName:       s.OutputQuerierFileName,
 		OutputFilesSuffix:           s.OutputFilesSuffix,
 		InflectionExcludeTableNames: s.InflectionExcludeTableNames,
+		QueryParameterLimit:         s.QueryParameterLimit,
 	}
 }
 

internal/codegen/golang/field.go

@@ -84,3 +84,11 @@ func toCamelInitCase(name string, initUpper bool) string {
 	}
 	return out
 }
+
+func toLowerCase(str string) string {
+	if str == "" {
+		return ""
+	}
+
+	return strings.ToLower(str[:1]) + str[1:]
+}

internal/codegen/golang/query.go

@@ -42,6 +42,16 @@ func (v QueryValue) Pair() string {
 	if v.isEmpty() {
 		return ""
 	}
+
+	var out []string
+	if !v.EmitStruct() && v.IsStruct() {
+		for _, f := range v.Struct.Fields {
+			out = append(out, toLowerCase(f.Name)+" "+f.Type)
+		}
+
+		return strings.Join(out, ",")
+	}
+
 	return v.Name + " " + v.DefineType()
 }
 
@@ -107,6 +117,8 @@ func (v QueryValue) Params() string {
 		for _, f := range v.Struct.Fields {
 			if !f.HasSqlcSlice() && strings.HasPrefix(f.Type, "[]") && f.Type != "[]byte" && !v.SQLDriver.IsPGX() {
 				out = append(out, "pq.Array("+v.Name+"."+f.Name+")")
+			} else if !v.EmitStruct() && v.IsStruct() {
+				out = append(out, toLowerCase(f.Name))
 			} else {
 				out = append(out, v.Name+"."+f.Name)
 			}

internal/codegen/golang/result.go

@@ -202,7 +202,9 @@ func buildQueries(req *plugin.CodeGenRequest, structs []Struct) ([]Query, error)
 		}
 		sqlpkg := parseDriver(req.Settings.Go.SqlPackage)
 
-		if len(query.Params) == 1 {
+		qpl := int(*req.Settings.Go.QueryParameterLimit)
+
+		if len(query.Params) == 1 && qpl != 0 {
 			p := query.Params[0]
 			gq.Arg = QueryValue{
 				Name:      paramName(p),
@@ -211,7 +213,7 @@ func buildQueries(req *plugin.CodeGenRequest, structs []Struct) ([]Query, error)
 				SQLDriver: sqlpkg,
 				Column:    p.Column,
 			}
-		} else if len(query.Params) > 1 {
+		} else if len(query.Params) >= 1 {
 			var cols []goColumn
 			for _, p := range query.Params {
 				cols = append(cols, goColumn{
@@ -230,6 +232,10 @@ func buildQueries(req *plugin.CodeGenRequest, structs []Struct) ([]Query, error)
 				SQLDriver:   sqlpkg,
 				EmitPointer: req.Settings.Go.EmitParamsStructPointers,
 			}
+
+			if len(query.Params) <= qpl {
+				gq.Arg.Emit = false
+			}
 		}
 
 		if len(query.Columns) == 1 && query.Columns[0].EmbedTable == nil {

internal/config/config.go

@@ -133,6 +133,7 @@ type SQLGo struct {
 	OutputQuerierFileName       string            `json:"output_querier_file_name,omitempty" yaml:"output_querier_file_name"`
 	OutputFilesSuffix           string            `json:"output_files_suffix,omitempty" yaml:"output_files_suffix"`
 	InflectionExcludeTableNames []string          `json:"inflection_exclude_table_names,omitempty" yaml:"inflection_exclude_table_names"`
+	QueryParameterLimit         *int32            `json:"query_parameter_limit,omitempty" yaml:"query_parameter_limit"`
 }
 
 type SQLJSON struct {
@@ -150,6 +151,7 @@ var ErrNoPackages = errors.New("no packages")
 var ErrNoQuerierType = errors.New("no querier emit type enabled")
 var ErrUnknownEngine = errors.New("invalid engine")
 var ErrUnknownVersion = errors.New("invalid version number")
+var ErrInvalidQueryParameterLimit = errors.New("invalid query parameter limit")
 
 var ErrPluginBuiltin = errors.New("a built-in plugin with that name already exists")
 var ErrPluginNoName = errors.New("missing plugin name")
@@ -159,8 +161,6 @@ var ErrPluginNoType = errors.New("plugin: field `process` or `wasm` required")
 var ErrPluginBothTypes = errors.New("plugin: both `process` and `wasm` cannot both be defined")
 var ErrPluginProcessNoCmd = errors.New("plugin: missing process command")
 
-var ErrInvalidQueryParameterLimit = errors.New("invalid query parameter limit")
-
 func ParseConfig(rd io.Reader) (Config, error) {
 	var buf bytes.Buffer
 	var config Config

internal/config/v_one.go

@@ -43,6 +43,7 @@ type v1PackageSettings struct {
 	OutputQuerierFileName     string     `json:"output_querier_file_name,omitempty" yaml:"output_querier_file_name"`
 	OutputFilesSuffix         string     `json:"output_files_suffix,omitempty" yaml:"output_files_suffix"`
 	StrictFunctionChecks      bool       `json:"strict_function_checks" yaml:"strict_function_checks"`
+	QueryParameterLimit       *int32     `json:"query_parameter_limit,omitempty" yaml:"query_parameter_limit"`
 }
 
 func v1ParseConfig(rd io.Reader) (Config, error) {
@@ -74,6 +75,16 @@ func v1ParseConfig(rd io.Reader) (Config, error) {
 		if settings.Packages[j].Path == "" {
 			return config, ErrNoPackagePath
 		}
+
+		if settings.Packages[j].QueryParameterLimit != nil && (*settings.Packages[j].QueryParameterLimit < 0) {
+			return config, ErrInvalidQueryParameterLimit
+		}
+
+		if settings.Packages[j].QueryParameterLimit == nil {
+			settings.Packages[j].QueryParameterLimit = new(int32)
+			*settings.Packages[j].QueryParameterLimit = 1
+		}
+
 		for i := range settings.Packages[j].Overrides {
 			if err := settings.Packages[j].Overrides[i].Parse(); err != nil {
 				return config, err
@@ -143,6 +154,7 @@ func (c *V1GenerateSettings) Translate() Config {
 					OutputModelsFileName:      pkg.OutputModelsFileName,
 					OutputQuerierFileName:     pkg.OutputQuerierFileName,
 					OutputFilesSuffix:         pkg.OutputFilesSuffix,
+					QueryParameterLimit:       pkg.QueryParameterLimit,
 				},
 			},
 			StrictFunctionChecks: pkg.StrictFunctionChecks,

internal/config/v_two.go

@@ -74,6 +74,16 @@ func v2ParseConfig(rd io.Reader) (Config, error) {
 			if conf.SQL[j].Gen.Go.Package == "" {
 				conf.SQL[j].Gen.Go.Package = filepath.Base(conf.SQL[j].Gen.Go.Out)
 			}
+
+			if conf.SQL[j].Gen.Go.QueryParameterLimit != nil && (*conf.SQL[j].Gen.Go.QueryParameterLimit < 0) {
+				return conf, ErrInvalidQueryParameterLimit
+			}
+
+			if conf.SQL[j].Gen.Go.QueryParameterLimit == nil {
+				conf.SQL[j].Gen.Go.QueryParameterLimit = new(int32)
+				*conf.SQL[j].Gen.Go.QueryParameterLimit = 1
+			}
+
 			for i := range conf.SQL[j].Gen.Go.Overrides {
 				if err := conf.SQL[j].Gen.Go.Overrides[i].Parse(); err != nil {
 					return conf, err

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

@@ -37,7 +37,8 @@
       "emit_enum_valid_method": false,
       "emit_all_enum_values": false,
       "inflection_exclude_table_names": [],
-      "emit_pointers_for_null_types": false
+      "emit_pointers_for_null_types": false,
+      "query_parameter_limit": 1
     },
     "json": {
       "out": "gen",

internal/endtoend/testdata/process_plugin_disabled/gen/codegen.json

@@ -37,7 +37,8 @@
       "emit_enum_valid_method": false,
       "emit_all_enum_values": false,
       "inflection_exclude_table_names": [],
-      "emit_pointers_for_null_types": false
+      "emit_pointers_for_null_types": false,
+      "query_parameter_limit": 1
     },
     "json": {
       "out": "",

internal/endtoend/testdata/process_plugin_sqlc_gen_json/gen/codegen.json

@@ -37,7 +37,8 @@
       "emit_enum_valid_method": false,
       "emit_all_enum_values": false,
       "inflection_exclude_table_names": [],
-      "emit_pointers_for_null_types": false
+      "emit_pointers_for_null_types": false,
+      "query_parameter_limit": 1
     },
     "json": {
       "out": "",

internal/endtoend/testdata/query_parameter_limit_invalid/postgresql/query.sql

@@ -0,0 +1,27 @@
+-- Example queries for sqlc
+CREATE TABLE authors (
+  id   BIGSERIAL PRIMARY KEY,
+  name text      NOT NULL,
+  bio  text,
+  country_code CHAR(2) NOT NULL
+);
+
+-- name: GetAuthor :one
+SELECT * FROM authors
+WHERE name = $1 AND country_code = $2 LIMIT 1;
+
+-- name: ListAuthors :many
+SELECT * FROM authors
+ORDER BY name;
+
+-- name: CreateAuthor :one
+INSERT INTO authors (
+  name, bio, country_code
+) VALUES (
+  $1, $2, $3
+)
+RETURNING *;
+
+-- name: DeleteAuthor :exec
+DELETE FROM authors
+WHERE id = $1;

internal/endtoend/testdata/query_parameter_limit_invalid/postgresql/sqlc.json

@@ -0,0 +1,14 @@
+{
+    "version": "1",
+    "packages": [
+      {
+        "path": "go",
+        "engine": "postgresql",
+        "name": "querytest",
+        "schema": "query.sql",
+        "queries": "query.sql",
+        "query_parameter_limit": -1
+      }
+    ]
+  }
+  

internal/endtoend/testdata/query_parameter_limit_invalid/postgresql/stderr.txt

@@ -0,0 +1 @@
+error parsing sqlc.json: invalid query parameter limit