Skip to content

Commit 010fca7

Browse files
dchertkovkyleconroy
dchertkov
and
kyleconroy
authored
Add emit_result_struct_pointers and emit_params_struct_pointers options (sqlc-dev#979)
* Add emit_result_struct_pointers and emit_params_struct_pointers options for Go generator Co-authored-by: Kyle Conroy <kyle@conroy.org>
1 parent 4009b6d commit 010fca7

File tree

14 files changed

+267
-78
lines changed

14 files changed

+267
-78
lines changed

‎internal/codegen/golang/query.go‎

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ import (
77
)
88

99
type QueryValue struct {
10-
Emit bool
11-
Name string
12-
Struct *Struct
13-
Typ string
14-
SQLPackage SQLPackage
10+
Emit bool
11+
EmitPointer bool
12+
Name string
13+
Struct *Struct
14+
Typ string
15+
SQLPackage SQLPackage
1516
}
1617

1718
func (v QueryValue) EmitStruct() bool {
@@ -22,6 +23,10 @@ func (v QueryValue) IsStruct() bool {
2223
return v.Struct != nil
2324
}
2425

26+
func (v QueryValue) IsPointer() bool {
27+
return v.EmitPointer && v.Struct != nil
28+
}
29+
2530
func (v QueryValue) isEmpty() bool {
2631
return v.Typ == "" && v.Name == "" && v.Struct == nil
2732
}
@@ -30,7 +35,7 @@ func (v QueryValue) Pair() string {
3035
if v.isEmpty() {
3136
return ""
3237
}
33-
return v.Name + " " + v.Type()
38+
return v.Name + " " + v.DefineType()
3439
}
3540

3641
func (v QueryValue) Type() string {
@@ -43,6 +48,21 @@ func (v QueryValue) Type() string {
4348
panic("no type for QueryValue: " + v.Name)
4449
}
4550

51+
func (v *QueryValue) DefineType() string {
52+
t := v.Type()
53+
if v.IsPointer() {
54+
return "*" + t
55+
}
56+
return t
57+
}
58+
59+
func (v *QueryValue) ReturnName() string {
60+
if v.IsPointer() {
61+
return "&" + v.Name
62+
}
63+
return v.Name
64+
}
65+
4666
func (v QueryValue) Params() string {
4767
if v.isEmpty() {
4868
return ""

‎internal/codegen/golang/result.go‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,7 @@ func buildQueries(r *compiler.Result, settings config.CombinedSettings, structs
183183
Name: "arg",
184184
Struct: columnsToStruct(r, gq.MethodName+"Params", cols, settings, false),
185185
SQLPackage: sqlpkg,
186+
EmitPointer: settings.Go.EmitParamsStructPointers,
186187
}
187188
}
188189

@@ -229,10 +230,11 @@ func buildQueries(r *compiler.Result, settings config.CombinedSettings, structs
229230
emit = true
230231
}
231232
gq.Ret = QueryValue{
232-
Emit: emit,
233-
Name: "i",
234-
Struct: gs,
235-
SQLPackage: sqlpkg,
233+
Emit: emit,
234+
Name: "i",
235+
Struct: gs,
236+
SQLPackage: sqlpkg,
237+
EmitPointer: settings.Go.EmitResultStructPointers,
236238
}
237239
}
238240

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
type Querier interface {
33
{{- range .GoQueries}}
44
{{- if eq .Cmd ":one"}}
5-
{{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ({{.Ret.Type}}, error)
5+
{{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ({{.Ret.DefineType}}, error)
66
{{- end}}
77
{{- if eq .Cmd ":many"}}
8-
{{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.Type}}, error)
8+
{{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.DefineType}}, error)
99
{{- end}}
1010
{{- if eq .Cmd ":exec"}}
1111
{{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) error

‎internal/codegen/golang/templates/pgx/queryCode.tmpl‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,34 +22,34 @@ type {{.Ret.Type}} struct { {{- range .Ret.Struct.Fields}}
2222
{{if eq .Cmd ":one"}}
2323
{{range .Comments}}//{{.}}
2424
{{end -}}
25-
func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ({{.Ret.Type}}, error) {
25+
func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ({{.Ret.DefineType}}, error) {
2626
row := q.db.QueryRow(ctx, {{.ConstantName}}, {{.Arg.Params}})
2727
var {{.Ret.Name}} {{.Ret.Type}}
2828
err := row.Scan({{.Ret.Scan}})
29-
return {{.Ret.Name}}, err
29+
return {{.Ret.ReturnName}}, err
3030
}
3131
{{end}}
3232

3333
{{if eq .Cmd ":many"}}
3434
{{range .Comments}}//{{.}}
3535
{{end -}}
36-
func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.Type}}, error) {
36+
func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.DefineType}}, error) {
3737
rows, err := q.db.Query(ctx, {{.ConstantName}}, {{.Arg.Params}})
3838
if err != nil {
3939
return nil, err
4040
}
4141
defer rows.Close()
4242
{{- if $.EmitEmptySlices}}
43-
items := []{{.Ret.Type}}{}
43+
items := []{{.Ret.DefineType}}{}
4444
{{else}}
45-
var items []{{.Ret.Type}}
45+
var items []{{.Ret.DefineType}}
4646
{{end -}}
4747
for rows.Next() {
4848
var {{.Ret.Name}} {{.Ret.Type}}
4949
if err := rows.Scan({{.Ret.Scan}}); err != nil {
5050
return nil, err
5151
}
52-
items = append(items, {{.Ret.Name}})
52+
items = append(items, {{.Ret.ReturnName}})
5353
}
5454
if err := rows.Err(); err != nil {
5555
return nil, err

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
type Querier interface {
33
{{- range .GoQueries}}
44
{{- if eq .Cmd ":one"}}
5-
{{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ({{.Ret.Type}}, error)
5+
{{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ({{.Ret.DefineType}}, error)
66
{{- end}}
77
{{- if eq .Cmd ":many"}}
8-
{{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.Type}}, error)
8+
{{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.DefineType}}, error)
99
{{- end}}
1010
{{- if eq .Cmd ":exec"}}
1111
{{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) error

‎internal/codegen/golang/templates/stdlib/queryCode.tmpl‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,22 @@ type {{.Ret.Type}} struct { {{- range .Ret.Struct.Fields}}
2222
{{if eq .Cmd ":one"}}
2323
{{range .Comments}}//{{.}}
2424
{{end -}}
25-
func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ({{.Ret.Type}}, error) {
25+
func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ({{.Ret.DefineType}}, error) {
2626
{{- if $.EmitPreparedQueries}}
2727
row := q.queryRow(ctx, q.{{.FieldName}}, {{.ConstantName}}, {{.Arg.Params}})
2828
{{- else}}
2929
row := q.db.QueryRowContext(ctx, {{.ConstantName}}, {{.Arg.Params}})
3030
{{- end}}
3131
var {{.Ret.Name}} {{.Ret.Type}}
3232
err := row.Scan({{.Ret.Scan}})
33-
return {{.Ret.Name}}, err
33+
return {{.Ret.ReturnName}}, err
3434
}
3535
{{end}}
3636

3737
{{if eq .Cmd ":many"}}
3838
{{range .Comments}}//{{.}}
3939
{{end -}}
40-
func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.Type}}, error) {
40+
func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.DefineType}}, error) {
4141
{{- if $.EmitPreparedQueries}}
4242
rows, err := q.query(ctx, q.{{.FieldName}}, {{.ConstantName}}, {{.Arg.Params}})
4343
{{- else}}
@@ -48,16 +48,16 @@ func (q *Queries) {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.
4848
}
4949
defer rows.Close()
5050
{{- if $.EmitEmptySlices}}
51-
items := []{{.Ret.Type}}{}
51+
items := []{{.Ret.DefineType}}{}
5252
{{else}}
53-
var items []{{.Ret.Type}}
53+
var items []{{.Ret.DefineType}}
5454
{{end -}}
5555
for rows.Next() {
5656
var {{.Ret.Name}} {{.Ret.Type}}
5757
if err := rows.Scan({{.Ret.Scan}}); err != nil {
5858
return nil, err
5959
}
60-
items = append(items, {{.Ret.Name}})
60+
items = append(items, {{.Ret.ReturnName}})
6161
}
6262
if err := rows.Close(); err != nil {
6363
return nil, err

‎internal/config/config.go‎

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -110,23 +110,25 @@ type SQLGen struct {
110110
}
111111

112112
type SQLGo struct {
113-
EmitInterface bool `json:"emit_interface" yaml:"emit_interface"`
114-
EmitJSONTags bool `json:"emit_json_tags" yaml:"emit_json_tags"`
115-
EmitDBTags bool `json:"emit_db_tags" yaml:"emit_db_tags"`
116-
EmitPreparedQueries bool `json:"emit_prepared_queries" yaml:"emit_prepared_queries"`
117-
EmitExactTableNames bool `json:"emit_exact_table_names,omitempty" yaml:"emit_exact_table_names"`
118-
EmitEmptySlices bool `json:"emit_empty_slices,omitempty" yaml:"emit_empty_slices"`
119-
EmitExportedQueries bool `json:"emit_exported_queries" yaml:"emit_exported_queries"`
120-
JSONTagsCaseStyle string `json:"json_tags_case_style,omitempty" yaml:"json_tags_case_style"`
121-
Package string `json:"package" yaml:"package"`
122-
Out string `json:"out" yaml:"out"`
123-
Overrides []Override `json:"overrides,omitempty" yaml:"overrides"`
124-
Rename map[string]string `json:"rename,omitempty" yaml:"rename"`
125-
SQLPackage string `json:"sql_package" yaml:"sql_package"`
126-
OutputDBFileName string `json:"output_db_file_name,omitempty" yaml:"output_db_file_name"`
127-
OutputModelsFileName string `json:"output_models_file_name,omitempty" yaml:"output_models_file_name"`
128-
OutputQuerierFileName string `json:"output_querier_file_name,omitempty" yaml:"output_querier_file_name"`
129-
OutputFilesSuffix string `json:"output_files_suffix,omitempty" yaml:"output_files_suffix"`
113+
EmitInterface bool `json:"emit_interface" yaml:"emit_interface"`
114+
EmitJSONTags bool `json:"emit_json_tags" yaml:"emit_json_tags"`
115+
EmitDBTags bool `json:"emit_db_tags" yaml:"emit_db_tags"`
116+
EmitPreparedQueries bool `json:"emit_prepared_queries" yaml:"emit_prepared_queries"`
117+
EmitExactTableNames bool `json:"emit_exact_table_names,omitempty" yaml:"emit_exact_table_names"`
118+
EmitEmptySlices bool `json:"emit_empty_slices,omitempty" yaml:"emit_empty_slices"`
119+
EmitExportedQueries bool `json:"emit_exported_queries" yaml:"emit_exported_queries"`
120+
EmitResultStructPointers bool `json:"emit_result_struct_pointers" yaml:"emit_result_struct_pointers"`
121+
EmitParamsStructPointers bool `json:"emit_params_struct_pointers" yaml:"emit_params_struct_pointers"`
122+
JSONTagsCaseStyle string `json:"json_tags_case_style,omitempty" yaml:"json_tags_case_style"`
123+
Package string `json:"package" yaml:"package"`
124+
Out string `json:"out" yaml:"out"`
125+
Overrides []Override `json:"overrides,omitempty" yaml:"overrides"`
126+
Rename map[string]string `json:"rename,omitempty" yaml:"rename"`
127+
SQLPackage string `json:"sql_package" yaml:"sql_package"`
128+
OutputDBFileName string `json:"output_db_file_name,omitempty" yaml:"output_db_file_name"`
129+
OutputModelsFileName string `json:"output_models_file_name,omitempty" yaml:"output_models_file_name"`
130+
OutputQuerierFileName string `json:"output_querier_file_name,omitempty" yaml:"output_querier_file_name"`
131+
OutputFilesSuffix string `json:"output_files_suffix,omitempty" yaml:"output_files_suffix"`
130132
}
131133

132134
type SQLKotlin struct {

‎internal/config/v_one.go‎

Lines changed: 39 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,27 @@ type V1GenerateSettings struct {
1616
}
1717

1818
type v1PackageSettings struct {
19-
Name string `json:"name" yaml:"name"`
20-
Engine Engine `json:"engine,omitempty" yaml:"engine"`
21-
Path string `json:"path" yaml:"path"`
22-
Schema Paths `json:"schema" yaml:"schema"`
23-
Queries Paths `json:"queries" yaml:"queries"`
24-
EmitInterface bool `json:"emit_interface" yaml:"emit_interface"`
25-
EmitJSONTags bool `json:"emit_json_tags" yaml:"emit_json_tags"`
26-
EmitDBTags bool `json:"emit_db_tags" yaml:"emit_db_tags"`
27-
EmitPreparedQueries bool `json:"emit_prepared_queries" yaml:"emit_prepared_queries"`
28-
EmitExactTableNames bool `json:"emit_exact_table_names,omitempty" yaml:"emit_exact_table_names"`
29-
EmitEmptySlices bool `json:"emit_empty_slices,omitempty" yaml:"emit_empty_slices"`
30-
EmitExportedQueries bool `json:"emit_exported_queries,omitempty" yaml:"emit_exported_queries"`
31-
JSONTagsCaseStyle string `json:"json_tags_case_style,omitempty" yaml:"json_tags_case_style"`
32-
SQLPackage string `json:"sql_package" yaml:"sql_package"`
33-
Overrides []Override `json:"overrides" yaml:"overrides"`
34-
OutputDBFileName string `json:"output_db_file_name,omitempty" yaml:"output_db_file_name"`
35-
OutputModelsFileName string `json:"output_models_file_name,omitempty" yaml:"output_models_file_name"`
36-
OutputQuerierFileName string `json:"output_querier_file_name,omitempty" yaml:"output_querier_file_name"`
37-
OutputFilesSuffix string `json:"output_files_suffix,omitempty" yaml:"output_files_suffix"`
19+
Name string `json:"name" yaml:"name"`
20+
Engine Engine `json:"engine,omitempty" yaml:"engine"`
21+
Path string `json:"path" yaml:"path"`
22+
Schema Paths `json:"schema" yaml:"schema"`
23+
Queries Paths `json:"queries" yaml:"queries"`
24+
EmitInterface bool `json:"emit_interface" yaml:"emit_interface"`
25+
EmitJSONTags bool `json:"emit_json_tags" yaml:"emit_json_tags"`
26+
EmitDBTags bool `json:"emit_db_tags" yaml:"emit_db_tags"`
27+
EmitPreparedQueries bool `json:"emit_prepared_queries" yaml:"emit_prepared_queries"`
28+
EmitExactTableNames bool `json:"emit_exact_table_names,omitempty" yaml:"emit_exact_table_names"`
29+
EmitEmptySlices bool `json:"emit_empty_slices,omitempty" yaml:"emit_empty_slices"`
30+
EmitExportedQueries bool `json:"emit_exported_queries,omitempty" yaml:"emit_exported_queries"`
31+
EmitResultStructPointers bool `json:"emit_result_struct_pointers" yaml:"emit_result_struct_pointers"`
32+
EmitParamsStructPointers bool `json:"emit_params_struct_pointers" yaml:"emit_params_struct_pointers"`
33+
JSONTagsCaseStyle string `json:"json_tags_case_style,omitempty" yaml:"json_tags_case_style"`
34+
SQLPackage string `json:"sql_package" yaml:"sql_package"`
35+
Overrides []Override `json:"overrides" yaml:"overrides"`
36+
OutputDBFileName string `json:"output_db_file_name,omitempty" yaml:"output_db_file_name"`
37+
OutputModelsFileName string `json:"output_models_file_name,omitempty" yaml:"output_models_file_name"`
38+
OutputQuerierFileName string `json:"output_querier_file_name,omitempty" yaml:"output_querier_file_name"`
39+
OutputFilesSuffix string `json:"output_files_suffix,omitempty" yaml:"output_files_suffix"`
3840
}
3941

4042
func v1ParseConfig(rd io.Reader) (Config, error) {
@@ -110,22 +112,24 @@ func (c *V1GenerateSettings) Translate() Config {
110112
Queries: pkg.Queries,
111113
Gen: SQLGen{
112114
Go: &SQLGo{
113-
EmitInterface: pkg.EmitInterface,
114-
EmitJSONTags: pkg.EmitJSONTags,
115-
EmitDBTags: pkg.EmitDBTags,
116-
EmitPreparedQueries: pkg.EmitPreparedQueries,
117-
EmitExactTableNames: pkg.EmitExactTableNames,
118-
EmitEmptySlices: pkg.EmitEmptySlices,
119-
EmitExportedQueries: pkg.EmitExportedQueries,
120-
Package: pkg.Name,
121-
Out: pkg.Path,
122-
SQLPackage: pkg.SQLPackage,
123-
Overrides: pkg.Overrides,
124-
JSONTagsCaseStyle: pkg.JSONTagsCaseStyle,
125-
OutputDBFileName: pkg.OutputDBFileName,
126-
OutputModelsFileName: pkg.OutputModelsFileName,
127-
OutputQuerierFileName: pkg.OutputQuerierFileName,
128-
OutputFilesSuffix: pkg.OutputFilesSuffix,
115+
EmitInterface: pkg.EmitInterface,
116+
EmitJSONTags: pkg.EmitJSONTags,
117+
EmitDBTags: pkg.EmitDBTags,
118+
EmitPreparedQueries: pkg.EmitPreparedQueries,
119+
EmitExactTableNames: pkg.EmitExactTableNames,
120+
EmitEmptySlices: pkg.EmitEmptySlices,
121+
EmitExportedQueries: pkg.EmitExportedQueries,
122+
EmitResultStructPointers: pkg.EmitResultStructPointers,
123+
EmitParamsStructPointers: pkg.EmitParamsStructPointers,
124+
Package: pkg.Name,
125+
Out: pkg.Path,
126+
SQLPackage: pkg.SQLPackage,
127+
Overrides: pkg.Overrides,
128+
JSONTagsCaseStyle: pkg.JSONTagsCaseStyle,
129+
OutputDBFileName: pkg.OutputDBFileName,
130+
OutputModelsFileName: pkg.OutputModelsFileName,
131+
OutputQuerierFileName: pkg.OutputQuerierFileName,
132+
OutputFilesSuffix: pkg.OutputFilesSuffix,
129133
},
130134
},
131135
})

‎internal/endtoend/testdata/emit_result_and_params_struct_pointers/go/db.go‎

Lines changed: 29 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎internal/endtoend/testdata/emit_result_and_params_struct_pointers/go/models.go‎

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)