LiteDB 5.0.17

.NET Standard 1.3 .NET Framework 4.5
dotnet add package LiteDB --version 5.0.17
NuGet\Install-Package LiteDB -Version 5.0.17
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="LiteDB" Version="5.0.17" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add LiteDB --version 5.0.17
#r "nuget: LiteDB, 5.0.17"
#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.
// Install LiteDB as a Cake Addin
#addin nuget:?package=LiteDB&version=5.0.17

// Install LiteDB as a Cake Tool
#tool nuget:?package=LiteDB&version=5.0.17

LiteDB - A .NET NoSQL Document Store in a single data file

Join the chat at https://gitter.im/mbdavid/LiteDB Build status Build Status


LiteDB is a small, fast and lightweight .NET NoSQL embedded database.

  • Serverless NoSQL Document Store
  • Simple API, similar to MongoDB
  • 100% C# code for .NET 4.5 / NETStandard 1.3/2.0 in a single DLL (less than 450kb)
  • Thread-safe
  • ACID with full transaction support
  • Data recovery after write failure (WAL log file)
  • Datafile encryption using DES (AES) cryptography
  • Map your POCO classes to BsonDocument using attributes or fluent mapper API
  • Store files and stream data (like GridFS in MongoDB)
  • Single data file storage (like SQLite)
  • Index document fields for fast search
  • LINQ support for queries
  • SQL-Like commands to access/transform data
  • LiteDB Studio - Nice UI for data access
  • Open source and free for everyone - including commercial use
  • Install from NuGet: Install-Package LiteDB

New v5

  • New storage engine
  • No locks for read operations (multiple readers)
  • Write locks per collection (multiple writers)
  • Internal/System collections
  • New SQL-Like Syntax
  • New query engine (support projection, sort, filter, query)
  • Partial document load (root level)
  • and much, much more!

Lite.Studio

New UI to manage and visualize your database:

LiteDB.Studio

Documentation

Visit the Wiki for full documentation. For simplified chinese version, check here.

LiteDB Community

Help LiteDB grow its user community by answering this simple survey

How to use LiteDB

A quick example for storing and searching documents:

// Create your POCO class
public class Customer
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
    public string[] Phones { get; set; }
    public bool IsActive { get; set; }
}

// Open database (or create if doesn't exist)
using(var db = new LiteDatabase(@"MyData.db"))
{
    // Get customer collection
    var col = db.GetCollection<Customer>("customers");

    // Create your new customer instance
    var customer = new Customer
    { 
        Name = "John Doe", 
        Phones = new string[] { "8000-0000", "9000-0000" }, 
        Age = 39,
        IsActive = true
    };

    // Create unique index in Name field
    col.EnsureIndex(x => x.Name, true);

    // Insert new customer document (Id will be auto-incremented)
    col.Insert(customer);

    // Update a document inside a collection
    customer.Name = "Joana Doe";

    col.Update(customer);

    // Use LINQ to query documents (with no index)
    var results = col.Find(x => x.Age > 20);
}

Using fluent mapper and cross document reference for more complex data models

// DbRef to cross references
public class Order
{
    public ObjectId Id { get; set; }
    public DateTime OrderDate { get; set; }
    public Address ShippingAddress { get; set; }
    public Customer Customer { get; set; }
    public List<Product> Products { get; set; }
}        

// Re-use mapper from global instance
var mapper = BsonMapper.Global;

// "Products" and "Customer" are from other collections (not embedded document)
mapper.Entity<Order>()
    .DbRef(x => x.Customer, "customers")   // 1 to 1/0 reference
    .DbRef(x => x.Products, "products")    // 1 to Many reference
    .Field(x => x.ShippingAddress, "addr"); // Embedded sub document
            
using(var db = new LiteDatabase("MyOrderDatafile.db"))
{
    var orders = db.GetCollection<Order>("orders");
        
    // When query Order, includes references
    var query = orders
        .Include(x => x.Customer)
        .Include(x => x.Products) // 1 to many reference
        .Find(x => x.OrderDate <= DateTime.Now);

    // Each instance of Order will load Customer/Products references
    foreach(var order in query)
    {
        var name = order.Customer.Name;
        ...
    }
}

Where to use?

  • Desktop/local small applications
  • Application file format
  • Small web sites/applications
  • One database per account/user data store

Plugins

Changelog

Change details for each release are documented in the release notes.

Code Signing

LiteDB is digitally signed courtesy of SignPath

<a href="https://www.signpath.io"> <img src="https://about.signpath.io/assets/logo_signpath_500.png" width="150"> </a>

License

MIT

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-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.3 is compatible.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  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 tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 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)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (308)

Showing the top 5 NuGet packages that depend on LiteDB:

