BTDB 33.8.3

dotnet add package BTDB --version 33.8.3
                    
NuGet\Install-Package BTDB -Version 33.8.3
                    
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="BTDB" Version="33.8.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="BTDB" Version="33.8.3" />
                    
Directory.Packages.props
<PackageReference Include="BTDB" />
                    
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 BTDB --version 33.8.3
                    
#r "nuget: BTDB, 33.8.3"
                    
#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 BTDB@33.8.3
                    
#: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=BTDB&version=33.8.3
                    
Install as a Cake Addin
#tool nuget:?package=BTDB&version=33.8.3
                    
Install as a Cake Tool

BTDB

BTDB Logo

Currently this project these parts:

  • Key Value Database
  • Wrapped Dynamic IL generation with debugging + extensions
  • IOC Container (SourceGenerator based)
  • Object Database with Relations
  • Snappy Compression
  • Event Storage
  • Bon (Binary object notation)
  • Incremental SourceGenerator for IOC Container factory generation

All code written in C# 12 and licensed under very permissive MIT license. Targeting .Net 9.0, main code has just 2 dependencies (Microsoft.Extensions.Primitives, Microsoft.Extensions.ObjectPool). Code is tested using xUnit Framework. Used in production on Windows and Linux, on MacOS works as well. Please is you find it useful or have questions, write me e-mail boris.letocha@gmail.com so I know that it is used. It is available in Nuget http://www.nuget.org/packages/BTDB. Source code drops are Github releases.


Breaking changes

33.0.0

KeyValueDB

Nearly all IKeyValueDBTransaction methods moved into IKeyValueDBCursor. IKeyValueDBTransaction has method CreateCursor() to create IKeyValueDBCursor. Created cursor must not be used after transaction Commit. And all cursors must be disposed before transaction is disposed. It makes implementation of custom transaction wrappers more difficult, look at KeyValueDBTransactionWithCount for example.

ObjectDB

Positive breaking change is that DB could be modified in parallel to enumeration. It is possible due to KeyValueDB has now Cursors which correctly update their position even when DB is modified. It is even possible to delete current object in enumeration and enumeration will still continue correctly. Relations cannot return IEnumerator<T> anymore, it must be replaced by IEnumerable<T>. Also IOrderedDictionaryEnumerator is now inherited from IDisposable and must be disposed. Forgetting dispose will cause exception during transaction disposal.


Key Value Database

