RavenDB.TestDriver 7.1.0

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package RavenDB.TestDriver --version 7.1.0
                    
NuGet\Install-Package RavenDB.TestDriver -Version 7.1.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="RavenDB.TestDriver" Version="7.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="RavenDB.TestDriver" Version="7.1.0" />
                    
Directory.Packages.props
<PackageReference Include="RavenDB.TestDriver" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add RavenDB.TestDriver --version 7.1.0
                    
#r "nuget: RavenDB.TestDriver, 7.1.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package RavenDB.TestDriver@7.1.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=RavenDB.TestDriver&version=7.1.0
                    
Install as a Cake Addin
#tool nuget:?package=RavenDB.TestDriver&version=7.1.0
                    
Install as a Cake Tool

RavenDB .NET Test Driver

You're looking at RavenDB Test Driver Client (SDK) NuGet release.
It makes it easy to write tests that require RavenDB instance, leveraging embedded server and providing you friendly API.

RavenDB is a NoSQL database that fuses extreme performance with ease-of-use, offering above the roof developer experience.
Learn more at https://ravendb.net or visit our GitHub repository.

Installation

Get the latest stable version from NuGet.

Learning resources

Community

Getting started

Configure

var testServerOptions = new TestServerOptions
{
    // Looks for the newest version on your machine including 3.1.15 and any newer patches
    // but not major new releases (default is .NET version at time of server release).
    FrameworkVersion = "3.1.15+",

    // Specifies where ravendb server binaries are located (Optional)
    ServerDirectory = "PATH_TO_RAVENDB_SERVER",

    // Specifies where ravendb data will be placed/located (Optional)
    DataDirectory = "PATH_TO_RAVENDB_DATADIR", 
};

ConfigureServer(testServerOptions);

Write a test

using Raven.Client.Documents;
using Raven.TestDriver;
using Xunit;
using System.Linq;
using Raven.Client.Documents.Indexes;

namespace RavenDBTestDriverFullExample
{

    public class RavenDBTestDriver : RavenTestDriver
    {
        static RavenDBTestDriver()
        {
            // ConfigureServer() must be set before calling GetDocumentStore()
            // and can only be set once per test run.
            ConfigureServer(new TestServerOptions
            {
                DataDirectory = "C:\\RavenDBTestDir"
            });
        }
        // This allows us to modify the conventions of the store we get from 'GetDocumentStore'
        protected override void PreInitialize(IDocumentStore documentStore)
        {
            documentStore.Conventions.MaxNumberOfRequestsPerSession = 50;
        }

        [Fact]
        public void MyFirstTest()
        {
            // GetDocumentStore() evokes the Document Store, which establishes and manages communication
            // between your client application and a RavenDB cluster via HTTP requests.
            using (var store = GetDocumentStore())
            {
                store.ExecuteIndex(new TestDocumentByName());
                using (var session = store.OpenSession())
                {
                    session.Store(new TestDocument { Name = "Hello world!" });
                    session.Store(new TestDocument { Name = "Goodbye..." });
                    session.SaveChanges();
                }
                // If we want to query documents, sometimes we need to wait for the indexes to catch up  
                // to prevent using stale indexes.
                WaitForIndexing(store);

                // Sometimes we want to debug the test itself. This method redirects us to the studio
                // so that we can see if the code worked as expected (in this case, created two documents).
                WaitForUserToContinueTheTest(store);

                // Queries are defined in the session scope.
                // If there is no relevant index to quickly answer the query, RavenDB creates an auto-index
                // based on the query parameters.
                // This query will use the static index defined in lines 63-70 and filter the results by name.
                using (var session = store.OpenSession())
                {
                    var query = session.Query<TestDocument, TestDocumentByName>()
                        .Where(x => x.Name == "hello").ToList();
                    Assert.Single(query);
                }
            }
        }
    }
    // AbstractIndexCreationTask allows you to create and manually define a static index. 
    public class TestDocumentByName : AbstractIndexCreationTask<TestDocument>
    {
        public TestDocumentByName()
        {
            Map = docs => from doc in docs select new { doc.Name };
            Indexes.Add(x => x.Name, FieldIndexing.Search);
        }
    }

    public class TestDocument
    {
        public string Name { get; set; }
    }
}

Contributing

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on RavenDB.TestDriver:

Package Downloads
ECommerce.Data.RavenDbProvider

a resilient abstract data access. StartPoint ECommerce.DataAccess based on Hexagonal architecture gives you the capacity to access any data source with retrying and fallback action

GitHub repositories (10)

Showing the top 10 popular GitHub repositories that depend on RavenDB.TestDriver:

