feat: add "use_interface_return_types" option #3125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

Jesse0Michael wants to merge 1 commit into sqlc-dev:main from Jesse0Michael:WithTx-interface

docs/reference/config.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -141,6 +141,8 @@ The `gen` mapping supports the following keys: @@
       - If true, include support for prepared queries. Defaults to `false`.
     - `emit_interface`:
       - If true, output a `Querier` interface in the generated package. Defaults to `false`.
+    - `use_interface_return_types`:
+      - If true, output will use the `Querier` interface as the return type the methods in the generated package. Defaults to `false`.
     - `emit_exact_table_names`:
       - If true, struct names will mirror table names. Otherwise, sqlc attempts to singularize plural table names. Defaults to `false`.
     - `emit_empty_slices`:
@@ Expand Down @@

examples/batch/postgresql/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

examples/ondeck/mysql/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

examples/ondeck/postgresql/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

examples/ondeck/sqlite/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/codegen/golang/gen.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -39,6 +39,7 @@ type tmplCtx struct { @@
     	EmitAllEnumValues         bool
     	UsesCopyFrom              bool
     	UsesBatch                 bool
+    	UseInterfaceReturnTypes   bool
     	OmitSqlcVersion           bool
     	BuildTags                 string
     }
@@ Expand Down Expand Up @@
     	tctx := tmplCtx{
     		EmitInterface:             options.EmitInterface,
+    		UseInterfaceReturnTypes:   options.UseInterfaceReturnTypes,
     		EmitJSONTags:              options.EmitJsonTags,
     		JsonTagsIDUppercase:       options.JsonTagsIdUppercase,
     		EmitDBTags:                options.EmitDbTags,
@@ Expand Down @@

internal/codegen/golang/imports.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -268,6 +268,16 @@ func (i *importer) interfaceImports() fileImports { @@
     	std["context"] = struct{}{}
+    	sqlpkg := parseDriver(i.Options.SqlPackage)
+    	switch sqlpkg {
+    	case SQLDriverPGXV4:
+    		pkg[ImportSpec{Path: "github.com/jackc/pgx/v4"}] = struct{}{}
+    	case SQLDriverPGXV5:
+    		pkg[ImportSpec{Path: "github.com/jackc/pgx/v5"}] = struct{}{}
+    	default:
+    		std["database/sql"] = struct{}{}
+    	}
     	return sortedImports(std, pkg)
     }
@@ Expand Down @@

internal/codegen/golang/opts/options.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -11,6 +11,7 @@ import ( @@
     type Options struct {
     	EmitInterface               bool              `json:"emit_interface" yaml:"emit_interface"`
+    	UseInterfaceReturnTypes     bool              `json:"use_interface_return_types" yaml:"use_interface_return_types"`
     	EmitJsonTags                bool              `json:"emit_json_tags" yaml:"emit_json_tags"`
     	JsonTagsIdUppercase         bool              `json:"json_tags_id_uppercase" yaml:"json_tags_id_uppercase"`
     	EmitDbTags                  bool              `json:"emit_db_tags" yaml:"emit_db_tags"`
@@ Expand Down @@

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

-Original file line number
+Diff line change
@@ Expand Up / @@ -28,7 +28,11 @@ type Queries struct { @@
     }
     {{if not .EmitMethodsWithDBArgument}}
+    {{- if and .EmitInterface .UseInterfaceReturnTypes}}
+    func (q *Queries) WithTx(tx pgx.Tx) Querier {
+    {{- else -}}
     func (q *Queries) WithTx(tx pgx.Tx) *Queries {
+    {{- end}}
     	return &Queries{
     		db: tx,
     	}
@@ Expand Down @@

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

-Original file line number
+Diff line change
@@ -1,5 +1,10 @@
     {{define "interfaceCodePgx"}}
         type Querier interface {
+        {{- if .UseInterfaceReturnTypes}}
+            WithTx(tx pgx.Tx) Querier
+        {{- else -}}
+            WithTx(tx pgx.Tx) *Queries
+        {{- end}}
         {{- $dbtxParam := .EmitMethodsWithDBArgument -}}
         {{- range .GoQueries}}
             {{- if and (eq .Cmd ":one") ($dbtxParam) }}
@@ Expand Down @@

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

-Original file line number
+Diff line change
@@ Expand Up / @@ -90,7 +90,11 @@ type Queries struct { @@
     }
     {{if not .EmitMethodsWithDBArgument}}
+    {{- if and .EmitInterface .UseInterfaceReturnTypes}}
+    func (q *Queries) WithTx(tx *sql.Tx) Querier {
+    {{- else -}}
     func (q *Queries) WithTx(tx *sql.Tx) *Queries {
+    {{- end}}
     	return &Queries{
     		db: tx,
          	{{- if .EmitPreparedQueries}}
@@ Expand Down @@

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

-Original file line number
+Diff line change
@@ -1,5 +1,12 @@
     {{define "interfaceCodeStd"}}
         type Querier interface {
+        {{if not .EmitMethodsWithDBArgument}}
+        {{- if .UseInterfaceReturnTypes}}
+            WithTx(tx *sql.Tx) Querier
+        {{- else -}}
+            WithTx(tx *sql.Tx) *Queries
+        {{- end}}
+        {{- end}}
         {{- $dbtxParam := .EmitMethodsWithDBArgument -}}
         {{- range .GoQueries}}
             {{- if and (eq .Cmd ":one") ($dbtxParam) }}
@@ Expand Down @@

internal/config/v_one.go

-Original file line number
+Diff line change
@@ Expand Up / @@ -28,6 +28,7 @@ type v1PackageSettings struct { @@
     	Schema                    Paths             `json:"schema" yaml:"schema"`
     	Queries                   Paths             `json:"queries" yaml:"queries"`
     	EmitInterface             bool              `json:"emit_interface" yaml:"emit_interface"`
+    	UseInterfaceReturnTypes   bool              `json:"use_interface_return_types" yaml:"use_interface_return_types"`
     	EmitJSONTags              bool              `json:"emit_json_tags" yaml:"emit_json_tags"`
     	JsonTagsIDUppercase       bool              `json:"json_tags_id_uppercase" yaml:"json_tags_id_uppercase"`
     	EmitDBTags                bool              `json:"emit_db_tags" yaml:"emit_db_tags"`
@@ Expand Down Expand Up / @@ -138,6 +139,7 @@ func (c *V1GenerateSettings) Translate() Config { @@
     			Gen: SQLGen{
     				Go: &golang.Options{
     					EmitInterface:             pkg.EmitInterface,
+    					UseInterfaceReturnTypes:   pkg.UseInterfaceReturnTypes,
     					EmitJsonTags:              pkg.EmitJSONTags,
     					JsonTagsIdUppercase:       pkg.JsonTagsIDUppercase,
     					EmitDbTags:                pkg.EmitDBTags,
@@ Expand Down @@

internal/config/v_one.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -92,6 +92,9 @@ @@
                         "emit_interface": {
                             "type": "boolean"
                         },
+                        "use_interface_return_types": {
+                            "type": "boolean"
+                        },
                         "emit_json_tags": {
                             "type": "boolean"
                         },
@@ Expand Down @@

internal/config/v_two.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -101,6 +101,9 @@ @@
                                         "emit_interface": {
                                             "type": "boolean"
                                         },
+                                        "use_interface_return_types": {
+                                            "type": "boolean"
+                                        },
                                         "emit_json_tags": {
                                             "type": "boolean"
                                         },
@@ Expand Down @@

internal/endtoend/testdata/build_tags/postgresql/stdlib/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/copyfrom/postgresql/pgx/v4/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/copyfrom/postgresql/pgx/v5/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/copyfrom_singlecolumn/postgresql/pgx/v4/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/copyfrom_singlecolumn/postgresql/pgx/v5/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/emit_result_and_params_struct_pointers/mysql/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/enum_ordering/postgresql/stdlib/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/exec_imports/pgx/v4/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/exec_imports/pgx/v5/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/exec_imports/stdlib/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/exec_lastid/go_postgresql_stdlib/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/exec_result/go_postgresql_pgx/v4/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/exec_result/go_postgresql_pgx/v5/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/exec_result/go_postgresql_stdlib/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/exec_rows/go_postgresql_pgx/v4/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/exec_rows/go_postgresql_pgx/v5/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

internal/endtoend/testdata/exec_rows/go_postgresql_stdlib/go/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add "use_interface_return_types" option #3125

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat: add "use_interface_return_types" option #3125

Are you sure you want to change the base?

Uh oh!

feat: add "use_interface_return_types" option #3125

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!