Go codegen for ClickHouse, DuckDB, Spanner and SQL Server under database/sql

.github/workflows/ci.yml

@@ -22,6 +22,9 @@ jobs:
         CGO_ENABLED: "0"
         GOOS: ${{ matrix.goos }}
         GOARCH: ${{ matrix.goarch }}
+
+  # sqlc's own tests: the end-to-end suite needs PostgreSQL and MySQL, which
+  # sqlc-test-setup installs on the runner.
   test:
     runs-on: ubuntu-24.04
     steps:
@@ -44,17 +47,17 @@ jobs:
       env:
         CGO_ENABLED: "0"
 
+    # A module of its own, so cgo stays on for the DuckDB driver the
+    # DuckDB golden imports.
     - name: build internal/endtoend
       run: go build ./...
       working-directory: internal/endtoend/testdata
-      env:
-        CGO_ENABLED: "0"
 
     - name: install databases
-      run: go run ./cmd/sqlc-test-setup install
+      run: go run ./cmd/sqlc-test-setup install postgresql mysql
 
     - name: start databases
-      run: go run ./cmd/sqlc-test-setup start
+      run: go run ./cmd/sqlc-test-setup start postgresql mysql
 
     - name: test ./...
       run: gotestsum --junitfile junit.xml -- --tags=examples -timeout 20m -failfast ./...
@@ -66,6 +69,34 @@ jobs:
         MYSQL_SERVER_URI: "root:mysecretpassword@tcp(127.0.0.1:3306)/mysql?multiStatements=true&parseTime=true"
         CGO_ENABLED: "0"
 
+  # The examples run generated code against every database sqlc supports.
+  # They are a module of their own, so their drivers are not dependencies
+  # of sqlc, and cgo stays on for the DuckDB driver. sqlc-test-setup
+  # installs and starts every database on the runner.
+  examples:
+    runs-on: ubuntu-24.04
+    steps:
+    - uses: actions/checkout@v7
+    - uses: actions/setup-go@v7
+      with:
+        go-version: '1.26.5'
+
+    - name: install databases
+      run: go run ./cmd/sqlc-test-setup install
+
+    - name: start databases
+      run: go run ./cmd/sqlc-test-setup start
+
+    - name: test examples
+      run: go test --tags=examples -timeout 20m ./...
+      working-directory: examples
+      env:
+        POSTGRESQL_SERVER_URI: "postgres://postgres:postgres@127.0.0.1:5432/postgres?sslmode=disable"
+        MYSQL_SERVER_URI: "root:mysecretpassword@tcp(127.0.0.1:3306)/mysql?multiStatements=true&parseTime=true"
+        CLICKHOUSE_SERVER_URI: "clickhouse://default:mysecretpassword@127.0.0.1:9000"
+        MSSQL_SERVER_URI: "sqlserver://sa:Mysecretpassword1!@127.0.0.1:1433?encrypt=disable"
+        SPANNER_SERVER_URI: "localhost:15000"
+
   vuln_check:
     runs-on: ubuntu-24.04
     timeout-minutes: 5

CLAUDE.md

@@ -12,7 +12,7 @@ This document provides essential information for working with the sqlc codebase,
 
 ## Database Setup with sqlc-test-setup
 
-The `sqlc-test-setup` tool (`cmd/sqlc-test-setup/`) automates installing and starting PostgreSQL and MySQL for tests. Both commands are idempotent and safe to re-run.
+The `sqlc-test-setup` tool (`cmd/sqlc-test-setup/`) automates installing and starting PostgreSQL, MySQL, ClickHouse, SQL Server and Spanner Omni for tests. Both commands are idempotent and safe to re-run, and take the databases to act on as arguments (`postgresql`, `mysql`, `clickhouse`, `mssql`, `spanner`); with none named they act on all five.
 
 ### Install databases
 
@@ -24,6 +24,9 @@ This will:
 - Configure the apt proxy (if `http_proxy` is set, e.g. in Claude Code remote environments)
 - Install PostgreSQL via apt
 - Download and install MySQL 26.7 from Oracle's deb bundle
