diff --git a/internal/codegen/golang/gen.go b/internal/codegen/golang/gen.go index 7df56a0a41..ef90af3121 100644 --- a/internal/codegen/golang/gen.go +++ b/internal/codegen/golang/gen.go @@ -42,6 +42,7 @@ type tmplCtx struct { OmitSqlcVersion bool BuildTags string WrapErrors bool + EmitPointersForNullTypes bool } func (t *tmplCtx) OutputQuery(sourceName string) bool { @@ -140,7 +141,9 @@ func validate(options *opts.Options, enums []Enum, structs []Struct, queries []Q enumNames := make(map[string]struct{}) for _, enum := range enums { enumNames[enum.Name] = struct{}{} - enumNames["Null"+enum.Name] = struct{}{} + if !options.EmitPointersForNullTypes { + enumNames["Null"+enum.Name] = struct{}{} + } } structNames := make(map[string]struct{}) for _, struckt := range structs { @@ -192,6 +195,7 @@ func generate(req *plugin.GenerateRequest, options *opts.Options, enums []Enum, BuildTags: options.BuildTags, OmitSqlcVersion: options.OmitSqlcVersion, WrapErrors: options.WrapErrors, + EmitPointersForNullTypes: options.EmitPointersForNullTypes, } if tctx.UsesCopyFrom && !tctx.SQLDriver.IsPGX() && options.SqlDriver != opts.SQLDriverGoSQLDriverMySQL { @@ -396,7 +400,8 @@ func filterUnusedStructs(enums []Enum, structs []Struct, queries []Query) ([]Enu for _, enum := range enums { _, keep := keepTypes[enum.Name] _, keepNull := keepTypes["Null"+enum.Name] - if keep || keepNull { + _, keepPointer := keepTypes["*"+enum.Name] + if keep || keepNull || keepPointer { keepEnums = append(keepEnums, enum) } } diff --git a/internal/codegen/golang/imports.go b/internal/codegen/golang/imports.go index ccca4f603c..25682ba692 100644 --- a/internal/codegen/golang/imports.go +++ b/internal/codegen/golang/imports.go @@ -276,7 +276,9 @@ func (i *importer) modelImports() fileImports { if len(i.Enums) > 0 { std["fmt"] = struct{}{} - std["database/sql/driver"] = struct{}{} + if !i.Options.EmitPointersForNullTypes { + std["database/sql/driver"] = struct{}{} + } } return sortedImports(std, pkg) diff --git a/internal/codegen/golang/mysql_type.go b/internal/codegen/golang/mysql_type.go index 252e291f58..3e75a7bbd1 100644 --- a/internal/codegen/golang/mysql_type.go +++ b/internal/codegen/golang/mysql_type.go @@ -13,6 +13,7 @@ func mysqlType(req *plugin.GenerateRequest, options *opts.Options, col *plugin.C columnType := sdk.DataType(col.Type) notNull := col.NotNull || col.IsArray unsigned := col.Unsigned + emitPointersForNull := options.EmitPointersForNullTypes switch columnType { @@ -127,10 +128,16 @@ func mysqlType(req *plugin.GenerateRequest, options *opts.Options, col *plugin.C } return StructName(schema.Name+"_"+enum.Name, options) } else { + var enumTypeName string if schema.Name == req.Catalog.DefaultSchema { - return "Null" + StructName(enum.Name, options) + enumTypeName = StructName(enum.Name, options) + } else { + enumTypeName = StructName(schema.Name+"_"+enum.Name, options) } - return "Null" + StructName(schema.Name+"_"+enum.Name, options) + if emitPointersForNull { + return "*" + enumTypeName + } + return "Null" + enumTypeName } } } diff --git a/internal/codegen/golang/postgresql_type.go b/internal/codegen/golang/postgresql_type.go index 398d01e2e8..b6fb29fdaf 100644 --- a/internal/codegen/golang/postgresql_type.go +++ b/internal/codegen/golang/postgresql_type.go @@ -577,10 +577,16 @@ func postgresType(req *plugin.GenerateRequest, options *opts.Options, col *plugi } return StructName(schema.Name+"_"+enum.Name, options) } else { + var enumTypeName string if schema.Name == req.Catalog.DefaultSchema { - return "Null" + StructName(enum.Name, options) + enumTypeName = StructName(enum.Name, options) + } else { + enumTypeName = StructName(schema.Name+"_"+enum.Name, options) } - return "Null" + StructName(schema.Name+"_"+enum.Name, options) + if emitPointersForNull { + return "*" + enumTypeName + } + return "Null" + enumTypeName } } } diff --git a/internal/codegen/golang/templates/template.tmpl b/internal/codegen/golang/templates/template.tmpl index afd50c01ac..334bcc5b4c 100644 --- a/internal/codegen/golang/templates/template.tmpl +++ b/internal/codegen/golang/templates/template.tmpl @@ -108,6 +108,7 @@ func (e *{{.Name}}) Scan(src interface{}) error { return nil } +{{ if not $.EmitPointersForNullTypes }} type Null{{.Name}} struct { {{.Name}} {{.Name}} {{if .NameTag}}{{$.Q}}{{.NameTag}}{{$.Q}}{{end}} Valid bool {{if .ValidTag}}{{$.Q}}{{.ValidTag}}{{$.Q}}{{end}} // Valid is true if {{.Name}} is not NULL @@ -131,6 +132,8 @@ func (ns Null{{.Name}}) Value() (driver.Value, error) { return string(ns.{{.Name}}), nil } +{{ end }} + {{ if $.EmitEnumValidMethod }} func (e {{.Name}}) Valid() bool { diff --git a/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/go/db.go b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/go/db.go new file mode 100644 index 0000000000..44139faf54 --- /dev/null +++ b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/go/db.go @@ -0,0 +1,24 @@ +// Code generated by sqlc. DO NOT EDIT. +// versions: +// sqlc v1.30.0 + +package querytest + +import ( + "context" + "database/sql" +) + +type DBTX interface { + ExecContext(context.Context, string, ...interface{}) (sql.Result, error) + PrepareContext(context.Context, string) (*sql.Stmt, error) + QueryContext(context.Context, string, ...interface{}) (*sql.Rows, error) + QueryRowContext(context.Context, string, ...interface{}) *sql.Row +} + +func New() *Queries { + return &Queries{} +} + +type Queries struct { +} diff --git a/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/go/models.go b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/go/models.go new file mode 100644 index 0000000000..be8838d736 --- /dev/null +++ b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/go/models.go @@ -0,0 +1,63 @@ +// Code generated by sqlc. DO NOT EDIT. +// versions: +// sqlc v1.30.0 + +package querytest + +import ( + "database/sql" + "fmt" +) + +type UsersShirtSize string + +const ( + UsersShirtSizeXSmall UsersShirtSize = "x-small" + UsersShirtSizeSmall UsersShirtSize = "small" + UsersShirtSizeMedium UsersShirtSize = "medium" + UsersShirtSizeLarge UsersShirtSize = "large" + UsersShirtSizeXLarge UsersShirtSize = "x-large" +) + +func (e *UsersShirtSize) Scan(src interface{}) error { + switch s := src.(type) { + case []byte: + *e = UsersShirtSize(s) + case string: + *e = UsersShirtSize(s) + default: + return fmt.Errorf("unsupported scan type for UsersShirtSize: %T", src) + } + return nil +} + +type UsersShoeSize string + +const ( + UsersShoeSizeXSmall UsersShoeSize = "x-small" + UsersShoeSizeSmall UsersShoeSize = "small" + UsersShoeSizeMedium UsersShoeSize = "medium" + UsersShoeSizeLarge UsersShoeSize = "large" + UsersShoeSizeXLarge UsersShoeSize = "x-large" +) + +func (e *UsersShoeSize) Scan(src interface{}) error { + switch s := src.(type) { + case []byte: + *e = UsersShoeSize(s) + case string: + *e = UsersShoeSize(s) + default: + return fmt.Errorf("unsupported scan type for UsersShoeSize: %T", src) + } + return nil +} + +type User struct { + ID int32 + FirstName string + LastName sql.NullString + Age int32 + ShoeSize UsersShoeSize + ShirtSize *UsersShirtSize +} diff --git a/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/go/query.sql.go b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/go/query.sql.go new file mode 100644 index 0000000000..8fdac96c24 --- /dev/null +++ b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/go/query.sql.go @@ -0,0 +1,107 @@ +// Code generated by sqlc. DO NOT EDIT. +// versions: +// sqlc v1.30.0 +// source: query.sql + +package querytest + +import ( + "context" + "database/sql" +) + +const deleteBySize = `-- name: DeleteBySize :exec +DELETE FROM users +WHERE shoe_size = ? AND shirt_size = ? +` + +type DeleteBySizeParams struct { + ShoeSize UsersShoeSize + ShirtSize *UsersShirtSize +} + +func (q *Queries) DeleteBySize(ctx context.Context, db DBTX, arg DeleteBySizeParams) error { + _, err := db.ExecContext(ctx, deleteBySize, arg.ShoeSize, arg.ShirtSize) + return err +} + +const getAll = `-- name: GetAll :many +SELECT id, first_name, last_name, age, shoe_size, shirt_size FROM users +` + +func (q *Queries) GetAll(ctx context.Context, db DBTX) ([]User, error) { + rows, err := db.QueryContext(ctx, getAll) + if err != nil { + return nil, err + } + defer rows.Close() + var items []User + for rows.Next() { + var i User + if err := rows.Scan( + &i.ID, + &i.FirstName, + &i.LastName, + &i.Age, + &i.ShoeSize, + &i.ShirtSize, + ); err != nil { + return nil, err + } + items = append(items, i) + } + if err := rows.Close(); err != nil { + return nil, err + } + if err := rows.Err(); err != nil { + return nil, err + } + return items, nil +} + +const newUser = `-- name: NewUser :exec +INSERT INTO users ( + first_name, + last_name, + age, + shoe_size, + shirt_size +) VALUES +(?, ?, ?, ?, ?) +` + +type NewUserParams struct { + FirstName string + LastName sql.NullString + Age int32 + ShoeSize UsersShoeSize + ShirtSize *UsersShirtSize +} + +func (q *Queries) NewUser(ctx context.Context, db DBTX, arg NewUserParams) error { + _, err := db.ExecContext(ctx, newUser, + arg.FirstName, + arg.LastName, + arg.Age, + arg.ShoeSize, + arg.ShirtSize, + ) + return err +} + +const updateSizes = `-- name: UpdateSizes :exec +UPDATE users +SET shoe_size = ?, shirt_size = ? +WHERE id = ? +` + +type UpdateSizesParams struct { + ShoeSize UsersShoeSize + ShirtSize *UsersShirtSize + ID int32 +} + +func (q *Queries) UpdateSizes(ctx context.Context, db DBTX, arg UpdateSizesParams) error { + _, err := db.ExecContext(ctx, updateSizes, arg.ShoeSize, arg.ShirtSize, arg.ID) + return err +} diff --git a/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/query.sql b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/query.sql new file mode 100644 index 0000000000..b5dccdb42e --- /dev/null +++ b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/query.sql @@ -0,0 +1,21 @@ +-- name: GetAll :many +SELECT * FROM users; + +-- name: NewUser :exec +INSERT INTO users ( + first_name, + last_name, + age, + shoe_size, + shirt_size +) VALUES +(?, ?, ?, ?, ?); + +-- name: UpdateSizes :exec +UPDATE users +SET shoe_size = ?, shirt_size = ? +WHERE id = ?; + +-- name: DeleteBySize :exec +DELETE FROM users +WHERE shoe_size = ? AND shirt_size = ?; diff --git a/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/schema.sql b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/schema.sql new file mode 100644 index 0000000000..ee7b6ea9cd --- /dev/null +++ b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/schema.sql @@ -0,0 +1,8 @@ +CREATE TABLE users ( + id integer NOT NULL AUTO_INCREMENT PRIMARY KEY, + first_name varchar(255) NOT NULL, + last_name varchar(255), + age integer NOT NULL, + shoe_size ENUM('x-small', 'small', 'medium', 'large', 'x-large') NOT NULL, + shirt_size ENUM('x-small', 'small', 'medium', 'large', 'x-large') +); diff --git a/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/sqlc.json b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/sqlc.json new file mode 100644 index 0000000000..e54218da90 --- /dev/null +++ b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/mysql/sqlc.json @@ -0,0 +1,14 @@ +{ + "version": "1", + "packages": [ + { + "name": "querytest", + "path": "go", + "schema": "schema.sql", + "queries": "query.sql", + "engine": "mysql", + "emit_methods_with_db_argument": true, + "emit_pointers_for_null_types": true + } + ] +} diff --git a/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/go/db.go b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/go/db.go new file mode 100644 index 0000000000..1e00549714 --- /dev/null +++ b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/go/db.go @@ -0,0 +1,32 @@ +// Code generated by sqlc. DO NOT EDIT. +// versions: +// sqlc v1.30.0 + +package querytest + +import ( + "context" + + "github.com/jackc/pgx/v5" + "github.com/jackc/pgx/v5/pgconn" +) + +type DBTX interface { + Exec(context.Context, string, ...interface{}) (pgconn.CommandTag, error) + Query(context.Context, string, ...interface{}) (pgx.Rows, error) + QueryRow(context.Context, string, ...interface{}) pgx.Row +} + +func New(db DBTX) *Queries { + return &Queries{db: db} +} + +type Queries struct { + db DBTX +} + +func (q *Queries) WithTx(tx pgx.Tx) *Queries { + return &Queries{ + db: tx, + } +} diff --git a/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/go/models.go b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/go/models.go new file mode 100644 index 0000000000..2b80d13083 --- /dev/null +++ b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/go/models.go @@ -0,0 +1,40 @@ +// Code generated by sqlc. DO NOT EDIT. +// versions: +// sqlc v1.30.0 + +package querytest + +import ( + "fmt" +) + +type Size string + +const ( + SizeXSmall Size = "x-small" + SizeSmall Size = "small" + SizeMedium Size = "medium" + SizeLarge Size = "large" + SizeXLarge Size = "x-large" +) + +func (e *Size) Scan(src interface{}) error { + switch s := src.(type) { + case []byte: + *e = Size(s) + case string: + *e = Size(s) + default: + return fmt.Errorf("unsupported scan type for Size: %T", src) + } + return nil +} + +type User struct { + ID int32 + FirstName string + LastName *string + Age int32 + ShoeSize Size + ShirtSize *Size +} diff --git a/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/go/query.sql.go b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/go/query.sql.go new file mode 100644 index 0000000000..3198683475 --- /dev/null +++ b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/go/query.sql.go @@ -0,0 +1,103 @@ +// Code generated by sqlc. DO NOT EDIT. +// versions: +// sqlc v1.30.0 +// source: query.sql + +package querytest + +import ( + "context" +) + +const deleteBySize = `-- name: DeleteBySize :exec +DELETE FROM users +WHERE shoe_size = $1 AND shirt_size = $2 +` + +type DeleteBySizeParams struct { + ShoeSize Size + ShirtSize *Size +} + +func (q *Queries) DeleteBySize(ctx context.Context, arg DeleteBySizeParams) error { + _, err := q.db.Exec(ctx, deleteBySize, arg.ShoeSize, arg.ShirtSize) + return err +} + +const getAll = `-- name: GetAll :many +SELECT id, first_name, last_name, age, shoe_size, shirt_size FROM users +` + +func (q *Queries) GetAll(ctx context.Context) ([]User, error) { + rows, err := q.db.Query(ctx, getAll) + if err != nil { + return nil, err + } + defer rows.Close() + var items []User + for rows.Next() { + var i User + if err := rows.Scan( + &i.ID, + &i.FirstName, + &i.LastName, + &i.Age, + &i.ShoeSize, + &i.ShirtSize, + ); err != nil { + return nil, err + } + items = append(items, i) + } + if err := rows.Err(); err != nil { + return nil, err + } + return items, nil +} + +const newUser = `-- name: NewUser :exec +INSERT INTO users ( + first_name, + last_name, + age, + shoe_size, + shirt_size +) VALUES +($1, $2, $3, $4, $5) +` + +type NewUserParams struct { + FirstName string + LastName *string + Age int32 + ShoeSize Size + ShirtSize *Size +} + +func (q *Queries) NewUser(ctx context.Context, arg NewUserParams) error { + _, err := q.db.Exec(ctx, newUser, + arg.FirstName, + arg.LastName, + arg.Age, + arg.ShoeSize, + arg.ShirtSize, + ) + return err +} + +const updateSizes = `-- name: UpdateSizes :exec +UPDATE users +SET shoe_size = $2, shirt_size = $3 +WHERE id = $1 +` + +type UpdateSizesParams struct { + ID int32 + ShoeSize Size + ShirtSize *Size +} + +func (q *Queries) UpdateSizes(ctx context.Context, arg UpdateSizesParams) error { + _, err := q.db.Exec(ctx, updateSizes, arg.ID, arg.ShoeSize, arg.ShirtSize) + return err +} diff --git a/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/query.sql b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/query.sql new file mode 100644 index 0000000000..1902312c1a --- /dev/null +++ b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/query.sql @@ -0,0 +1,21 @@ +-- name: GetAll :many +SELECT * FROM users; + +-- name: NewUser :exec +INSERT INTO users ( + first_name, + last_name, + age, + shoe_size, + shirt_size +) VALUES +($1, $2, $3, $4, $5); + +-- name: UpdateSizes :exec +UPDATE users +SET shoe_size = $2, shirt_size = $3 +WHERE id = $1; + +-- name: DeleteBySize :exec +DELETE FROM users +WHERE shoe_size = $1 AND shirt_size = $2; diff --git a/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/schema.sql b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/schema.sql new file mode 100644 index 0000000000..ad2802d4a9 --- /dev/null +++ b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/schema.sql @@ -0,0 +1,11 @@ +CREATE TYPE size AS ENUM('x-small', 'small', 'medium', 'large', 'x-large'); + + +CREATE TABLE users ( + id integer NOT NULL GENERATED ALWAYS AS IDENTITY PRIMARY KEY, + first_name varchar(255) NOT NULL, + last_name varchar(255), + age integer NOT NULL, + shoe_size size NOT NULL, + shirt_size size +); diff --git a/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/sqlc.json b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/sqlc.json new file mode 100644 index 0000000000..9b919dfea2 --- /dev/null +++ b/internal/endtoend/testdata/emit_pointers_for_null_types_enum/postgresql/pgx/v5/sqlc.json @@ -0,0 +1,14 @@ +{ + "version": "1", + "packages": [ + { + "path": "go", + "engine": "postgresql", + "sql_package": "pgx/v5", + "name": "querytest", + "schema": "schema.sql", + "queries": "query.sql", + "emit_pointers_for_null_types": true + } + ] +}