Jan 23, 2025 · Jan 23, 2025 · Jan 23, 2025 · Jan 23, 2025
diff --git a/coderd/database/gen/dump/main.go b/coderd/database/gen/dump/main.go
 "path/filepath"
 "runtime"

 "golang.org/x/xerrors"

 "github.com/coder/coder/v2/coderd/database/dbtestutil"
 "github.com/coder/coder/v2/coderd/database/migrations"
 )
 }
 }()

 connection, cleanup, err := dbtestutil.OpenContainerized(t, dbtestutil.DBContainerOptions{})
 if err != nil {
 panic(err)
 connection := os.Getenv("DB_DUMP_CONNECTION_URL")
 if connection == "" {
 var cleanup func()
 var err error
 connection, cleanup, err = dbtestutil.OpenContainerized(t, dbtestutil.DBContainerOptions{})
 if err != nil {
 err = xerrors.Errorf("open containerized database failed: %w", err)
 panic(err)
 }
 defer cleanup()
 }
 defer cleanup()

 db, err := sql.Open("postgres", connection)
 if err != nil {
 err = xerrors.Errorf("open database failed: %w", err)
 panic(err)
 }
 defer db.Close()

 err = migrations.Up(db)
 if err != nil {
 err = xerrors.Errorf("run migrations failed: %w", err)
 panic(err)
 }

 dumpBytes, err := dbtestutil.PGDumpSchemaOnly(connection)
 if err != nil {
 err = xerrors.Errorf("dump schema failed: %w", err)
 panic(err)
 }

 }
 err = os.WriteFile(filepath.Join(mainPath, "..", "..", "..", "dump.sql"), append(preamble, dumpBytes...), 0o600)
 if err != nil {
 err = xerrors.Errorf("write dump failed: %w", err)
 panic(err)
 }
 }
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
 - [`pg_dump`](https://stackoverflow.com/a/49689589)
  - on macOS, run `brew install libpq zstd`
  - on Linux, install [`zstd`](https://github.com/horta/zstd.install)
 - PostgreSQL 13 (optional if Docker is available)
  - *Note*: If you are using Docker, you can skip this step
  - on macOS, run `brew install postgresql@13` and `brew services start postgresql@13`
  - To enable schema generation with non-containerized PostgreSQL, set the following environment variable:
    - `export DB_DUMP_CONNECTION_URL="postgres://postgres@localhost:5432/postgres?password=postgres&sslmode=disable"`
 - `pkg-config`
  - on macOS, run `brew install pkg-config`
 - `pixman`
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,6 +7,8 @@ import (
		"path/filepath"
		"runtime"

		"golang.org/x/xerrors"

		"github.com/coder/coder/v2/coderd/database/dbtestutil"
		"github.com/coder/coder/v2/coderd/database/migrations"
		)
Expand DownExpand Up		@@ -37,25 +39,34 @@ func main() {
		}
		}()

		connection, cleanup, err := dbtestutil.OpenContainerized(t, dbtestutil.DBContainerOptions{})
		if err != nil {
		panic(err)
		connection := os.Getenv("DB_DUMP_CONNECTION_URL")
		if connection == "" {
		var cleanup func()
		var err error
		connection, cleanup, err = dbtestutil.OpenContainerized(t, dbtestutil.DBContainerOptions{})
		if err != nil {
		err = xerrors.Errorf("open containerized database failed: %w", err)
		panic(err)
		}
		defer cleanup()
		}
		defer cleanup()

		db, err := sql.Open("postgres", connection)
		if err != nil {
		err = xerrors.Errorf("open database failed: %w", err)
		panic(err)
		}
		defer db.Close()

		err = migrations.Up(db)
		if err != nil {
		err = xerrors.Errorf("run migrations failed: %w", err)
		panic(err)
		}

		dumpBytes, err := dbtestutil.PGDumpSchemaOnly(connection)
		if err != nil {
		err = xerrors.Errorf("dump schema failed: %w", err)
		panic(err)
		}

Expand All		@@ -65,6 +76,7 @@ func main() {
		}
		err = os.WriteFile(filepath.Join(mainPath, "..", "..", "..", "dump.sql"), append(preamble, dumpBytes...), 0o600)
		if err != nil {
		err = xerrors.Errorf("write dump failed: %w", err)
		panic(err)
		}
		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -72,6 +72,11 @@ the following tools by hand:
		- [`pg_dump`](https://stackoverflow.com/a/49689589)
		- on macOS, run `brew install libpq zstd`
		- on Linux, install [`zstd`](https://github.com/horta/zstd.install)
		- PostgreSQL 13 (optional if Docker is available)
		- Note: If you are using Docker, you can skip this step
		- on macOS, run `brew install postgresql@13` and `brew services start postgresql@13`
		- To enable schema generation with non-containerized PostgreSQL, set the following environment variable:
		- `export DB_DUMP_CONNECTION_URL="postgres://postgres@localhost:5432/postgres?password=postgres&sslmode=disable"`
Comment on lines +75 to +79 Copy link Member johnstcnJan 23, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Maybe add a warning note regarding`pg_dump` version compatibility: `DB_DUMP_CONNECTION_URL='postgresql://user:pass@ds918.home:5433/coder_tmp?sslmode=disable' make genpg_dump: error: server version: 16.2 (Debian 16.2-1.pgdg120+2); pg_dump version: 13.18pg_dump: error: aborting because of server version mismatchpanic: dump schema failed: exit status 1goroutine 1 [running]:main.main() /Users/cian/src/coder/coder/coderd/database/gen/dump/main.go:70 +0x354exit status 2make: * [Makefile:618: coderd/database/dump.sql] Error 1` Copy link MemberAuthor mafredri**Jan 23, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. I think this is an unlikely scenario, you can use`pg_dump@16` with`postgresql@13` but not vice-versa as you saw here. Since we're advising to use an older postgresql server here, you'd really have to make an effort to use an even older`pg_dump` 😄 johnstcn reacted with thumbs up emoji
		- `pkg-config`
		- on macOS, run `brew install pkg-config`
		- `pixman`
Expand Down