LiteDB - A .NET NoSQL Document Store in a single data file
LiteDB is a small, fast and lightweight NoSQL embedded database.
- Serverless NoSQL Document Store
- Simple API similar to MongoDB
- 100% C# code for .NET 3.5 in a single DLL (less than 200kb)
- Support for Portable UWP/PCL (thanks to @negue and @szurgot)
- ACID transactions
- Data recovery after write failure (journal mode)
- 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 (up to 16 indexes per collection)
- LINQ support for queries
- Shell command line - try this online version
- Open source and free for everyone - including commercial use
- Install from NuGet:
Install-Package LiteDB
- Install portable version from NuGet:
Install-Package LiteDB.Core
New features in v2
- Generic data access - can use any
Stream
as datafile - Better mapping of classes from your entity to
BsonDocument
(like EntityFramework) - Better cross reference with
DbRef
mapping - Lazy engine load (open the datafile only when running a command)
- Reduce your database size with shrink
- Support for
Initial Size
andLimit Size
databases - Complete re-write of engine classes with full debug logger
- Complete re-write disk operation to be more safe
- Transaction control
BsonMapper.Global
class mapper definition- See more examples at http://www.litedb.org/ and unit tests
Try online
Try LiteDB Web Shell. For security reasons, in the online version not all commands are available. Try the offline version for full feature tests.
Documentation
Visit the Wiki for full documentation
Download
Download the source code or binary only in LiteDB Releases
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 string[] Phones { get; set; }
public bool IsActive { get; set; }
}
// Open database (or create if doesn't exist)
using(var db = new LiteDatabase(@"C:\Temp\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" },
IsActive = 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);
// Index document using a document property
col.EnsureIndex(x => x.Name);
// Use Linq to query documents
var results = col.Find(x => x.Name.StartsWith("Jo"));
}
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; }
public decimal Total => Products.Sum(p => p.Price);
}
// Re-use mapper from global instance
var mapper = BsonMapper.Global;
// "Produts" 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
.Index(x => x.OrderDate) // Index this field
.Ignore(x => x.Total); // Do not store this
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 applications
- One database per account/user data store
- Few concurrent write operations
GUI Tools
- LiteDB Viewer from @falahati
Changelog
Change details for each release are documented in the release notes.
License
Copyright (c) 2016 - MaurĂcio David
Thanks
A special thanks to @negue and @szurgot helping with portable version.