github.com/jackc/pgx/v5 v5.10.0: Batch

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify pkg:golang/github.com/jackc/pgx/v5@v5.10.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/jackc/pgx/v5@v5.10.0
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@11.8.0
  - runtime: node@24.13.1

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

package sample

import (
	"github.com/jackc/pgx/v5"
)

// BuildBatch creates a pgx.Batch containing the provided queries.
func BuildBatch(queries []string) *pgx.Batch {
	b := &pgx.Batch{}
	for _, q := range queries {
		b.Queue(q)
	}
	return b
}

package sample

import (
	"testing"
)

func TestBuildBatch(t *testing.T) {
	queries := []string{
		"INSERT INTO items (name) VALUES ('item1')",
		"INSERT INTO items (name) VALUES ('item2')",
	}
	batch := BuildBatch(queries)
	if batch.Len() != 2 {
		t.Fatalf("expected batch length 2, got %d", batch.Len())
	}
}

{"case":{"caseId":"case:sha256:fc4e5e34d87a8bb057c7b8039f5b5f0ccb3a25b8ddd4bfea8a564475c8d73429","contract":["Batch.Queue adds SQL statements and parameters into the batch","Batch.Len returns the total count of queued queries","Batch.QueuedQueries maintains the execution order and query arguments"],"goal":"verify pkg:golang/github.com/jackc/pgx/v5@v5.10.0","kind":"HOW","packages":["pkg:golang/github.com/jackc/pgx/v5@v5.10.0"],"schemaVersion":1,"symbols":["Batch"]},"contractCommand":["go","test","./..."],"environment":{"arch":"x64","ecosystem":"golang","language":"go","moduleSystem":"go","os":"windows","osVersionBucket":"11","packageManager":"go","packageManagerVersion":"1.26.5","runtime":"go","runtimeVersion":"1.26.5","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/jackc/pgx/v5@v5.10.0"],"schemaVersion":1,"symbols":["Batch"],"verifierAdapter":"golang@1"}

module sample

go 1.26.5

require github.com/jackc/pgx/v5 v5.10.0

require (
	github.com/jackc/pgpassfile v1.0.0 // indirect
	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
	golang.org/x/text v0.29.0 // indirect
)

github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
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-20240606120523-5a60cdf6a761 h1:iCEnooe7UlwOQYpKFhBabPMi4aNAfoODPEFNiAnClxo=
github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
github.com/jackc/pgx/v5 v5.10.0 h1:VhSvgU2jSli8o3AqIEOTJr7rZwAEUVo4E4XhR94Zfr0=
github.com/jackc/pgx/v5 v5.10.0/go.mod h1:mal1tBGAFfLHvZzaYh77YS/eC6IX9OWbRV1QIIM0Jn4=
github.com/jackc/puddle/v2 v2.2.2 h1:PR8nw+E/1w0GLuRFSmiioY6UooMp6KJv0/61nB7icHo=
github.com/jackc/puddle/v2 v2.2.2/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
golang.org/x/sync v0.17.0 h1:l60nONMj9l5drqw6jlhIELNv9I0A4OFgRsG9k2oT9Ug=
golang.org/x/sync v0.17.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
golang.org/x/text v0.29.0 h1:1neNs90w9YzJ9BocxfsQNHKuAT4pkghyXc4nhZ6sJvk=
golang.org/x/text v0.29.0/go.mod h1:7MhJOA9CD2qZyOKYazxdYMF85OwPdEr9jTtBpO7ydH4=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

{
  "schemaVersion": 1,
  "goal": "verify pkg:golang/github.com/jackc/pgx/v5@v5.10.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/jackc/pgx/v5@v5.10.0"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@11.8.0",
    "runtime": "node@24.13.1"
  }
}

package test

import (
	"testing"

	"github.com/jackc/pgx/v5"
)

func TestBatchQueue(t *testing.T) {
	b := &pgx.Batch{}
	q1 := b.Queue("SELECT id, name FROM users WHERE active = $1", true)
	if q1 == nil {
		t.Fatal("expected non-nil QueuedQuery from Queue")
	}
	if q1.SQL != "SELECT id, name FROM users WHERE active = $1" {
		t.Errorf("unexpected SQL in QueuedQuery: %s", q1.SQL)
	}
	if len(q1.Arguments) != 1 || q1.Arguments[0] != true {
		t.Errorf("unexpected Arguments in QueuedQuery: %v", q1.Arguments)
	}
}

func TestBatchLen(t *testing.T) {
	b := &pgx.Batch{}
	if b.Len() != 0 {
		t.Errorf("expected initial len 0, got %d", b.Len())
	}

	b.Queue("INSERT INTO logs (message) VALUES ($1)", "test message")
	if b.Len() != 1 {
		t.Errorf("expected len 1 after one query, got %d", b.Len())
	}

	b.Queue("UPDATE accounts SET balance = balance + $1 WHERE id = $2", 100, 42)
	if b.Len() != 2 {
		t.Errorf("expected len 2 after two queries, got %d", b.Len())
	}
}

func TestBatchQueuedQueriesOrder(t *testing.T) {
	b := &pgx.Batch{}
	b.Queue("DELETE FROM temp_sessions WHERE expires_at < $1", 1000)
	b.Queue("SELECT COUNT(*) FROM items")

	if len(b.QueuedQueries) != 2 {
		t.Fatalf("expected 2 queued queries, got %d", len(b.QueuedQueries))
	}
	if b.QueuedQueries[0].SQL != "DELETE FROM temp_sessions WHERE expires_at < $1" {
		t.Errorf("expected first query SQL mismatch, got %s", b.QueuedQueries[0].SQL)
	}
	if b.QueuedQueries[1].SQL != "SELECT COUNT(*) FROM items" {
		t.Errorf("expected second query SQL mismatch, got %s", b.QueuedQueries[1].SQL)
	}
}