Skip to content

docs: Added documentation on DB row locking functionality#419

Merged
marcelomendoncasoares merged 4 commits intoserverpod:mainfrom
FXschwartz:db-lock-row
Feb 13, 2026
Merged

docs: Added documentation on DB row locking functionality#419
marcelomendoncasoares merged 4 commits intoserverpod:mainfrom
FXschwartz:db-lock-row

Conversation

@FXschwartz
Copy link
Contributor

@FXschwartz FXschwartz commented Feb 13, 2026

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.

Copilot AI review requested due to automatic review settings February 13, 2026 04:41
@FXschwartz FXschwartz changed the title Db lock row docs: Added documentation on DB row locking functionality Feb 13, 2026
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 jsonKey model 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.

Copy link
Collaborator

@marcelomendoncasoares marcelomendoncasoares left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@FXschwartz
Copy link
Contributor Author

@marcelomendoncasoares Comments addressed and ready for another review!

Copy link
Collaborator

@marcelomendoncasoares marcelomendoncasoares left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚀

Thanks for this great contribution, @FXschwartz!

@marcelomendoncasoares marcelomendoncasoares merged commit 421fddd into serverpod:main Feb 13, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants