Skip to content

docs: State the PostgreSQL 16 minimum and surface the file storage null change - #876

Merged
developerjamiu merged 7 commits into
serverpod:mainfrom
FXschwartz:5843-postgres-minimum-and-retrievefile-docs
Oct 12, 2026
Merged

developerjamiu merged 7 commits into
serverpod:mainfrom
FXschwartz:5843-postgres-minimum-and-retrievefile-docs

Conversation

@FXschwartz

Copy link
Copy Markdown
Contributor

A 4.0.4 user on Postgres 14 hit a failing integrity check and could not create a repair migration, and separately missed that retrieveFile now throws instead of returning null. Both were documentation gaps. See serverpod/serverpod#5843.

  • Installation and quickstart prerequisites: a self-managed PostgreSQL must be version 16 or later.
  • Upgrade to 4.0: a "Before you start" bullet for the Postgres version, and the production note now says to pick engine version 16 or later.
  • Migrate from legacy auth: "Postgres 14 or later" corrected to 16.
  • Breaking changes in 4.0: the file storage section is retitled to say the methods throw instead of returning null, the lookup table mentions null checks, and the intro notes that an existing null check still compiles with only an analyzer warning.

@FXschwartz
FXschwartz requested a review from a team October 9, 2026 13:26
@FXschwartz FXschwartz self-assigned this Oct 9, 2026
@developerjamiu

Copy link
Copy Markdown
Contributor

Apply the same changes to the five pages in versioned_docs/version-4.0.0/. 4.0.0 is the version served at /, so without them this only shows under /next.

Comment thread docs/04-get-started/01-installation.md Outdated
Comment thread docs/04-get-started/02-quickstart.md Outdated
Comment thread docs/11-upgrading/01-upgrade-to-four.md Outdated
Comment thread docs/11-upgrading/02-breaking-changes-in-four.md Outdated
@developerjamiu

Copy link
Copy Markdown
Contributor

Add the minimum to the #### PostgreSQL section of docs/06-concepts/01-server-fundamentals/03-configuration.md too, in both copies. That's where readers are told to connect an external PostgreSQL in production, and it gives no version. For example: "The external PostgreSQL must be version 16 or later."

@developerjamiu
developerjamiu merged commit bc289af into serverpod:main Oct 12, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants