This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko-persistence-r2dbc.git
The following commit(s) were added to refs/heads/main by this push:
new b17d348 Document only one entry per pid in snapshot store (#305)
b17d348 is described below
commit b17d348e1e5edac51a6c4db71595174aa68d1932
Author: PJ Fanning <[email protected]>
AuthorDate: Thu Jan 29 18:26:53 2026 +0100
Document only one entry per pid in snapshot store (#305)
Update snapshots.md
---
docs/src/main/paradox/snapshots.md | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/docs/src/main/paradox/snapshots.md
b/docs/src/main/paradox/snapshots.md
index f7c1fb3..4e1f1ab 100644
--- a/docs/src/main/paradox/snapshots.md
+++ b/docs/src/main/paradox/snapshots.md
@@ -29,3 +29,11 @@ The following can be overridden in your `application.conf`
for the snapshot spec
The snapshot plugin is used whenever a snapshot write is triggered through the
@extref:[Pekko Persistence APIs](pekko:typed/persistence-snapshot.html).
+
+## Retention
+
+The R2DBC snapshot plugin only ever keeps *one* snapshot per persistence id in
the database.
+If a `keepNSnapshots > 1` is specified for an `EventSourcedBehavior` that
setting will be ignored.
+
+The reason for this is that there is no real benefit to keep multiple
snapshots around on a relational
+database with a high consistency.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