Repository Stars
JasperFx/wolverine
Supercharged .NET server side development!
Aguafrommars/TheIdServer
OpenID/Connect, OAuth2, WS-Federation and SAML 2.0 server based on Duende IdentityServer and ITFoxtec Identity SAML 2.0 with its admin UI
CommunityToolkit/Aspire
A community project with additional components and extensions for .NET Aspire
linkdotnet/Blog
A blog (engine) completely written in C# and Blazor. It aims to be a simple use and easy to extend platform. Blogposts are written in Markdown and are rendered to HTML. This gives all the flexibility needed to express yourself but also have an easy way of creating posts in the first place.
TcOpenGroup/TcOpen
Application framework for industrial automation built on top of TwinCAT3 and .NET.
RemyDuijkeren/NodaMoney
NodaMoney provides a library that treats Money as a first class citizen and handles all the ugly bits like currencies and formatting.
stoveproject/Stove
Domain Driven Design oriented application framework, meets CRUD needs
RemiBou/Toss.Blazor
Experimental project using AspNetCore Blazor
linkdotnet/BlogExamples
Contains all of my examples from various blog posts
ravendb/samples-yabt
"Yet Another Bug Tracker" solution sample for RavenDB and .NET with Angular UI
Version Downloads Last Updated
7.1.1 0 7/22/2025
7.1.1-rc-71006 144 7/8/2025
7.1.0 2,471 7/1/2025
7.1.0-rc-71004 139 6/25/2025
7.1.0-rc-71003 143 6/18/2025
7.1.0-rc-71000 160 5/29/2025
7.0.5 0 7/22/2025
7.0.4 633 6/25/2025
7.0.3 1,134 6/10/2025
7.0.2 6,333 4/29/2025
7.0.1 5,878 3/27/2025
7.0.0 13,497 2/4/2025
6.2.8 0 7/22/2025
6.2.7 239 6/25/2025
6.2.6 1,022 6/10/2025
6.2.5 2,697 4/29/2025
6.2.4 2,532 3/18/2025
6.2.3 20,551 1/21/2025
6.2.2 28,874 12/11/2024
6.2.1 20,158 10/30/2024
6.2.0 8,112 9/17/2024
6.0.110 377 3/18/2025
6.0.109 814 1/21/2025
6.0.108 279 12/11/2024
6.0.107 879 10/30/2024
6.0.106 8,816 9/17/2024
6.0.105 19,545 7/23/2024
6.0.104 10,808 6/17/2024
6.0.103 6,551 5/16/2024
6.0.102 13,898 4/29/2024
6.0.101 34,755 3/19/2024
6.0.100 48,666 2/12/2024
6.0.4 4,611 1/19/2024
6.0.3 60,496 1/16/2024
6.0.2 2,489 12/27/2023
6.0.1 5,213 11/14/2023
6.0.0 4,240 10/2/2023
5.4.210 0 7/22/2025
5.4.209 413 6/10/2025
5.4.208 1,250 4/29/2025
5.4.207 1,079 3/18/2025
5.4.206 10,340 1/21/2025
5.4.205 4,527 12/11/2024
5.4.204 8,640 10/30/2024
5.4.203 9,855 10/2/2024
5.4.202 607 9/17/2024
5.4.201 11,342 7/23/2024
5.4.200 16,666 6/17/2024
5.4.119 2,721 5/16/2024
5.4.118 3,089 4/29/2024
5.4.117 11,762 3/19/2024
5.4.116 9,081 2/12/2024
5.4.115 2,613 1/18/2024
5.4.114 170 1/16/2024
5.4.113 8,355 12/27/2023
5.4.112 116,805 11/14/2023
5.4.111 10,133 10/3/2023
5.4.110 3,554 9/12/2023
5.4.109 14,077 8/1/2023
5.4.107 5,107 6/23/2023
5.4.106 337 6/22/2023
5.4.105 755 6/20/2023
5.4.104 36,911 5/12/2023
5.4.103 27,194 3/30/2023
5.4.102 4,210 3/27/2023
5.4.101 15,432 2/13/2023
5.4.100 18,384 1/9/2023
5.4.5 54,954 11/21/2022
5.4.4 13,578 10/12/2022
5.4.3 805 10/10/2022
5.4.2 18,597 9/1/2022
5.4.1 35,369 7/19/2022
5.4.0 11,801 7/18/2022
5.3.108 40,187 1/9/2023
5.3.107 2,932 11/21/2022
5.3.106 561 10/10/2022
5.3.105 632 9/1/2022
5.3.104 1,921 7/18/2022
5.3.103 29,607 6/7/2022
5.3.102 56,174 4/19/2022
5.3.101 24,372 3/15/2022
5.3.100 32,004 2/1/2022
5.3.2 9,396 1/7/2022
5.3.1 5,751 12/21/2021
5.3.0 4,802 11/29/2021
5.2.116 230 8/1/2023
5.2.115 233 6/23/2023
5.2.114 224 6/22/2023
5.2.113 234 6/20/2023
5.2.112 514 5/12/2023
5.2.111 611 3/30/2023
5.2.110 879 3/27/2023
5.2.109 684 2/13/2023
5.2.108 3,340 1/9/2023
5.2.107 468 11/21/2022
5.2.106 557 10/10/2022
5.2.105 571 9/1/2022
5.2.104 608 7/18/2022
5.2.103 628 6/7/2022
5.2.102 11,238 4/19/2022
5.2.101 18,694 3/15/2022
5.2.100 926 2/1/2022
5.2.6 832 1/7/2022
5.2.5 500 12/21/2021
5.2.4 13,597 11/15/2021
5.2.3 8,626 9/29/2021
5.2.2 17,516 8/16/2021
5.2.1 2,261 7/1/2021
5.2.0 3,945 6/21/2021
5.1.13 498 12/21/2021
5.1.12 587 11/15/2021
5.1.11 614 9/29/2021
5.1.10 626 8/16/2021
5.1.9 11,896 7/1/2021
5.1.8 3,851 5/26/2021
5.1.7 20,564 4/23/2021
5.1.6 2,543 4/13/2021
5.1.5 7,878 3/1/2021
5.1.4 9,340 2/1/2021
5.1.3 905 1/25/2021
5.1.2 5,875 12/11/2020
5.1.1 2,392 12/1/2020
5.1.0 1,494 11/18/2020
5.0.14 1,155 6/16/2021
5.0.13 664 5/24/2021
5.0.12 12,065 4/23/2021
5.0.11 3,982 4/13/2021
5.0.10 802 3/1/2021
5.0.9 796 2/1/2021
5.0.8 2,376 1/25/2021
5.0.7 3,596 12/11/2020
5.0.6 722 12/1/2020
5.0.5 17,949 11/16/2020
5.0.4 948 11/10/2020
5.0.3 4,626 9/28/2020
5.0.2 7,454 8/17/2020
5.0.1 1,476 8/5/2020
5.0.0 4,255 7/23/2020
4.2.124 283 6/19/2023
4.2.123 3,031 6/7/2022
4.2.122 1,298 4/19/2022
4.2.121 1,104 3/15/2022
4.2.120 2,217 2/1/2022
4.2.119 520 12/21/2021
4.2.118 1,138 11/15/2021
4.2.117 1,041 9/29/2021
4.2.116 1,000 8/16/2021
4.2.115 1,021 7/1/2021
4.2.114 2,519 5/24/2021
4.2.113 2,607 4/23/2021
4.2.112 829 4/13/2021
4.2.111 3,142 3/1/2021
4.2.110 1,844 2/1/2021
4.2.109 726 1/25/2021
4.2.108 3,396 11/16/2020
4.2.107 721 11/10/2020
4.2.106 6,394 9/28/2020
4.2.105 10,858 8/17/2020
4.2.104 2,355 7/22/2020
4.2.103 13,718 5/25/2020
4.2.102 5,294 4/15/2020
4.2.101 11,764 3/3/2020
4.2.100 877 3/2/2020
4.2.8 15,351 1/21/2020
4.2.6 7,092 12/9/2019
4.2.5 2,711 11/25/2019
4.2.5-patch-42026 536 11/13/2019
4.2.4 3,420 10/14/2019
4.2.4-patch-42020 544 9/27/2019
4.2.3 12,930 8/26/2019
4.2.2 9,489 7/15/2019
4.2.1 1,794 6/27/2019
4.2.0 3,619 5/21/2019
4.2.0-rc-42008 567 5/8/2019
4.2.0-rc-42007 607 4/25/2019
4.2.0-rc-42005 590 4/17/2019
4.2.0-rc-42003 581 4/12/2019
4.2.0-rc-42002 587 4/5/2019
4.2.0-rc-42001 597 3/22/2019
4.2.0-rc-42000 581 3/22/2019
4.1.10 1,279 11/25/2019
4.1.9 784 10/14/2019
4.1.9-patch-41022 521 9/27/2019
4.1.8 2,170 8/26/2019
4.1.8-patch-41017 556 7/15/2019
4.1.7 843 6/27/2019
4.1.6 929 5/21/2019
4.1.5 1,598 4/15/2019
4.1.5-patch-41012 662 3/15/2019
4.1.4 11,067 2/13/2019
4.1.4-patch-41009 704 2/1/2019
4.1.4-patch-41008 2,212 1/7/2019
4.1.3 4,679 11/19/2018
4.1.3-patch-41006 1,230 11/5/2018
4.1.3-patch-41005 821 10/22/2018
4.1.2 5,669 10/15/2018
4.1.1 4,229 9/14/2018
4.1.0 1,662 8/31/2018
4.1.0-rc-41000 861 8/17/2018
4.0.11 1,203 2/28/2019
4.0.10 949 2/13/2019
4.0.10-patch-40057 662 2/1/2019
4.0.10-patch-40056 689 1/7/2019
4.0.9 985 11/19/2018
4.0.9-patch-40054 795 11/5/2018
4.0.9-patch-40052 773 10/22/2018
4.0.8 1,078 10/15/2018
4.0.7 1,091 8/31/2018
4.0.6 2,556 8/3/2018
4.0.6-patch-40047 1,011 7/2/2018
4.0.5 6,226 6/12/2018
4.0.4-patch-40038 1,174 5/18/2018
4.0.3 18,322 4/23/2018
4.0.3-patch-40034 1,658 3/30/2018
4.0.3-patch-40033 1,169 3/19/2018
4.0.3-patch-40031 1,219 3/7/2018
4.0.2 3,558 2/26/2018
4.0.1 1,516 2/20/2018
4.0.0 1,876 2/6/2018