docs: Document embedded PostgreSQL#704
Open
marcelomendoncasoares wants to merge 5 commits into
Open
Conversation
Break the section into subsections instead of a run of paragraphs, point at the configuration page rather than repeating what dataPath does, phrase the recovery and transport behavior in terms of what the reader observes, and use noun-shaped section titles like the rest of the page.
Rewriting the connection page around the embedded database displaced the Docker instructions, which are still the alternative for anyone who wants to run Postgres themselves. Restore that page and give embedded PostgreSQL a short reference page of its own instead: what it is, how the dataPath setting turns it on, where the files live, what happens on start, how to reset it, and why it stays out of production.
The server talks to the embedded database over a Unix socket, so psql and pgAdmin cannot reach it while it runs that way. Point at 'serverpod database start', which serves the same database over TCP.
marcelomendoncasoares
marked this pull request as ready for review
July 21, 2026 20:42
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Embedded PostgreSQL is the default for the
developmentandtestrun modes in new projects, and the configuration page introducesdataPath, but nothing explained what the setting actually does, where the files live, or when to move off it. This fills that in on the database connection page.Changes
dataPathstarts, and link to the configuration page rather than repeating it.dataPath, with a warning about the data loss.serverpod_embedded_postgresdirectly:start, transports, connection details,attach,prefetch,stop,reset, and the sealed exception type.SERVERPOD_DATABASE_DATA_PATHrow in the configuration reference.Reference