docs: Add docs for new runtime parameters feature#296
docs: Add docs for new runtime parameters feature#296SandPod merged 6 commits intoserverpod:mainfrom
Conversation
|
Warning Rate limit exceeded@marcelomendoncasoares has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 1 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe documentation was updated to expand guidance on optimizing vector similarity searches, now including advice on tuning runtime parameters. Additionally, a new document was added that introduces and explains the use of runtime parameters in Serverpod for fine-tuning PostgreSQL query execution, with detailed examples and descriptions for vector search optimization. A tip was also added clarifying that Postgres search paths can be set via runtime parameters, which override configuration file settings. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
User->>Docs: Reads about vector similarity search optimization
Docs-->>User: Suggests creating vector indexes and tuning runtime parameters
User->>Docs: Reads runtime parameters documentation
Docs-->>User: Explains global/local parameters, vector search options, and code examples
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
docs/06-concepts/06-database/12-runtime-parameters.md (4)
38-49: Import context for combined groups example
This snippet builds on the previous one but reuses the same types. Recommend adding a note that thepackage:serverpod/serverpod.dartimport applies here as well for clarity.
59-85: Include import for VectorIndexQueryOptions
The general vector optimization example introducesVectorIndexQueryOptionswithout an import. Suggest adding:import 'package:serverpod/serverpod.dart';to the top of the snippet.
107-120: Add import for IVFFLAT options
The IVFFLAT example usesIvfFlatIndexQueryOptionsbut lacks an import. Recommend adding:import 'package:serverpod/serverpod.dart';
124-128: Minor punctuation in enum description
Add a comma for clarity in the relaxed scan description:-Allows slightly out-of-order results but provides better recall. +Allows slightly out-of-order results, but provides better recall.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/06-concepts/06-database/06-filter.md(1 hunks)docs/06-concepts/06-database/12-runtime-parameters.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/06-concepts/06-database/12-runtime-parameters.md
[uncategorized] ~126-~126: Loose punctuation mark.
Context: ... scanning: - IterativeScan.strict: Ensures results are in exact order by d...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~127-~127: Loose punctuation mark.
Context: ...recision). - IterativeScan.relaxed: Allows slightly out-of-order results bu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~127-~127: Possible missing comma found.
Context: ...**: Allows slightly out-of-order results but provides better recall. ## Setting glo...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Test build
🔇 Additional comments (6)
docs/06-concepts/06-database/12-runtime-parameters.md (5)
1-3: Strong title and concise intro
The heading and introduction clearly explain the purpose and benefit of runtime parameters.
5-7: Clear cautionary warning
The warning block effectively highlights risks of tuning database parameters without testing.
9-15: Well-defined parameter scopes
The explanation of global vs. local scopes is precise and easy to follow.
87-104: HNSW optimization snippet is complete
This section includes the import and all necessary details forHnswIndexQueryOptions. No changes needed.
130-152: Caution: internal API import
Importing frompackage:serverpod/src/server/serverpod.dartaccesses internal APIs that may change. Confirm that this is intended and consider warning users about potential breaking changes in future releases.docs/06-concepts/06-database/06-filter.md (1)
274-277: Verify link to runtime parameters
The tip now references[runtime parameters](runtime-parameters). Please confirm this anchor resolves correctly in the generated site.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/06-concepts/06-database/12-runtime-parameters.md (2)
24-35: Add import for Serverpod package in Dart snippet
The Dart example omits the necessary import to useServerpodand related classes. Include this at the top of the snippet:import 'package:serverpod/serverpod.dart';
46-48: Add import for Serverpod package in transaction snippet
The transaction-scoped code snippet also relies onServerpodtypes (session.db,Document). Add at the beginning:import 'package:serverpod/serverpod.dart';
🧹 Nitpick comments (2)
docs/06-concepts/06-database/12-runtime-parameters.md (2)
99-99: Remove trailing colon in heading
Markdown headings should not end with punctuation. Update:#### Using `MapRuntimeParameters`:to:
#### Using `MapRuntimeParameters`
120-120: Remove trailing colon in heading
Markdown headings should not end with punctuation. Update:#### Extending `RuntimeParameters`:to:
#### Extending `RuntimeParameters`
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/06-concepts/06-database/01-connection.md(1 hunks)docs/06-concepts/06-database/12-runtime-parameters.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/06-concepts/06-database/01-connection.md
🧰 Additional context used
🪛 LanguageTool
docs/06-concepts/06-database/12-runtime-parameters.md
[uncategorized] ~17-~17: Possible missing comma found.
Context: ...parameters cannot be set at the session level as this would create inconsistencies be...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~69-~69: Consider replacing this phrase with the adverb “consistently” to avoid wordiness.
Context: ...ps, that will always set all parameters in a consistent way. Existing parameter groups include: -...
(IN_A_X_MANNER)
[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...dle scanning: - IterativeScan.off: Disables iterative scanning, using the ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~260-~260: Loose punctuation mark.
Context: ... behavior. - **IterativeScan.strict`**: Ensures results are in exact order by d...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~261-~261: Loose punctuation mark.
Context: ...recision). - IterativeScan.relaxed: Allows slightly out-of-order results bu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~261-~261: Possible missing comma found.
Context: ...**: Allows slightly out-of-order results but provides better recall. ## Testing wit...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
docs/06-concepts/06-database/12-runtime-parameters.md
78-78: Link fragments should be valid
null
(MD051, link-fragments)
99-99: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
120-120: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Test build
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
docs/06-concepts/06-database/12-runtime-parameters.md (3)
16-17: Fix missing comma for clarity.Insert a comma after “session level” to improve readability:
-Due to connection pooling, runtime parameters cannot be set at the session level as this would create inconsistencies between different database connections. +Due to connection pooling, runtime parameters cannot be set at the session level, as this would create inconsistencies between different database connections.
68-69: Simplify phrasing for conciseness.Replace “in a consistent way” with “consistently”:
-…the builder pattern to create these parameter groups, that will always set all parameters in a consistent way. +…the builder pattern to create these parameter groups that will always set all parameters consistently.
271-272: Use the official package import for the test helper.The relative import may confuse users. Swap it for the published package:
- import 'test_tools/serverpod_test_tools.dart'; + import 'package:serverpod_test/serverpod_test.dart';
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/06-concepts/06-database/12-runtime-parameters.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/06-concepts/06-database/12-runtime-parameters.md
[uncategorized] ~17-~17: Possible missing comma found.
Context: ...parameters cannot be set at the session level as this would create inconsistencies be...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~69-~69: Consider replacing this phrase with the adverb “consistently” to avoid wordiness.
Context: ...ps, that will always set all parameters in a consistent way. Existing parameter groups include: -...
(IN_A_X_MANNER)
[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...dle scanning: - IterativeScan.off: Disables iterative scanning, using the ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~260-~260: Loose punctuation mark.
Context: ... behavior. - **IterativeScan.strict`**: Ensures results are in exact order by d...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~261-~261: Loose punctuation mark.
Context: ...recision). - IterativeScan.relaxed: Allows slightly out-of-order results bu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~261-~261: Possible missing comma found.
Context: ...**: Allows slightly out-of-order results but provides better recall. ## Testing wit...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Test build
SandPod
left a comment
SandPod
left a comment
There was a problem hiding this comment.
LGTM!
Nice an well written documentation, I would only like to see an example of adding an extension directly to params so that the extension looks like a first class citizen.
2 participants
Add docs for the new
setRuntimeParameterfeature as implemented on Serverpod's PR 3627.Summary by CodeRabbit