Skip to content

docs: Describe Cloud DB users as database users, not superusers #860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SandPod merged 2 commits into from
Sep 25, 2026
+3 −3
Merged

docs: Describe Cloud DB users as database users, not superusers #860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80d5b58
docs(cloud): describe db users as database users instead of superusers
Zfinix Sep 24, 2026
8c4ba09
docs(cloud): split the direct access sentence on the database page
Zfinix Sep 24, 2026
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
4 changes: 2 additions & 2 deletions cloud_docs/concepts/database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ You can connect to the managed database from your machine, a GUI client, or `psq
The steps:

1. Run `serverpod cloud db connection` to print the host, port, and database name.
2. Run `serverpod cloud db user create <username>` to create a superuser. The password is shown **once**, so save it.
2. Run `serverpod cloud db user create <username>` to create a database user. It can read and write data, but it can't create or change tables. The password is shown **once**, so save it.
3. Connect from your client with the host, port, database, your username, and the saved password.

Both commands need to know which project you're working with. From a project directory that's been linked (any project created with `serverpod cloud launch` is linked automatically), the project ID is picked up from `scloud.yaml`. From anywhere else, pass `-p your-project-id`.
Expand Down Expand Up @@ -87,7 +87,7 @@ The managed database is built so you don't have to think about credentials in yo

- **TLS is required for all connections.** Cloud sets `SERVERPOD_DATABASE_REQUIRE_SSL` to `true` for your server, and the same applies to direct connections from `psql` or a GUI client.
- **The server's password is managed by the platform.** It's never written into your repo and never shown to you. Your server reads it from the injected environment at runtime.
- **Direct access uses separate superusers that you create.** The server's user and the users you create with `serverpod cloud db user create` are distinct, so revoking or rotating a direct-access password does not affect the server.
- **Direct access uses separate database users that you create.** The server connects as its own user, not as one you create with `serverpod cloud db user create`. Revoking or rotating a direct-access password doesn't affect the server.

## Performance

Expand Down
2 changes: 1 addition & 1 deletion cloud_docs/reference/cli/commands/db/_db.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# scloud db

`scloud db` manages your project's database directly: print connection details, create and reset superusers for `psql` or GUI clients, and wipe the database during development. These operations are independent of how your server connects (the server's credentials are injected by Cloud separately).
`scloud db` manages your project's database directly: print connection details, create and reset database users for `psql` or GUI clients, and wipe the database during development. These operations are independent of how your server connects (the server's credentials are injected by Cloud separately).

See [Database](/cloud/concepts/database) for the model, common operations, and security notes around direct access.
Loading