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/incubator-pekko-persistence-r2dbc.git
The following commit(s) were added to refs/heads/main by this push:
new 3fc28f1 add migration guide (#73)
3fc28f1 is described below
commit 3fc28f10a4570c9834495fef1d104a2dbd07fb44
Author: PJ Fanning <[email protected]>
AuthorDate: Sat Dec 9 14:48:12 2023 +0100
add migration guide (#73)
---
docs/src/main/paradox/index.md | 5 +++--
docs/src/main/paradox/migration-guides.md | 23 +++++++++++++++++++++++
docs/src/main/paradox/migration.md | 2 +-
docs/src/main/paradox/release-notes.md | 1 +
4 files changed, 28 insertions(+), 3 deletions(-)
diff --git a/docs/src/main/paradox/index.md b/docs/src/main/paradox/index.md
index a21aae2..bbe26bb 100644
--- a/docs/src/main/paradox/index.md
+++ b/docs/src/main/paradox/index.md
@@ -15,9 +15,10 @@ The Pekko Persistence R2DBC plugin allows for using SQL
database with R2DBC as a
* [Durable State Plugin](durable-state-store.md)
* [Query Plugin](query.md)
* [Projection](projection.md)
-* [Migration tool](migration.md)
-* [Contributing](contributing.md)
+* [Migration Tool](migration.md)
+* [Migration Guides](migration-guides.md)
* [Release Notes](release-notes.md)
+* [Contributing](contributing.md)
@@@
diff --git a/docs/src/main/paradox/migration-guides.md
b/docs/src/main/paradox/migration-guides.md
new file mode 100644
index 0000000..aa6017c
--- /dev/null
+++ b/docs/src/main/paradox/migration-guides.md
@@ -0,0 +1,23 @@
+# Migration Guides
+
+Apache Pekko Persistence R2DBC 1.0.0 is based on Akka Persistence R2DBC 0.7.7.
+
+## Migration to Apache Pekko
+
+These migration notes are designed for users migrating from Akka Persistence
R2DBC 0.7.7 to Persistence R2DBC 1.0
+and assume a basic level of Akka experience. Please feel free to submit an
issue or a patch if you feel like the notes can be improved.
+
+One of the main differences is that the database tables used by
`pekko-projection-r2dbc` have been renamed to
+remove the `akka` prefixes
([PR71](https://github.com/apache/incubator-pekko-persistence-r2dbc/pull/71)).
+
+The table names that `pekko-projection-r2dbc` expects to find can be changed
using [configuration settngs](https://github.com/lightbend/config).
+
+Users migrating from Akka who want to reuse the pre-existing tables could set
a config like:
+
+```HOCON
+pekko.projection.r2dbc.offset-store {
+ offset-table = "akka_projection_offset_store"
+ timestamp-offset-table = "akka_projection_timestamp_offset_store"
+ management-table = "akka_projection_management"
+}
+```
diff --git a/docs/src/main/paradox/migration.md
b/docs/src/main/paradox/migration.md
index 44599fa..d12ba56 100644
--- a/docs/src/main/paradox/migration.md
+++ b/docs/src/main/paradox/migration.md
@@ -1,4 +1,4 @@
-# Migration tool
+# Migration Tool
There is a migration tool that is useful if you would like to migrate from
another Pekko Persistence plugin
to the R2DBC plugin. It has been tested with Pekko Persistence JDBC as source
plugin, but it should work with
diff --git a/docs/src/main/paradox/release-notes.md
b/docs/src/main/paradox/release-notes.md
index a319757..3e7f6ec 100644
--- a/docs/src/main/paradox/release-notes.md
+++ b/docs/src/main/paradox/release-notes.md
@@ -1,6 +1,7 @@
# Release Notes
## 1.0.0
+
Apache Pekko Persistence R2DBC 1.0.0 is based on Akka Persistence R2DBC 0.7.7.
Pekko came about as a result of Lightbend's
decision to make future Akka releases under a [Business Software
License](https://www.lightbend.com/blog/why-we-are-changing-the-license-for-akka),
a license that is not compatible with Open Source usage.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
