GH-806 - Reference documentation for archiving event publication completion mode.

Author: odrotbohm

src/docs/antora/modules/ROOT/pages/appendix.adoc

@@ -19,8 +19,15 @@
 Can either be the class name of a custom implementation of `ApplicationModuleDetectionStrategy` or `direct-subpackages` (which is also the final fallback if nothing is configured) or `explicitly-annotated` to only select packages explicitly annotated with `@ApplicationModule` or jMolecules' `@Module`. See xref:fundamentals.adoc#customizing-modules[Customize Application Module Detection] for details.
 
 |`spring.modulith.events.completion-mode`
-|`UPDATE`
-|How to mark event publications as completed. The default sets the completion date on the database entry, `DELETE` removes the entry right away. For details, see xref:events.adoc#publication-registry.completion[Event Publication Completion].
+|`update`
+a|How to mark an event publication as completed.
+The following values are supported:
+
+* `update` (default) -- Sets the completion date on the event publication entry.
+* `delete` -- Removes the event publication entry.
+Completed event publications are not available via `CompletedEventPublications`.
+* `archive` -- Removes the event publication entry from the primary database abstraction (table, collection or node) and creates one in a archive (a table, collection or node of same schema).
+For details, see xref:events.adoc#publication-registry.completion[Event Publication Completion].
 
 |`spring.modulith.events.externalization.enabled`
 |`true`

src/docs/antora/modules/ROOT/pages/events.adoc

@@ -286,11 +286,15 @@ This means that completed publications will remain in the Event Publication Regi
 A consequence of this is that you'll need to put some code in place that will periodically purge old, completed ``EventPublication``s.
 Otherwise, the persistent abstraction of them, for example a relational database table, will grow unbounded and the interaction with the store creating and completing new ``EventPublication`` might slow down.
 
-Spring Modulith 1.3 introduces a configuration property `spring.modulith.events.completion-mode`.
+Spring Modulith 1.3 introduces a configuration property `spring.modulith.events.completion-mode` to support two additional modes of completion.
 It defaults to `UPDATE` which is backed by the strategy described above.
 Alternatively, the completion mode can be set to `DELETE`, which alters the registry's persistence mechanisms to rather delete ``EventPublication``s on completion.
 This means that `CompletedEventPublications` will not return any publications anymore, but at the same time, you don't have to worry about purging the completed events from the persistence store manually anymore.
 
+The third option is the `ARCHIVE` mode, which copies the entry into an archive table, collection or node.
+For that archive entry, the completion date is set and the original entry is removed.
+Contrary to the `DELETE` mode, completed event publications are then still accessible via the `CompletedEventPublications` abstraction.
+
 [[publication-registry.publication-repositories]]
 === Event Publication Repositories