Features

  • This is Key Value store written in C# with implementation on native heap (has also prefix compression). InMemory version uses managed heap.
  • It is easily embeddable.
  • One storage is just one directory.
  • It has ACID properties with MVCC.
  • At one time there could be multiple read only transactions and one read/write transaction.
  • Export/Import to stream - could be used for compaction, snapshotting
  • Automatic compaction
  • Customizable compression (key index file could be Brotli compressed)
  • Relatively Fast DB Open due to key index file - though it still needs to load all keys to memory
  • Inspired by Bitcask [https://github.com/basho/bitcask/blob/develop/doc/bitcask-intro.pdf]

Design limits

  • All keys data needs to fit in RAM
  • Maximum Key length is limited by 31bits (2GB).
  • Maximum value length is limited by 31bits (2GB).

Sample code

using (var fileCollection = new InMemoryFileCollection())
using (IKeyValueDB db = new KeyValueDB(fileCollection))
{
    using (var tr = db.StartTransaction())
    {
        tr.CreateOrUpdateKeyValue(new byte[] { 1 }, new byte[100000]);
        tr.Commit();
    }
}

Roadmap

  • Everything is there just use it

Wrapped Dynamic IL generation with debugging + extensions

This help you to write fluent code which generates IL code in runtime. It is used in Object Database part.

Sample code

var method = ILBuilder.Instance.NewMethod<Func<Nested>>("SampleCall");
var il = method.Generator;
var local = il.DeclareLocal(typeof(Nested), "n");
il
    .Newobj(() => new Nested())
    .Dup()
    .Stloc(local)
    .Ldstr("Test")
    .Call(() => ((Nested)null).Fun(""))
    .Ldloc(local)
    .Ret();
var action = method.Create();

Roadmap

  • Add support for all IL instructions as needed
  • Deprecate this by replacing its usages by Source Generator

Object Database

Features

  • Builds on top of Key Value Database and Reflection.Emit extensions.
  • It stores Plain .Net Objects and only their public properties with getters and setters.
  • All ACID and MVCC properties are preserved of course.
  • Automatic upgrading of model on read with dynamically generated optimal IL code.
  • Automatic versioning of model changes.
  • Enumeration of all objects
  • Each object type could store its "singleton" - very useful for root objects
  • Relations - Table with primary key and multiple secondary keys
  • By default objects are stored inline in parent object, use IIndirect for objects with Oid which will load lazily

Documentation: [https://github.com/Bobris/BTDB/blob/master/Doc/ODBDictionary.md]

Relations doc: [https://github.com/Bobris/BTDB/blob/master/Doc/Relations.md]

Sample code

public class Person
{
    public string Name { get; set; }
    public uint Age { get; set; }
}

using (var tr = _db.StartTransaction())
{
    tr.Store(new Person { Name = "Bobris", Age = 35 });
    tr.Commit();
}
using (var tr = _db.StartTransaction())
{
    var p = tr.Enumerate<Person>().First();
    Assert.AreEqual("Bobris", p.Name);
    Assert.AreEqual(35, p.Age);
}

Roadmap

  • Support more types of properties
  • Free text search (far future if ever)

Event storage

Features

  • Optimal serialization with metadata
  • Deserialization also to dynamic
  • Storage is transactional
  • As storage could be used Azure Page Blobs
  • EventStorage2 is specialized to be used with Kafka, metadata are stored in separate topic

Bon

Bon Binary object notation is allows creating and reading JavaScript/C# values with extensions like Dictionary/Map into binary notation. It is much faster to parse, write, skip, search by keys than JSON, size will be also smaller in most cases, in some cases much more smaller.


Snappy Compression

Features

  • Ported and inspired mainly by Go version of Snappy Compression [http://code.google.com/p/snappy/]
  • Fully compatible with original
  • Fully managed and safe implementation
  • Compression is aborted when target buffer size is not big enough

Roadmap

  • Some speed optimizations around Spans would help
Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  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. 
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 BTDB:

Package Downloads
Bbcore.Lib

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
33.8.3 261 6/1/2025
33.8.2 240 5/27/2025
33.8.1 155 5/26/2025
33.8.0 159 5/26/2025
33.7.3 153 5/25/2025
33.7.2 493 5/12/2025
33.7.1 293 5/6/2025
33.7.0 205 4/29/2025
33.6.8 222 6/9/2025
33.6.7 16,604 5/27/2025
33.6.6 149 5/25/2025
33.6.5 9,332 5/12/2025
33.6.4 10,634 4/28/2025
33.6.3 4,109 4/16/2025
33.6.2 2,886 4/11/2025
33.6.1 169 4/10/2025
33.6.0 208 4/10/2025
33.5.0 9,639 4/6/2025
33.4.4 4,230 3/30/2025
33.4.3 1,124 3/27/2025
33.4.2 165 3/26/2025
33.4.1 133 3/21/2025
33.4.0 160 3/20/2025
33.3.0 813 2/24/2025
33.2.0 135 2/13/2025
33.1.3 26,922 1/14/2025
33.1.2 145 1/14/2025
33.1.1 145 1/14/2025
33.1.0 141 1/13/2025
33.0.7 163 1/13/2025
33.0.6 150 1/13/2025
33.0.5 124 1/13/2025
33.0.4 118 1/12/2025
33.0.3 141 1/9/2025
33.0.2 118 1/9/2025
33.0.1 116 1/7/2025
33.0.0 143 1/3/2025
32.17.0 26,088 12/17/2024
32.16.4 31,475 11/6/2024
32.16.3 354 10/25/2024
32.16.2 11,557 10/14/2024
32.16.1 13,019 10/11/2024
32.16.0 17,091 10/4/2024
32.15.1 769 8/29/2024
32.15.0 138 8/29/2024
32.14.1 1,447 8/17/2024
32.14.0 171 8/4/2024
32.13.1 30,517 7/31/2024
32.13.0 2,127 7/26/2024
32.12.1 287 7/21/2024
32.12.0 191 7/18/2024
32.11.0 4,007 7/6/2024
32.10.0 4,772 6/20/2024
32.9.0 203 6/15/2024
32.8.0 10,042 6/14/2024
32.7.1 17,506 5/15/2024
32.7.0 141 5/14/2024
32.6.2 3,693 5/6/2024
32.6.1 145 5/6/2024
32.6.0 225 5/1/2024
32.5.0 54,491 2/29/2024
32.4.29 483 2/26/2024
32.4.28 139 2/26/2024
32.4.26 17,930 2/21/2024
32.4.25 2,085 2/20/2024
32.4.24 531 2/19/2024
32.4.23 3,573 2/14/2024
32.4.22 153 2/13/2024
32.4.21 3,896 2/12/2024
32.4.20 309 2/7/2024
32.4.19 198 2/7/2024
32.4.18 283 2/1/2024
32.4.17 143 1/31/2024
32.4.16 138 1/30/2024
32.4.15 267 1/29/2024
32.4.14 141 1/29/2024
32.4.13 139 1/27/2024
32.4.12 142 1/26/2024
32.4.11 147 1/26/2024
32.4.10 136 1/26/2024
32.4.9 140 1/26/2024
32.4.8 136 1/26/2024
32.4.7 126 1/25/2024
32.4.6 141 1/25/2024
32.4.5 151 1/25/2024
32.4.4 130 1/24/2024
32.4.3 139 1/23/2024
32.4.2 137 1/23/2024
32.4.1 142 1/22/2024
32.4.0 150 1/21/2024
32.3.2 164 1/19/2024
32.3.1 137 1/18/2024
32.3.0 145 1/18/2024
32.2.0 163 1/17/2024
32.1.0 164 1/14/2024
32.0.3 176 1/8/2024
32.0.2 594 1/2/2024
32.0.1 155 1/2/2024
32.0.0 175 1/1/2024
31.15.0 9,829 1/22/2024
31.14.0 24,067 11/23/2023
31.13.0 4,405 11/21/2023
31.12.7 1,661 11/16/2023
31.12.6 282 11/16/2023
31.12.5 247 11/13/2023 31.12.5 is deprecated because it has critical bugs.
31.12.4 665 11/12/2023
31.12.3 8,936 10/30/2023
31.12.2 4,696 10/16/2023
31.12.1 5,143 10/5/2023
31.12.0 273 9/17/2023
31.11.3 30,175 8/10/2023
31.11.2 221 8/9/2023
31.11.1 216 8/8/2023
31.11.0 4,995 8/8/2023
31.10.0 1,088 8/3/2023
31.9.0 243 8/1/2023
31.8.2 2,785 8/1/2023
31.8.1 208 8/1/2023
31.8.0 25,072 6/8/2023
31.7.0 10,341 5/23/2023
31.6.0 254 5/21/2023
31.5.2 1,723 5/16/2023
31.5.1 17,687 4/13/2023
31.5.0 8,930 3/28/2023
31.4.3 3,737 3/24/2023
31.4.2 3,854 3/21/2023
31.4.1 325 3/21/2023
31.4.0 362 3/21/2023
31.3.2 17,086 2/20/2023
31.3.1 688 2/17/2023
31.3.0 355 2/15/2023
31.2.1 374 2/15/2023
31.2.0 2,046 2/15/2023
31.1.1 27,203 2/4/2023
31.1.0 407 2/3/2023
31.0.0 417 2/3/2023
30.5.0 13,968 1/10/2023
30.4.0 614 1/9/2023
30.3.0 6,830 1/3/2023
30.2.2 10,403 1/2/2023
30.2.1 455 1/2/2023
30.2.0 485 1/1/2023
30.1.0 412 12/21/2022
30.0.0 23,111 11/14/2022
29.12.1 528 11/3/2022
29.12.0 959 11/2/2022
29.11.0 573 9/7/2022
29.10.1 583 8/1/2022
29.10.0 565 8/1/2022
29.9.1 589 7/22/2022
29.9.0 606 7/17/2022
29.8.0 615 6/13/2022
29.7.0 597 6/8/2022
29.6.0 600 6/5/2022
29.5.0 623 5/18/2022
29.4.0 614 5/17/2022
29.3.0 607 5/13/2022
29.2.0 631 5/3/2022
29.1.1 8,833 3/29/2022
29.1.0 619 3/28/2022
29.0.0 659 2/28/2022
28.3.2 685 1/21/2022
28.3.1 634 1/21/2022
28.3.0 490 1/4/2022
28.2.0 492 12/19/2021
28.1.2 512 12/7/2021
28.1.1 442 12/6/2021
28.1.0 474 11/29/2021
28.0.0 486 11/17/2021
27.0.3 547 11/17/2021
27.0.2 1,752 11/7/2021
27.0.0 498 11/2/2021
26.2.1 793 5/8/2021
24.0.2 21,294 6/15/2020
24.0.1 890 6/13/2020
24.0.0 753 6/13/2020
23.1.0 918 5/23/2020
23.0.0 755 5/18/2020
22.2.2 765 5/14/2020
22.2.1 743 5/14/2020
22.2.0 727 5/13/2020
22.1.0 743 5/12/2020
22.0.0 764 5/10/2020
21.0.0 789 5/6/2020
20.3.0 821 5/2/2020
20.0.0 876 4/25/2020
19.5.0 1,325 3/10/2020
19.4.0 1,772 11/30/2019
19.3.0 1,196 11/6/2019
19.2.0 873 11/3/2019
19.1.0 1,069 10/13/2019
19.0.0 902 10/6/2019
18.2.2 1,179 9/19/2019
18.2.1 961 9/16/2019
18.2.0 983 9/8/2019
18.1.0 996 9/2/2019
18.0.0 886 9/1/2019
17.10.0 921 8/28/2019
17.9.0 2,084 7/24/2019
17.8.0 1,815 7/13/2019
17.7.0 1,547 6/9/2019
17.6.0 1,463 5/10/2019
17.5.2 1,484 5/9/2019
17.5.1 1,500 5/9/2019
17.5.0 1,528 4/16/2019
17.4.2 1,660 2/12/2019
17.4.1 1,572 2/6/2019
17.4.0 1,563 2/6/2019
17.3.0 1,566 1/25/2019
17.2.0 1,618 1/8/2019
17.1.0 1,548 12/24/2018
17.0.1 1,609 12/20/2018
17.0.0 1,625 12/16/2018
16.2.1 1,669 12/11/2018
14.12.2 1,808 10/15/2018
14.7.0 1,996 8/16/2018
14.6.0 1,859 8/2/2018
14.5.2 2,060 7/9/2018
14.5.1 2,034 6/20/2018
14.5.0 2,029 6/13/2018
14.4.0 2,072 6/10/2018
14.3.0 2,110 6/10/2018
14.2.1 2,061 6/7/2018
14.2.0 1,870 6/6/2018
14.1.0 1,859 6/6/2018
14.0.0 2,012 6/5/2018
13.1.0 2,055 6/3/2018
13.0.0 2,089 5/7/2018
12.7.0 2,170 4/15/2018
12.6.1 2,134 3/23/2018
12.6.0 2,144 3/18/2018
12.5.1 2,106 2/26/2018
12.5.0 2,144 2/12/2018
12.4.0 2,167 1/31/2018
12.3.0 2,096 1/29/2018
12.2.0 2,133 1/9/2018
12.1.0 2,178 12/10/2017
12.0.0 1,975 12/3/2017
11.10.1 2,148 11/20/2017
11.10.0 2,163 11/3/2017
11.9.1 2,156 11/2/2017
11.9.0 2,115 10/31/2017
11.8.1 2,118 10/30/2017
11.8.0 2,117 10/28/2017
11.7.0 2,159 10/26/2017
11.6.5 2,174 10/24/2017
11.6.4 2,165 10/23/2017
11.6.3 2,192 10/20/2017
11.6.2 2,135 10/19/2017
11.6.1 2,147 10/18/2017
11.6.0 2,149 10/15/2017
11.5.0 2,132 10/8/2017
11.4.0 2,386 9/6/2017
11.3.0 2,154 9/4/2017
11.2.0 1,960 8/20/2017
11.1.0 1,911 8/9/2017
11.0.4 1,986 7/30/2017
11.0.3 2,003 7/24/2017
11.0.2 2,095 7/21/2017
11.0.1 1,956 7/21/2017
11.0.0 2,028 7/19/2017
10.6.0 2,008 6/27/2017
10.5.2 2,078 6/23/2017
10.5.1 2,053 6/22/2017
10.5.0 2,004 6/17/2017
10.4.3 1,991 5/31/2017
10.4.2 1,959 5/25/2017
10.4.1 2,028 5/22/2017
10.4.0 1,968 5/19/2017
10.3.0 1,975 5/11/2017
10.2.0 1,982 4/21/2017
10.1.2 1,955 4/14/2017
10.1.1 1,958 4/12/2017
10.1.0 1,998 4/7/2017
10.0.2 1,942 3/28/2017
10.0.1 1,971 3/26/2017
10.0.0 1,992 3/20/2017
9.4.0 1,968 3/12/2017
9.3.1 1,987 3/9/2017
9.3.0 1,996 3/6/2017
9.2.1 1,966 2/28/2017
9.2.0 2,050 2/21/2017
9.1.1 1,988 2/15/2017
9.1.0 2,098 2/8/2017
9.0.4 2,086 1/23/2017
9.0.3 2,040 12/20/2016
9.0.2 1,974 12/18/2016
9.0.0 2,039 12/12/2016
8.0.1 2,044 12/10/2016
8.0.0 2,052 11/28/2016
7.0.0 2,044 11/23/2016
6.0.0 2,470 11/17/2016
5.7.0 2,607 11/3/2016
5.6.4 2,555 11/2/2016
5.6.3 2,259 10/30/2016
5.6.2 2,273 10/26/2016
5.6.1 2,229 10/26/2016
5.6.0 2,250 10/24/2016
5.5.0 2,282 10/22/2016
5.4.0 2,312 10/21/2016
5.3.2 2,313 10/16/2016
5.3.1 2,273 9/14/2016
5.3.0 2,344 9/13/2016
5.2.0 2,277 9/11/2016
5.1.0 2,273 9/9/2016
5.0.0 2,222 9/8/2016
4.0.1 2,243 9/8/2016
4.0.0 2,240 9/7/2016
3.6.0 2,242 9/4/2016
3.5.0 2,284 9/1/2016
3.4.0 2,310 8/8/2016
3.3.0 2,332 7/18/2016
3.2.3 2,333 6/28/2016
3.2.2 2,738 6/15/2016
3.2.1 2,316 6/7/2016
3.2.0 2,297 6/5/2016
3.1.0 2,306 5/30/2016
3.0.0 2,387 5/19/2016
2.12.0 2,412 4/10/2016
2.11.0 2,452 4/9/2016
2.10.1 2,136 3/16/2016
2.10.0 2,405 2/17/2016
2.9.1 2,401 12/13/2015
2.9.0 2,376 12/8/2015
2.8.5 2,447 11/27/2015
2.8.4 2,398 11/27/2015
2.8.2 2,385 11/4/2015
2.8.1 2,336 11/4/2015
2.8.0 2,386 11/1/2015
2.7.0 2,567 6/27/2015
2.6.3 2,434 6/16/2015
2.6.2 2,561 6/14/2015
2.6.1 2,461 5/15/2015
2.6.0 2,525 4/13/2015
2.5.3 2,549 1/26/2015
2.5.2 2,774 12/13/2014
2.5.1 2,678 11/18/2014
2.5.0 2,550 10/13/2014
2.4.5 2,499 10/6/2014
2.4.4 2,673 6/3/2014
2.4.3 2,517 6/2/2014
2.4.2 2,548 5/30/2014
2.4.0 2,887 3/14/2014
2.3.2 2,452 2/3/2014
2.3.1 2,305 12/15/2013
2.3.0 2,291 12/14/2013
2.2.2 2,396 12/12/2013
2.2.1 2,349 12/11/2013
2.2.0 2,411 12/8/2013
2.1.0 2,400 12/8/2013
2.0.2 2,457 12/2/2013
2.0.1 2,446 11/26/2013
2.0.0 2,393 11/14/2013
1.2.1 2,365 11/11/2013
1.1.0 2,420 9/5/2013
1.0.0 2,413 9/1/2013