Skip to content

Adding support to rename json fields in generated structs #756

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions internal/codegen/golang/result.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ func buildStructs(r *compiler.Result, settings config.CombinedSettings) []Struct
tags["db:"] = column.Name
}
if settings.Go.EmitJSONTags {
tags["json:"] = column.Name
tags["json:"] = JSONTagName(column.Name, settings)
}
s.Fields = append(s.Fields, Field{
Name: StructName(column.Name, settings),
Expand Down Expand Up @@ -239,7 +239,7 @@ func columnsToStruct(r *compiler.Result, name string, columns []goColumn, settin
suffixes := map[int]int{}
for i, c := range columns {
colName := columnName(c.Column, i)
tagName := colName
tagName := JSONTagName(colName, settings)
fieldName := StructName(colName, settings)
// Track suffixes by the ID of the column, so that columns referring to the same numbered parameter can be
// reused.
Expand All @@ -259,7 +259,7 @@ func columnsToStruct(r *compiler.Result, name string, columns []goColumn, settin
tags["db:"] = tagName
}
if settings.Go.EmitJSONTags {
tags["json:"] = tagName
tags["json:"] = JSONTagName(tagName, settings)
}
gs.Fields = append(gs.Fields, Field{
Name: fieldName,
Expand Down
29 changes: 23 additions & 6 deletions internal/codegen/golang/struct.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,34 @@ type Struct struct {
Comment string
}

func StructName(name string, settings config.CombinedSettings) string {
if rename := settings.Rename[name]; rename != "" {
return rename
}
out := ""
func doID(name string, settings config.CombinedSettings) (out string) {
for _, p := range strings.Split(name, "_") {
if p == "id" {
out += "ID"
} else {
out += strings.Title(p)
}
}
return out
return
}

func doRename(name string, settings config.CombinedSettings) string {
if rename := settings.Rename[name]; rename != "" {
return rename
}
return name
}

func JSONTagName(name string, settings config.CombinedSettings) string {
if settings.Go.RenameJSONTags {
name = doRename(name, settings)
}
return name
}

func StructName(name string, settings config.CombinedSettings) string {
if !settings.Go.SkipStructRename {
name = doRename(name, settings)
}
return doID(name, settings)
}
2 changes: 2 additions & 0 deletions internal/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ type SQLGo struct {
EmitPreparedQueries bool `json:"emit_prepared_queries" yaml:"emit_prepared_queries"`
EmitExactTableNames bool `json:"emit_exact_table_names,omitempty" yaml:"emit_exact_table_names"`
EmitEmptySlices bool `json:"emit_empty_slices,omitempty" yaml:"emit_empty_slices"`
SkipStructRename bool `json:"skip_struct_rename" yaml:"skip_struct_rename"`
RenameJSONTags bool `json:"rename_json_tags" yaml:"rename_json_tags"`
Package string `json:"package" yaml:"package"`
Out string `json:"out" yaml:"out"`
Overrides []Override `json:"overrides,omitempty" yaml:"overrides"`
Expand Down
4 changes: 4 additions & 0 deletions internal/config/v_one.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ type v1PackageSettings struct {
EmitPreparedQueries bool `json:"emit_prepared_queries" yaml:"emit_prepared_queries"`
EmitExactTableNames bool `json:"emit_exact_table_names,omitempty" yaml:"emit_exact_table_names"`
EmitEmptySlices bool `json:"emit_empty_slices,omitempty" yaml:"emit_empty_slices"`
SkipStructRename bool `json:"skip_struct_rename" yaml:"skip_struct_rename"`
RenameJSONTags bool `json:"rename_json_tags" yaml:"rename_json_tags"`
Overrides []Override `json:"overrides" yaml:"overrides"`
}

Expand Down Expand Up @@ -109,6 +111,8 @@ func (c *V1GenerateSettings) Translate() Config {
EmitPreparedQueries: pkg.EmitPreparedQueries,
EmitExactTableNames: pkg.EmitExactTableNames,
EmitEmptySlices: pkg.EmitEmptySlices,
RenameJSONTags: pkg.RenameJSONTags,
SkipStructRename: pkg.SkipStructRename,
Package: pkg.Name,
Out: pkg.Path,
Overrides: pkg.Overrides,
Expand Down
29 changes: 29 additions & 0 deletions internal/endtoend/testdata/rename_json_tag/go/db.go

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

32 changes: 32 additions & 0 deletions internal/endtoend/testdata/rename_json_tag/go/models.go

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

74 changes: 74 additions & 0 deletions internal/endtoend/testdata/rename_json_tag/go/query.sql.go

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

12 changes: 12 additions & 0 deletions internal/endtoend/testdata/rename_json_tag/query.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
CREATE TYPE ip_protocol AS enum('tcp', 'ip', 'icmp');

CREATE TABLE bar_old (id_old serial not null, ip_old ip_protocol NOT NULL);

-- name: ListFoo :many
SELECT id_old as foo_old, id_old as baz_old
FROM bar_old
WHERE ip_old = $1 AND id_old = $2;

-- name: ListBar :many
SELECT * FROM bar_old;

21 changes: 21 additions & 0 deletions internal/endtoend/testdata/rename_json_tag/sqlc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"version": "1",
"packages": [
{
"path": "go",
"name": "querytest",
"schema": "query.sql",
"queries": "query.sql",
"emit_json_tags": true,
"rename_json_tags": true
}
],
"rename": {
"id_old": "IDNew",
"bar_old": "BarNew",
"foo_old": "FooNew",
"ip_protocol": "IPProtocol",
"ip_protocol_tcp": "IPProtocolTCP"
}
}

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

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

Loading