+- Download the ClickHouse 25.8 release into the user cache, where goldeneye caches it too
+- Install SQL Server 2025 from Microsoft's apt repository and run its setup, accepting the EULA on your behalf (Ubuntu 22.04 and 24.04 only)
+- Download the Spanner Omni standalone server release into the user cache (linux/amd64 only)
 - Resolve all dependencies automatically
 - Skip anything already installed
 
@@ -36,12 +39,20 @@ go run ./cmd/sqlc-test-setup start
 This will:
 - Start PostgreSQL and configure password auth (`postgres`/`postgres`)
 - Start MySQL via `mysqld_safe` and set root password (`mysecretpassword`)
-- Verify both connections
+- Start a ClickHouse server in the background on localhost, with the default user's password `mysecretpassword`
+- Start SQL Server through systemd, or in the background where there is no systemd, with the sa password `Mysecretpassword1!`
+- Start a Spanner Omni single server in the background, serving plaintext gRPC on port 15000
+- Verify the connections
 - Skip steps that are already done (running services, existing config)
 
 Connection URIs after start:
 - PostgreSQL: `postgres://postgres:postgres@127.0.0.1:5432/postgres?sslmode=disable`
 - MySQL: `root:mysecretpassword@tcp(127.0.0.1:3306)/mysql`
+- ClickHouse: `clickhouse://default:mysecretpassword@127.0.0.1:9000` (`CLICKHOUSE_SERVER_URI`)
+- SQL Server: `sqlserver://sa:Mysecretpassword1!@127.0.0.1:1433?encrypt=disable` (`MSSQL_SERVER_URI`)
+- Spanner Omni: `localhost:15000` (`SPANNER_SERVER_URI`)
+
+The examples' tests for ClickHouse, SQL Server and Spanner read those variables and skip when unset. `docker-compose.yml` runs the same databases for anyone who prefers containers.
 
 ### Run tests
 
@@ -172,9 +183,13 @@ them as an artifact.
 
 ### Example Tests
 
-- **Location:** `/examples/` directory
-- **Requirements:** Tagged with "examples", requires live databases
-- **Databases:** PostgreSQL, MySQL, SQLite examples
+- **Location:** `/examples/` directory, a Go module of its own so the
+  drivers the examples run against are not dependencies of sqlc, and so
+  cgo stays on for the DuckDB driver
+- **Requirements:** Tagged with "examples", requires live databases; run
+  with `cd examples && go test --tags=examples ./...`
+- **Databases:** PostgreSQL, MySQL, SQLite, ClickHouse, DuckDB, Spanner and
+  SQL Server examples; each skips when its server is not named
 
 ## Database Services
 
@@ -207,8 +222,9 @@ make start             # Start database containers
 
 - **File:** `.github/workflows/ci.yml`
 - **Go Version:** 1.26.4
-- **Database Setup:** Uses `sqlc-test-setup` (not Docker) to install and start PostgreSQL and MySQL directly on the runner
-- **Test Command:** `gotestsum --junitfile junit.xml -- --tags=examples -timeout 20m ./...`
+- **Jobs:** `build` cross-compiles sqlc with cgo off; `test` runs sqlc's own tests; `examples` runs the examples module against every database; `vuln_check` runs `govulncheck`
+- **Database Setup:** `sqlc-test-setup` (not Docker) installs and starts the databases directly on the runner: PostgreSQL and MySQL for `test`, and all five for `examples`
+- **Test Command:** `gotestsum --junitfile junit.xml -- --tags=examples -timeout 20m ./...` in `test`, and `go test --tags=examples ./...` under `examples/` in `examples`
 - **Additional Checks:** `govulncheck` for vulnerability scanning
 
 ## Development Workflow

Makefile

@@ -14,9 +14,11 @@ test-managed:
 
 vet:
 	go vet ./...
+	cd ./examples && go vet --tags=examples ./...
 
 test-examples:
 	go test --tags=examples ./...
+	cd ./examples && go test --tags=examples ./...
 
 build-endtoend:
 	cd ./internal/endtoend/testdata && go build ./...