Customizable batch output file name (add OutputBatchFileName field) (#2178)

* Customizable batch output file name (add OutputBatchFileName field)

This commit adds the possibility to customize the batch output file name.

Example configuration:

```
version: "1"
packages:
  - name: db
    path: internal/db
    queries: internal/db
    schema: migrations
    engine: postgresql
    output_batch_file_name: batch_gen.go
    output_models_file_name: model_gen.go
```

* test: Add tests for new batch filename config

---------

Co-authored-by: Kyle Conroy <kyle@conroy.org>

Author: JordanP

docs/reference/config.md

@@ -113,6 +113,8 @@ The `gen` mapping supports the following keys:
     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_batch_file_name`:
+  - Customize the name of the batch file. Defaults to `batch.go`.
 - `output_db_file_name`:
   - Customize the name of the db file. Defaults to `db.go`.
 - `output_models_file_name`:
@@ -346,6 +348,7 @@ packages:
     emit_enum_valid_method: false
     emit_all_enum_values: false
     json_tags_case_style: "camel"
+    output_batch_file_name: "batch.go"
     output_db_file_name: "db.go"
     output_models_file_name: "models.go"
     output_querier_file_name: "querier.go"
@@ -397,6 +400,8 @@ Each mapping in the `packages` collection has the following keys:
     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_batch_file_name`:
+  - Customize the name of the batch file. Defaults to `batch.go`.
 - `output_db_file_name`:
   - Customize the name of the db file. Defaults to `db.go`.
 - `output_models_file_name`:

internal/cmd/shim.go

@@ -99,6 +99,7 @@ func pluginGoCode(s config.SQLGo) *plugin.GoCode {
 		Out:                         s.Out,
 		SqlPackage:                  s.SQLPackage,
 		OutputDbFileName:            s.OutputDBFileName,
+		OutputBatchFileName:         s.OutputBatchFileName,
 		OutputModelsFileName:        s.OutputModelsFileName,
 		OutputQuerierFileName:       s.OutputQuerierFileName,
 		OutputFilesSuffix:           s.OutputFilesSuffix,

internal/codegen/golang/gen.go

@@ -219,6 +219,9 @@ func generate(req *plugin.CodeGenRequest, enums []Enum, structs []Struct, querie
 	// TODO(Jille): Make this configurable.
 
 	batchFileName := "batch.go"
+	if golang.OutputBatchFileName != "" {
+		batchFileName = golang.OutputBatchFileName
+	}
 
 	if err := execute(dbFileName, "dbFile"); err != nil {
 		return nil, err

internal/codegen/golang/imports.go

@@ -91,6 +91,9 @@ func (i *importer) Imports(filename string) [][]ImportSpec {
 	}
 	copyfromFileName := "copyfrom.go"
 	batchFileName := "batch.go"
+	if i.Settings.Go.OutputBatchFileName != "" {
+		batchFileName = i.Settings.Go.OutputBatchFileName
+	}
 
 	switch filename {
 	case dbFileName:

internal/config/config.go

@@ -128,6 +128,7 @@ type SQLGo struct {
 	Overrides                   []Override        `json:"overrides,omitempty" yaml:"overrides"`
 	Rename                      map[string]string `json:"rename,omitempty" yaml:"rename"`
 	SQLPackage                  string            `json:"sql_package" yaml:"sql_package"`
+	OutputBatchFileName         string            `json:"output_batch_file_name,omitempty" yaml:"output_batch_file_name"`
 	OutputDBFileName            string            `json:"output_db_file_name,omitempty" yaml:"output_db_file_name"`
 	OutputModelsFileName        string            `json:"output_models_file_name,omitempty" yaml:"output_models_file_name"`
 	OutputQuerierFileName       string            `json:"output_querier_file_name,omitempty" yaml:"output_querier_file_name"`

internal/config/v_one.go

@@ -38,6 +38,7 @@ type v1PackageSettings struct {
 	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"`
+	OutputBatchFileName       string     `json:"output_batch_file_name,omitempty" yaml:"output_batch_file_name"`
 	OutputDBFileName          string     `json:"output_db_file_name,omitempty" yaml:"output_db_file_name"`
 	OutputModelsFileName      string     `json:"output_models_file_name,omitempty" yaml:"output_models_file_name"`
 	OutputQuerierFileName     string     `json:"output_querier_file_name,omitempty" yaml:"output_querier_file_name"`
@@ -150,6 +151,7 @@ func (c *V1GenerateSettings) Translate() Config {
 					SQLPackage:                pkg.SQLPackage,
 					Overrides:                 pkg.Overrides,
 					JSONTagsCaseStyle:         pkg.JSONTagsCaseStyle,
+					OutputBatchFileName:       pkg.OutputBatchFileName,
 					OutputDBFileName:          pkg.OutputDBFileName,
 					OutputModelsFileName:      pkg.OutputModelsFileName,
 					OutputQuerierFileName:     pkg.OutputQuerierFileName,

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

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

internal/endtoend/testdata/output_file_names/pgx/v4/go/batch_gen.go

@@ -2,3 +2,7 @@ CREATE TABLE "user" (id bigserial not null);
 
 -- name: User :many
 SELECT "user".* FROM "user";
+
+-- name: UsersB :batchmany
+SELECT * FROM "user"
+WHERE id = $1;

internal/endtoend/testdata/output_file_names/pgx/v4/go/db_gen.go

@@ -9,6 +9,7 @@
       "schema": "query.sql",
       "queries": "query.sql",
       "emit_interface": true,
+      "output_batch_file_name": "batch_gen.go",
       "output_db_file_name": "db_gen.go",
       "output_models_file_name": "models_gen.go",
       "output_querier_file_name": "querier_gen.go"

internal/endtoend/testdata/output_file_names/pgx/v4/go/querier_gen.go

@@ -2,3 +2,7 @@ CREATE TABLE "user" (id bigserial not null);
 
 -- name: User :many
 SELECT "user".* FROM "user";
+
+-- name: UsersB :batchmany
+SELECT * FROM "user"
+WHERE id = $1;

internal/endtoend/testdata/output_file_names/pgx/v4/query.sql

@@ -9,6 +9,7 @@
       "schema": "query.sql",
       "queries": "query.sql",
       "emit_interface": true,
+      "output_batch_file_name": "batch_gen.go",
       "output_db_file_name": "db_gen.go",
       "output_models_file_name": "models_gen.go",
       "output_querier_file_name": "querier_gen.go"

internal/endtoend/testdata/output_file_names/pgx/v4/sqlc.json

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

internal/endtoend/testdata/output_file_names/pgx/v5/go/batch_gen.go

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