BTDB 技术文档

1. 安装指南

BTDB 是一个用 C# 11 编写的开源项目，支持 .Net 8.0，并且遵循 MIT 许可证。你可以通过 NuGet 包管理器来安装 BTDB。

安装步骤

1. 打开 Visual Studio 或你喜欢的 .Net 开发环境。
2. 在项目中打开 NuGet 包管理器。
3. 搜索 BTDB 包。
4. 点击安装按钮，等待安装完成。

安装完成后，你可以在项目中使用 BTDB 提供的各种功能。

2. 项目的使用说明

BTDB 项目包含多个模块，每个模块都有其独特的功能和用途。以下是各个模块的简要说明：

2.1 Key Value Database

BTDB 的核心是一个键值数据库，支持 ACID 特性和 MVCC（多版本并发控制）。它可以在内存中或本地堆上存储数据，并且支持自动压缩和快照功能。

2.2 Wrapped Dynamic IL Generation

该模块帮助你在运行时生成 IL 代码，主要用于对象数据库部分。它支持调试和扩展，能够生成流畅的代码。

2.3 Object Database

对象数据库建立在键值数据库之上，支持存储普通的 .Net 对象，并且自动处理模型升级和版本控制。它还支持对象之间的关系和单例模式。

2.4 Event Storage

事件存储模块提供了高效的事件序列化和反序列化功能，支持事务处理，并且可以与 Azure Page Blobs 集成。

2.5 Bon

Bon 是一种二进制对象表示法，比 JSON 更快、更小，适用于需要高效序列化和反序列化的场景。

2.6 Snappy Compression

Snappy 压缩模块是一个高效的压缩库，完全兼容原始的 Snappy 实现，并且是纯托管代码。

3. 项目API使用文档

3.1 Key Value Database API

创建数据库

using (var fileCollection = new InMemoryFileCollection())
using (IKeyValueDB db = new KeyValueDB(fileCollection))
{
    // 数据库操作
}

启动事务

using (var tr = db.StartTransaction())
{
    // 事务操作
    tr.Commit();
}

插入或更新键值对

tr.CreateOrUpdateKeyValue(new byte[] { 1 }, new byte[100000]);

3.2 Object Database API

定义对象模型

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);
}

4. 项目安装方式

BTDB 可以通过 NuGet 包管理器进行安装，具体步骤如下：

1. 打开 Visual Studio 或你喜欢的 .Net 开发环境。
2. 在项目中打开 NuGet 包管理器。
3. 搜索 BTDB 包。
4. 点击安装按钮，等待安装完成。

安装完成后，你可以在项目中使用 BTDB 提供的各种功能。

---

通过以上文档，你应该能够顺利安装和使用 BTDB 项目，并了解其各个模块的功能和 API 使用方法。