Package Downloads
DeviceDetector.NET

The Universal Device Detection library for .NET that parses User Agents and detects devices (desktop, tablet, mobile, tv, cars, console, etc.), clients (browsers, feed readers, media players, PIMs, ...), operating systems, brands and models. This is a port of the popular PHP device-detector library to C#. For the most part you can just follow the documentation for device-detector with no issue.

FirebaseDatabase.net

Complex C# library for Firebase Realtime Database built on top of Firebase REST API. Among others it supports following: * Offline storage * Querying using available filters * Passing in authentication token * Streaming online changes * Directly Posting / Putting / Patching online data Streaming changes (both online and offline) are done using Reactive Extensions.

FenixAlliance.ACL.Dependencies

Application Component for the Alliance Business Suite.

NBlockchain

NBlockchain is a toolkit for developers to build their own blockchain applications.

TIKSN-Framework

This is a .NET Framework enhancement framework. Main features are Versioning, Finance, Currency, Foreign Exchange, Money, Pricing strategy, Telemetry, Composite Weighted Progress, Repository and Unity of Wok pattern implementation with Entity Framework Core, Network Connectivity Service and Triggering, Settings, Windows Registry configuration source, Azure Storage Repository, MongoDB Repository, NoDB Repository, Lingual and Regional Localization, Serialization, Rest Requester, Rest Repository, Dependency Injection, Composition Root Setup base classes.

GitHub repositories (77)

Showing the top 5 popular GitHub repositories that depend on LiteDB:

Repository Stars
files-community/Files
Building the best file manager for Windows
dodyg/practical-aspnetcore
Practical samples of ASP.NET Core 8.0, 7.0, 6.0, 5.0, 3.1, 2.2, and 2.1,projects you can use. Readme contains explanations on all projects.
mRemoteNG/mRemoteNG
mRemoteNG is the next generation of mRemote, open source, tabbed, multi-protocol, remote connections manager.
JosefNemec/Playnite
Video game library manager with support for wide range of 3rd party libraries and game emulation support, providing one unified interface for your games.
bitwarden/mobile
The mobile app vault (iOS and Android).
Version Downloads Last updated
5.0.17 418,365 7/21/2023
5.0.16 275,813 3/10/2023
5.0.15 375,055 12/23/2022
5.0.14 12,545 12/16/2022
5.0.13 121,991 12/8/2022
5.0.12 716,316 6/15/2022
5.0.11 4,047,954 7/23/2021
5.0.10 1,526,468 1/9/2021
5.0.9 762,143 8/6/2020
5.0.8 416,292 5/13/2020
5.0.7 116,356 4/14/2020
5.0.5 95,561 3/26/2020
5.0.4 44,673 3/12/2020
5.0.3 26,336 2/21/2020
5.0.2 23,813 2/10/2020
5.0.1 23,641 2/3/2020
5.0.0-rc 4,113 1/19/2020
5.0.0-beta 15,931 10/29/2019
5.0.0-alpha2 12,528 9/24/2019
5.0.0-alpha 10,637 8/4/2019
4.1.4 5,411,283 6/11/2018
4.1.3 37,062 5/28/2018
4.1.2 210,509 3/11/2018
4.1.1 95,758 1/8/2018
4.1.0 41,965 12/17/2017
4.0.0 63,231 10/18/2017
4.0.0-beta2 4,016 10/2/2017
4.0.0-beta1 12,886 8/28/2017
3.1.5 63,283 3/17/2018
3.1.4 141,981 8/16/2017
3.1.3 6,543 8/13/2017
3.1.2 6,632 8/4/2017
3.1.1 29,583 6/8/2017
3.1.0 120,841 3/11/2017
3.0.1 11,983 2/15/2017
3.0.0 21,921 1/20/2017
3.0.0-beta3 8,828 12/25/2016
3.0.0-beta2 4,553 11/27/2016
3.0.0-beta 3,111 11/20/2016
2.0.4 67,734 11/7/2016
2.0.2 56,527 8/25/2016
2.0.1 4,081 8/22/2016
2.0.0 6,472 7/31/2016
2.0.0-rc2 3,292 7/20/2016
2.0.0-rc 17,437 12/24/2015
2.0.0-beta 3,182 11/20/2015
1.0.5 11,426 7/23/2016
1.0.4 21,472 10/26/2015
1.0.3 8,189 9/6/2015
1.0.2 5,699 5/17/2015
1.0.1 3,520 5/11/2015
1.0.0 4,837 3/28/2015
0.9.0 4,253 2/5/2015
0.8.0 3,818 1/31/2015
0.6.0 3,959 1/20/2015
0.5.0 4,715 8/25/2014