YesSql 技术文档

本文档旨在帮助用户安装、使用及深入了解 YesSql 项目，包含以下内容：

1. 安装指南

NuGet 包安装

您可以通过 NuGet 包管理器来安装 YesSql。在您的 .NET 项目中，执行以下命令：

Install-Package YesSql

源代码安装

如果您希望从源代码开始，您可以克隆 GitHub 仓库：

git clone https://github.com/sebastienros/yessql.git

然后，通过 NuGet 恢复依赖项并构建项目：

cd yessql
dotnet restore
dotnet build

2. 项目的使用说明

YesSql 是一个基于关系型数据库的 .NET Core 文档数据库接口，允许您使用普通的 CLR 对象定义文档和索引。与传统的文档数据库相比，YesSql 使用任何 RDBMS 来存储数据，这样您可以享受到 SQL 数据库的所有优点，如事务、复制、报告等。最重要的是，它不涉及任何魔法，完全是纯 SQL！

3. 项目 API 使用文档

YesSql 提供了一套 API 来定义文档和索引，以及与之交互。以下是一些基本的使用示例：

定义文档

public class MyDocument
{
    public int Id { get; set; }
    public string Name { get; set; }
    // 其他属性...
}

定义索引

public class MyDocumentIndex : DocumentMap<MyDocument>
{
    public string Name { get; set; }
    // 索引定义...
}

交互数据库

var store = new DocumentStore();
store.AddDocument(new MyDocument { Name = "Test" });
var document = store.Query<MyDocument>().Where(x => x.Name == "Test").First();

4. 项目安装方式

请参考上述的“安装指南”部分，您可以通过 NuGet 包或源代码的方式来安装 YesSql。

通过阅读本文档，您应该能够顺利地安装和使用 YesSql，并且对其有了更深入的了解。如果您有任何问题或需要进一步的帮助，请查阅官方文档或在 GitHub 仓库中提出问题。