Migrate from pq to pgx v5 as default postgres driver

Author: kefniark

Readme.md

@@ -21,17 +21,18 @@ This is inspired by [SQLC](https://github.com/sqlc-dev/sqlc) but pushes the idea
 * **Safe**: All the SQL queries use prepared statement to avoid injection
 * **Consistent**: Easy to use transaction API to rollback when an error occurs
 
-## Status
+## Getting Started
 
-This repostiroy is currently a WIP, features are still not complete and may likely change
+```sh
+# Install MangoSQL CLI
+go install github.com/kefniark/mango-sql/cmd/mangosql
 
-Roadmap:
-* Handle custom queries for advanced relations (join, aggregations, ...)
-* Handle sql enums
-* Handle sql views
-* Support more types and custom types (cf ulid, ...)
-* Support more driver and database Mysql/MariaDB/Sqlite3
-* Write benchmark to compare performance with existing Golang ORM
+# Use mango to generate a DB Client (by default ./database/client.go)
+mangosql ./database/schema.sql
+
+# Generated Go Code can be output somewhere else
+mangosql --output ./mydb/myclient.go --package mydb ./database/schema.sql
+```
 
 ## Example 
 
@@ -101,6 +102,18 @@ user.Save(db)
 
 ```
 
+## Status
+
+This repository is currently a WIP, features are still not complete and may likely change
+
+Roadmap:
+* Handle custom queries for advanced relations (join, aggregations, ...)
+* Handle sql enums
+* Handle sql views
+* Support more types and custom types (cf ulid, ...)
+* Support more driver and database Mysql/MariaDB/Sqlite3
+* Write benchmark to compare performance with existing Golang ORM
+
 ## API
 
 Here is the list of all the auto-generated methods for your tables:

cmd/mangosql/main.go

@@ -34,6 +34,11 @@ Example: mangosql --output db/file.go db/schema.sql`,
 				Value: "database",
 				Usage: "Go Package",
 			},
