apache / pekko

Build highly concurrent, distributed, and resilient message-driven applications using Java/Scala
https://pekko.apache.org/
Apache License 2.0
1.17k stars 139 forks source link

add doc changes for DurableState deleteObject #1298

Closed pjfanning closed 3 months ago

pjfanning commented 4 months ago

In pekko 1.1, we are encouraging libs to have a failed future if deleteObject(persistenceId, revision) doesn't delete rows.

https://github.com/apache/pekko/pull/1271

pjfanning commented 4 months ago

@kerr @Roiocam @nvollmar the only mention in our existing docs for DurableState persistence about deletes is

https://pekko.apache.org/docs/pekko/current/typed/durable-state/persistence.html#effects-and-side-effects

I don't know much about Pekko Persistence but this does not appear to relate to the use of the 'deleteObject' API. See https://github.com/apache/pekko/pull/1271. I don't feel especially well qualified to describe the JdbcDurableStateStore API.

Maybe it is enough to just release note the change in #1271 and rely on the Javadoc/Scaladoc for the JdbcDurableStateStore API.

Roiocam commented 4 months ago

I will say it is not the user API, so we don't have to update the documents related to Persistence.

we can update the plugin documents in the https://pekko.apache.org/docs/pekko/current/persistence-journals.html. but it also does not contain durable store.

He-Pin commented 4 months ago

We can only update the how to implement a persistent plug-in part.