Getting Started

Outbox with RavenDB persistence

In RavenDB 3.5, the client implementation of distributed transactions contains a bug that could cause an endpoint to lose data under rare conditions. If RavenDB is configured to enlist in distributed transactions with RavenDB 3.5, read DTC not supported for RavenDB Persistence.
Using RavenDB version 5 and higher in a cluster configuration with multiple nodes is only supported from version 7 or higher of the NServiceBus.RavenDB persistence package. For more information, read cluster configuration with multiple nodes not supported.

The Outbox feature requires persistence in order to store messages and enable deduplication.

Extra collections created by the RavenDB Outbox persistence

To keep track of duplicate messages, the RavenDB implementation of Outbox creates a special collection of documents called OutboxRecord.

Deduplication record lifespan

The RavenDB persistence retains deduplication records for 7 days by default and runs the cleanup operation every minute.

These settings can be modified by specifying the desired values in the settings dictionary:

var outbox = endpointConfiguration.EnableOutbox();

Starting with NServiceBus.RavenDB version 6.3, it is recommended to disable cleanup and rely on document expiration instead.

Cleanup may be disabled by specifying Timeout.InfiniteTimeSpan for SetFrequencyToRunDeduplicationDataCleanup:

var outbox = endpointConfiguration.EnableOutbox();

If document expiration cannot be used, to improve efficiency it is advised to run cleanup on only one endpoint instance per RavenDB database, by disabling clean up on all other endpoint instances.

If document expiration is not used when operating in multi-tenant mode, cleanup must be handled manually, since NServiceBus is unaware of the databases in use.

Related Articles

  • Outbox
    Reliable messaging without distributed transactions.