+			&cli.StringFlag{
+				Name:  "driver",
+				Value: "pgx",
+				Usage: "SQL Driver",
+			},
 		},
 		Action: func(ctx *cli.Context) error {
 			if ctx.NArg() <= 0 {
@@ -45,6 +50,7 @@ Example: mangosql --output db/file.go db/schema.sql`,
 				Src:     name,
 				Output:  ctx.String("output"),
 				Package: ctx.String("package"),
+				Driver:  ctx.String("driver"),
 			})
 		},
 	}
@@ -58,6 +64,7 @@ type GenerateOptions struct {
 	Src     string
 	Output  string
 	Package string
+	Driver  string
 }
 
 func generate(opts GenerateOptions) error {
@@ -103,7 +110,7 @@ func generate(opts GenerateOptions) error {
 	var b bytes.Buffer
 	contents := bufio.NewWriter(&b)
 
-	if err = internal.Generate(schema, contents, opts.Package); err != nil {
+	if err = internal.Generate(schema, contents, opts.Package, opts.Driver); err != nil {
 		return err
 	}
 

go.mod

@@ -8,7 +8,6 @@ require (
 	github.com/gertd/go-pluralize v0.2.1
 	github.com/google/uuid v1.6.0
 	github.com/iancoleman/strcase v0.3.0
-	github.com/jackc/pgx v3.6.2+incompatible
 	github.com/jackc/pgx/v5 v5.5.5
 	github.com/jmoiron/sqlx v1.4.0
 	github.com/lib/pq v1.10.9
@@ -32,12 +31,10 @@ require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dustin/go-humanize v1.0.1 // indirect
 	github.com/getsentry/raven-go v0.2.0 // indirect
-	github.com/gofrs/uuid v4.4.0+incompatible // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway v1.16.0 // indirect
-	github.com/jackc/fake v0.0.0-20150926172116-812a484cc733 // indirect
 	github.com/jackc/pgpassfile v1.0.0 // indirect
 	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
 	github.com/jackc/puddle/v2 v2.2.1 // indirect

go.sum

@@ -79,8 +79,6 @@ github.com/go-sql-driver/mysql v1.8.1/go.mod h1:wEBSXgmK//2ZFJyE+qWnIsVGmvmEKlqw
 github.com/gobwas/httphead v0.0.0-20180130184737-2c6c146eadee/go.mod h1:L0fX3K22YWvt/FAX9NnzrNzcI4wNYi9Yku4O0LKYflo=
 github.com/gobwas/pool v0.2.0/go.mod h1:q8bcK0KcYlCgd9e7WYLm9LpyS+YeLd8JVDW6WezmKEw=
 github.com/gobwas/ws v1.0.2/go.mod h1:szmBTxLgaFppYjEmNtny/v3w89xOydFnnZMcgRRu/EM=
-github.com/gofrs/uuid v4.4.0+incompatible h1:3qXRTX8/NbyulANqlc0lchS1gqAVxRgsuW1YrTJupqA=
-github.com/gofrs/uuid v4.4.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM=
 github.com/gogo/googleapis v0.0.0-20180223154316-0cd9801be74a/go.mod h1:gf4bu3Q80BeJ6H1S1vYPm8/ELATdvryBaNFGgqEef3s=
 github.com/gogo/protobuf v1.2.0/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ=
 github.com/gogo/protobuf v1.3.1/go.mod h1:SlYgWuQ5SjCEi6WLHjHCa1yvBfUnHcTbrrZtXPKa29o=
@@ -134,14 +132,10 @@ github.com/iris-contrib/blackfriday v2.0.0+incompatible/go.mod h1:UzZ2bDEoaSGPbk
 github.com/iris-contrib/go.uuid v2.0.0+incompatible/go.mod h1:iz2lgM/1UnEf1kP0L/+fafWORmlnuysV2EMP8MW+qe0=
 github.com/iris-contrib/i18n v0.0.0-20171121225848-987a633949d0/go.mod h1:pMCz62A0xJL6I+umB2YTlFRwWXaDFA0jy+5HzGiJjqI=
 github.com/iris-contrib/schema v0.0.1/go.mod h1:urYA3uvUNG1TIIjOSCzHr9/LmbQo8LrOcOqfqxa4hXw=
-github.com/jackc/fake v0.0.0-20150926172116-812a484cc733 h1:vr3AYkKovP8uR8AvSGGUK1IDqRa5lAAvEkZG1LKaCRc=
-github.com/jackc/fake v0.0.0-20150926172116-812a484cc733/go.mod h1:WrMFNQdiFJ80sQsxDoMokWK1W5TQtxBFNpzWTD84ibQ=
 github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
 github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
 github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
 github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
-github.com/jackc/pgx v3.6.2+incompatible h1:2zP5OD7kiyR3xzRYMhOcXVvkDZsImVXfj+yIyTQf3/o=
-github.com/jackc/pgx v3.6.2+incompatible/go.mod h1:0ZGrqGqkRlliWnWB4zKnWtjbSWbGkVEFm4TeybAXq+I=
 github.com/jackc/pgx/v5 v5.5.5 h1:amBjrZVmksIdNjxGW/IiIMzxMKZFelXbUoPNb+8sjQw=
 github.com/jackc/pgx/v5 v5.5.5/go.mod h1:ez9gk+OAat140fv9ErkZDYFWmXLfV+++K0uAOiwgm1A=
 github.com/jackc/puddle/v2 v2.2.1 h1:RhxXJtFG022u4ibrCSMSiu5aOq1i77R3OHKNJj77OAk=
@@ -253,8 +247,6 @@ github.com/sclevine/agouti v3.0.0+incompatible/go.mod h1:b4WX9W9L1sfQKXeJf1mUTLZ
 github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
 github.com/sethvargo/go-retry v0.2.4 h1:T+jHEQy/zKJf5s95UkguisicE0zuF9y7+/vgz08Ocec=
 github.com/sethvargo/go-retry v0.2.4/go.mod h1:1afjQuvh7s4gflMObvjLPaWgluLLyhA1wmVZ6KLpICw=
-github.com/shopspring/decimal v1.3.1 h1:2Usl1nmF/WZucqkFZhnfFYxxxu8LG21F6nPQBE5gKV8=
-github.com/shopspring/decimal v1.3.1/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o=
 github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
 github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrfsX/uA88=
 github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=

internal/generator.go

@@ -22,23 +22,18 @@ var templates embed.FS
 
 var plural = pluralize.NewClient()
 
-func Generate(schema *SQLSchema, contents io.Writer, pkg string) error {
-	headerTmpl, err := template.ParseFS(templates, "templates/header.tmpl")
+func Generate(schema *SQLSchema, contents io.Writer, pkg string, driver string) error {
+	headerTmpl, err := template.ParseFS(templates, fmt.Sprintf("templates/header_%s.tmpl", driver))
 	if err != nil {
 		return err
 	}
 
-	factoryTmpl, err := template.ParseFS(templates, "templates/factory.tmpl")
+	factoryTmpl, err := template.ParseFS(templates, fmt.Sprintf("templates/factory_%s.tmpl", driver))
 	if err != nil {
 		return err
 	}
 
-	// ctxConstTmpl, err := template.ParseFS(templates, "templates/ctx_const.tmpl")
-	// if err != nil {
-	// 	return err
-	// }
-
-	ctxTmpl, err := template.ParseFS(templates, "templates/ctx.tmpl")
+	ctxTmpl, err := template.ParseFS(templates, fmt.Sprintf("templates/ctx_%s.tmpl", driver))
 	if err != nil {
 		return err
 	}

internal/templates/ctx_const.tmpl

@@ -0,0 +1,9 @@
+const (
+{{ .Const }}
+)
+
+type DBContext struct {
+    db DB_PGX
+    tx pgx.Tx
+}
+

internal/templates/ctx_pgx.tmpl

@@ -25,9 +25,7 @@ type CustomQueries struct {
             return nil, err
         }
 
-        entries := []{{ .NameNormalized }}Model{}
-        err = q.ctx.queryMany(&entries, sql, args...)
-        return entries, err
+        return QueryMany[{{ .NameNormalized }}Model](q.ctx, sql, args...)
     }
 
     type {{ .NameNormalized }}Model struct {