docs: Document the Insights database access flag - #764
Open
FXschwartz wants to merge 1 commit into
Open
Conversation
8 tasks
marcelomendoncasoares
requested changes
Aug 25, 2026
Comment on lines
+93
to
+95
| ### If you use Insights database access | ||
|
|
||
| The Insights endpoints that give database access (`fetchDatabaseBulkData`, `runQueries`, `getDatabaseRowCount`, and `executeSql`) are disabled by default in 4.0 and throw an `AccessDeniedException` until enabled. If you rely on them, for example to browse tables from the Insights app, opt in per environment with `enableDatabaseAccess` in the `insightsServer` block of the config file (or the `SERVERPOD_INSIGHTS_SERVER_ENABLE_DATABASE_ACCESS` environment variable): |
Collaborator
There was a problem hiding this comment.
Suggestion: This section is not completely accurate. The Insights app doesn't use the database endpoints, which must be very clear for users (on every place that we mention the database access flag). It only exists to support custom operations that use the service client.
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
2 participants
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.
Serverpod 4.0 disabled the Insights database access endpoints by default (serverpod/serverpod#5606). Add the
enableDatabaseAccessoption to the Insights page, the 4.0 upgrade guide, and the configuration reference, and note the removed hotReload, getOpenSessionLog, and shutdown methods.