Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ docker build -f Dockerfile-17 -t supabase-postgres:17 .

Now that you understand the basics of Supabase Postgres:

* Check the [Installation Guide](https://github.com/supabase/postgres/wiki) for deployment options
* Check the [build guide](nix/docs/build-postgres.md) and [Docker docs](nix/docs/docker.md) for deployment options
* Explore the [Extension Documentation](#) to learn about available extensions
* Review [Contributing Guidelines](CONTRIBUTING.md) if you want to contribute
* Join the [Supabase Community](https://github.com/supabase/postgres/discussions) for questions and discussions
Expand All @@ -174,7 +174,7 @@ Now that you understand the basics of Supabase Postgres:

* **GitHub Issues** - For bugs and feature requests
* **Discussions** - For questions and general discussion
* **Wiki** - For detailed documentation
* **[nix/docs](nix/docs/README.md)** - For detailed documentation
* **Discord** - For real-time chat with the community

---
Expand Down Expand Up @@ -301,10 +301,9 @@ This is the same PostgreSQL build that powers [Supabase](https://supabase.io), b

## Install

See all installation instructions in the [repo wiki](https://github.com/supabase/postgres/wiki).
See the [documentation index](nix/docs/README.md) for installation instructions.

[![Docker](https://github.com/supabase/postgres/blob/develop/docs/img/docker.png)](https://github.com/supabase/postgres/wiki/Docker)
[![AWS](https://github.com/supabase/postgres/blob/develop/docs/img/aws.png)](https://github.com/supabase/postgres/wiki/AWS-EC2)
[![Docker](https://github.com/supabase/postgres/blob/develop/docs/img/docker.png)](nix/docs/docker.md)

<!-- ### Marketplace Images
TODO: find way to automate this
Expand Down
8 changes: 4 additions & 4 deletions nix/docs/build-postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,19 +97,19 @@ _new_ hash.
The ability to refer to a piece of data by its hash, by some notion of
_content_, is a very powerful primitive, as we'll see later.

## Build a different version: v16
## Build a different version: v17

What if we wanted PostgreSQL 16 and plugins? Just replace `_15` with `_16`:
What if we wanted PostgreSQL 17 and plugins? Just replace `_15` with `_17`:

```
nix build .#psql_16.bin
nix build .#psql_17.bin
```

You're done:

```
$ readlink result
/nix/store/p7ziflx0000s28bfb213jsghrczknkc4-postgresql-and-plugins-14.8
/nix/store/p7ziflx0000s28bfb213jsghrczknkc4-postgresql-and-plugins-17.6

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure how much it really matters but I don't think the nix store path changes only in the version number at the end here. Can you update with correct hash?

```


Expand Down
10 changes: 5 additions & 5 deletions nix/docs/migration-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The arguments are:

The versions for upgrading can be one of two forms:

- A major version number, e.g. `14` or `15`
- A major version number, e.g. `15` or `17`
- A path to `/nix/store`, which points to _any_ version of PostgreSQL, as long
as it has the "expected" layout and is a postgresql install.

Expand All @@ -35,16 +35,16 @@ the runbook on [running the server & client](./start-client-server.md) to refer
to arbitrary git revisions.

For example, if you updated an extension in this repository, and you want to
test a migration from PostgreSQL 14 to PostgreSQL 14 + (updated extension),
test a migration from PostgreSQL 15 to PostgreSQL 15 + (updated extension),
using `pg_upgrade` &mdash; simply record the two git commits you want to
compare, and you could do something like the following:

```
OLD_GIT_VERSION=...
NEW_GIT_VERSION=...

nix run github:supabase/nix-postgres#migration-test \
$(nix build "github:supabase/nix-postgres/$OLD_GIT_VERSION#psql_14.bin") \
$(nix build "github:supabase/nix-postgres/$NEW_GIT_VERSION#psql_14.bin") \
nix run github:supabase/postgres#migration-test \
$(nix build --print-out-paths --no-link "github:supabase/postgres/$OLD_GIT_VERSION#psql_15/bin") \
$(nix build --print-out-paths --no-link "github:supabase/postgres/$NEW_GIT_VERSION#psql_15/bin") \
pg_upgrade
```
2 changes: 1 addition & 1 deletion nix/docs/nix-directory-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ Directory containing custom package definitions such as:
- `start-replica.nix` - Replication tools
- `migrate-tool.nix` - Migration utilities
- `dbmate-tool.nix` - Database migration tool
- `postgres.nix` - Postgres extension registry and ourExtensions list

#### `nix/checks.nix`

Expand All @@ -132,7 +133,6 @@ PostgreSQL package definitions:

PostgreSQL extensions:

- `default.nix` - Extension registry and ourExtensions list
- Individual `.nix` files - Extension definitions like:
- `pgvector.nix` - Vector similarity search
- `pgsodium.nix` - Encryption extension
Expand Down
Loading