Skip to content

Latest commit

 

History

History
77 lines (43 loc) · 3.23 KB

index.md

File metadata and controls

77 lines (43 loc) · 3.23 KB
title component versions related reviewed redirects
RavenDB Persistence
raven
[2,)
samples/ravendb
samples/multi-tenant/ravendb
2024-10-01
nservicebus/ravendb
persistence/ravendb/licensing
nservicebus/ravendb/licensing

include: dtc-warning

include: cluster-configuration-info

Uses the RavenDB document database for storage.

Persistence at a glance

partial: glance

RavenDB versions

Specific versions of RavenDB Persistence are tied to a major version of NServiceBus and also designed to work with a specific version of the RavenDB client library. When releasing a new major version of NServiceBus, the corresponding RavenDB Persistence release will use the last supported version of RavenDB, so that it is never necessary to upgrade both NServiceBus and RavenDB at the same time.

See the NServiceBus Packages Supported Versions to see the support details for each version of RavenDB Persistence.

RavenDB client are compatible with their corresponding server version and newer versions:

Example

NServiceBus.RavenDB 9.0 uses RavenDB.Client v5.4.116.* which is compatible with RavenDB Server 5.4, 6.0, 6.1.x, 6.2.x, 7.0.x, and future newer versions of RavenDB Server

Connection options for RavenDB

There are a variety of options for configuring the connection to a RavenDB Server. See RavenDB Connection Options for more details.

Shared session

NServiceBus supports sharing the same RavenDB document session between Saga persistence, Outbox persistence, and business data, so that a single persistence transaction can be used to persist the data for all three concerns atomically. Shared sessions are automatically configured when an endpoint has enabled the Outbox feature or contains sagas.

To use the shared session in a message handler:

snippet: ravendb-persistence-shared-session-for-handler

Although additional database operations inside a saga handler are not recommended (see warning below) the shared session can also be accessed from a saga handler:

include: saga-business-data-access

snippet: ravendb-persistence-shared-session-for-saga

Customizing the IDocumentSession

The creation of the RavenDB IDocumentSession instance used by NServiceBus and made available as the shared session can be customized as shown in the following snippet. Despite the name of the method, this option does not enable the shared session but only affects the customization of that session.

snippet: ravendb-persistence-customize-document-session

include: raven-dispose-warning

partial: multitenant

Viewing the data

Open a web browser and type the URL of the RavenDB server. This opens the RavenDB Studio.

Migrating timeouts

Timeouts can be migrated to the native-delay delivery implementation with the migration tool.