feat(golang): support custom enum type slices for pgx/v5

examples/batch/postgresql/db_test.go

@@ -12,7 +12,7 @@ import (
 )
 
 func TestBatchBooks(t *testing.T) {
-	db, cleanup := sqltest.PostgreSQLPgx(t, []string{"schema.sql"})
+	db, cleanup := sqltest.PostgreSQLPgxV4(t, []string{"schema.sql"})
 	defer cleanup()
 
 	ctx := context.Background()

examples/enums/postgresql/db_test.go

@@ -0,0 +1,57 @@
+//go:build examples
+// +build examples
+
+package enums
+
+import (
+	"context"
+	"testing"
+
+	"github.com/sqlc-dev/sqlc/internal/sqltest"
+)
+
+func TestUsers(t *testing.T) {
+	sdb, cleanup := sqltest.PostgreSQLPgxV5(t, []string{"schema.sql", "fixtures.sql"})
+	defer cleanup()
+
+	ctx := context.Background()
+	db := New(sdb)
+
+	for _, name := range EnumNames {
+		enumType, err := sdb.LoadType(ctx, name) // register enum
+		if err != nil {
+			t.Fatal(err)
+		}
+		sdb.TypeMap().RegisterType(enumType)
+
+		enumType, err = sdb.LoadType(ctx, "_"+name) // register slice of enum
+		if err != nil {
+			t.Fatal(err)
+		}
+		sdb.TypeMap().RegisterType(enumType)
+	}
+
+	err := db.UserCreate(ctx, UserCreateParams{
+		FirstName: "Alex",
+		LastName:  "Brown",
+		Age:       25,
+		ShirtSize: SizeMedium,
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	// list all users
+	users, err := db.ListUsers(ctx)
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Log(users)
+
+	// list users with large shirt_size
+	usersWithLarge, err := db.ListUsersByShirtSizes(ctx, []Size{SizeLarge})
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Log(usersWithLarge)
+}

examples/enums/postgresql/fixtures.sql

@@ -0,0 +1,4 @@
+INSERT INTO users (first_name, last_name, age, shirt_size)
+VALUES ('John', 'Doe', 42, 'large'),
+    ('Dirk', 'Sample', 23, 'large'),
+    ('Susan', 'Foo', 19, 'small');

examples/enums/postgresql/query.sql

@@ -0,0 +1,10 @@
+-- name: UserCreate :exec
+INSERT INTO users (first_name, last_name, age, shirt_size)
+VALUES ($1, $2, $3, $4);
+
+-- name: ListUsers :many
+SELECT * FROM users;
+
+-- name: ListUsersByShirtSizes :many
+SELECT * FROM users
+WHERE shirt_size = ANY(@shirt_size::size[]);

examples/enums/postgresql/schema.sql

@@ -0,0 +1,9 @@
+CREATE TYPE size AS ENUM('x-small', 'small', 'medium', 'large', 'x-large');
+
+CREATE TABLE users (
+    id bigint NOT NULL GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
+    first_name text NOT NULL,
+    last_name text NOT NULL,
+    age integer NOT NULL,
+    shirt_size size NOT NULL
+);

examples/enums/sqlc.json

@@ -0,0 +1,22 @@
+{
+  "version": "1",
+  "packages": [
+    {
+      "path": "postgresql",
+      "name": "enums",
+      "schema": "postgresql/schema.sql",
+      "queries": "postgresql/query.sql",
+      "engine": "postgresql",
+      "database": {
+        "uri": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/enums"
+      },
+      "rules": [
+        "sqlc/db-prepare"
+      ],
+      "sql_package": "pgx/v5",
+      "emit_json_tags": true,
+      "emit_prepared_queries": true,
+      "emit_interface": true
+    }
+  ]
+}

internal/codegen/golang/enum.go

@@ -15,6 +15,7 @@ type Constant struct {
 
 type Enum struct {
 	Name      string
+	TypeName  string
 	Comment   string
 	Constants []Constant
 	NameTags  map[string]string

internal/codegen/golang/result.go

@@ -27,6 +27,7 @@ func buildEnums(req *plugin.CodeGenRequest) []Enum {
 
 			e := Enum{
 				Name:      StructName(enumName, req.Settings),
+				TypeName:  enum.Name,
 				Comment:   enum.Comment,
 				NameTags:  map[string]string{},
 				ValidTags: map[string]string{},

internal/codegen/golang/templates/template.tmpl

@@ -129,6 +129,12 @@ func All{{ .Name }}Values() []{{ .Name }} {
 {{ end }}
 {{end}}
 
+{{if and (gt (len .Enums) 0) (eq $.SQLDriver.Package "pgx/v5") }}
+var EnumNames = []string{
+	{{range .Enums}}{{printf "%q" .TypeName}},{{end}}
+}
+{{end}}
+
 {{range .Structs}}
 {{if .Comment}}{{comment .Comment}}{{end}}
 type {{.Name}} struct { {{- range .Fields}}