docs(examples): Update examples to use pgx/v5 (#2863)

* docs: Update examples to use pgx/v5 * test: Update example tests to work correctly with pgx v5 * test: Fix examples tests
sqlc-dev · Oct 17, 2023 · 795bbc7 · 795bbc7
1 parent 1ac6f19
commit 795bbc7
Show file tree

Hide file tree

Showing 21 changed files with 108 additions and 114 deletions.
diff --git a/examples/authors/postgresql/db.go b/examples/authors/postgresql/db.go
diff --git a/examples/authors/postgresql/db_test.go b/examples/authors/postgresql/db_test.go
@@ -5,23 +5,23 @@ package authors
 
 import (
 	"context"
-	"database/sql"
 	"testing"
 
-	_ "github.com/lib/pq"
+	"github.com/jackc/pgx/v5"
+	"github.com/jackc/pgx/v5/pgtype"
 
 	"github.com/sqlc-dev/sqlc/internal/sqltest/hosted"
 )
 
 func TestAuthors(t *testing.T) {
+	ctx := context.Background()
 	uri := hosted.PostgreSQL(t, []string{"schema.sql"})
-	db, err := sql.Open("postgres", uri)
+	db, err := pgx.Connect(ctx, uri)
 	if err != nil {
 		t.Fatal(err)
 	}
-	defer db.Close()
+	defer db.Close(ctx)
 
-	ctx := context.Background()
 	q := New(db)
 
 	// list all authors
@@ -34,7 +34,7 @@ func TestAuthors(t *testing.T) {
 	// create an author
 	insertedAuthor, err := q.CreateAuthor(ctx, CreateAuthorParams{
 		Name: "Brian Kernighan",
-		Bio:  sql.NullString{String: "Co-author of The C Programming Language and The Go Programming Language", Valid: true},
+		Bio:  pgtype.Text{String: "Co-author of The C Programming Language and The Go Programming Language", Valid: true},
 	})
 	if err != nil {
 		t.Fatal(err)

diff --git a/examples/authors/postgresql/models.go b/examples/authors/postgresql/models.go
diff --git a/examples/authors/postgresql/query.sql.go b/examples/authors/postgresql/query.sql.go
diff --git a/examples/authors/sqlc.yaml b/examples/authors/sqlc.yaml
@@ -15,6 +15,7 @@ sql:
   gen:
     go:
       package: authors
+      sql_package: pgx/v5
       out: postgresql
 - schema: mysql/schema.sql
   queries: mysql/query.sql
@@ -45,4 +46,4 @@ rules:
   rule: "postgresql.explain.plan.total_cost > 300.0"
 - name: mysql-query-too-costly
   message: "Too costly"
-  rule: "has(mysql.explain.query_block.cost_info) && double(mysql.explain.query_block.cost_info.query_cost) > 2.0"
+  rule: "has(mysql.explain.query_block.cost_info) && double(mysql.explain.query_block.cost_info.query_cost) > 2.0"
diff --git a/examples/batch/postgresql/batch.go b/examples/batch/postgresql/batch.go
diff --git a/examples/batch/postgresql/db.go b/examples/batch/postgresql/db.go
diff --git a/examples/batch/postgresql/db_test.go b/examples/batch/postgresql/db_test.go
@@ -8,7 +8,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/jackc/pgx/v4"
+	"github.com/jackc/pgx/v5"
+	"github.com/jackc/pgx/v5/pgtype"
 	"github.com/sqlc-dev/sqlc/internal/sqltest/hosted"
 )
 
@@ -31,7 +32,7 @@ func TestBatchBooks(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	now := time.Now()
+	now := pgtype.Timestamptz{Time: time.Now(), Valid: true}
 
 	// batch insert new books
 	newBooksParams := []CreateBookParams{
@@ -114,7 +115,7 @@ func TestBatchBooks(t *testing.T) {
 	})
 
 	for _, book := range books0 {
-		t.Logf("Book %d (%s): %s available: %s\n", book.BookID, book.BookType, book.Title, book.Available.Format(time.RFC822Z))
+		t.Logf("Book %d (%s): %s available: %s\n", book.BookID, book.BookType, book.Title, book.Available.Time.Format(time.RFC822Z))
 		author, err := dq.GetAuthor(ctx, book.AuthorID)
 		if err != nil {
 			t.Fatal(err)

diff --git a/examples/batch/postgresql/models.go b/examples/batch/postgresql/models.go
diff --git a/examples/batch/postgresql/querier.go b/examples/batch/postgresql/querier.go
diff --git a/examples/batch/postgresql/query.sql.go b/examples/batch/postgresql/query.sql.go
diff --git a/examples/batch/sqlc.json b/examples/batch/sqlc.json
@@ -19,7 +19,7 @@
       "rules": [
         "sqlc/db-prepare"
       ],
-      "sql_package": "pgx/v4",
+      "sql_package": "pgx/v5",
       "emit_json_tags": true,
       "emit_prepared_queries": true,
       "emit_interface": true

diff --git a/examples/booktest/postgresql/db.go b/examples/booktest/postgresql/db.go