docs: Added documentation on DB row locking functionality#419
docs: Added documentation on DB row locking functionality#419marcelomendoncasoares merged 4 commits intoserverpod:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds new documentation for database row-level locking and expands the models documentation with support for JSON key aliasing, helping developers work more safely with concurrent DB updates and integrate with external JSON formats.
Changes:
- Added a new “Row locking” database concept page with examples for lock modes and lock behaviors.
- Documented the
jsonKeymodel field option for JSON serialization/deserialization aliasing. - Updated the models keyword reference table to include
jsonKey.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/06-concepts/06-database/13-row-locking.md | New guide explaining how to lock rows via reads and via lockRows, including lock modes/behaviors. |
| docs/06-concepts/02-models.md | New section documenting jsonKey and adds it to the keyword reference table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
marcelomendoncasoares
left a comment
There was a problem hiding this comment.
Nice work with the docs, @FXschwartz! A couple of comments for improvement. Also, it seems that there is an unrelated change bundled in for the JSON key alias - that is already released.
|
@marcelomendoncasoares Comments addressed and ready for another review! |
marcelomendoncasoares
left a comment
There was a problem hiding this comment.
LGTM! 🚀
Thanks for this great contribution, @FXschwartz!
Cover usage over PR - serverpod/serverpod#4680
@marcelomendoncasoares Docs submitted for the DB row locking functionality! Let me know what kind of changes you'd like made.