首页
/ NPoco 技术文档

NPoco 技术文档

2024-12-28 12:20:21作者:仰钰奇

1. 安装指南

NPoco 是一个基于 Schotime 分支的 PetaPoco 的改进版本,具有一些额外的功能。以下是安装 NPoco 的步骤:

  • 通过 NuGet 包管理器安装 NPoco。在 Visual Studio 的 NuGet 包管理器控制台中运行以下命令:
    Install-Package NPoco
    
  • 或者,在项目文件中添加以下依赖项:
    <PackageReference Include="NPoco" Version="5.7.1" />
    

2. 项目的使用说明

NPoco 是一个微型 ORM,支持多种数据库,包括 SQL Server、MySQL、PostgreSQL、Oracle、SQLite、SqlCE 等。以下是如何使用 NPoco 进行基础操作的示例:

第一个查询

首先,定义一个公共类,其属性对应数据库表的列:

public class User 
{
    public int UserId { get; set; }
    public string Email { get; set; }
}

然后,使用数据库连接字符串创建 IDatabase 实例,并执行查询:

IDatabase db = new Database("connStringName");
List<User> users = db.Fetch<User>("select userId, email from users");

这段代码会自动将查询结果的列名映射到 User 类的属性名,这是一个不区分大小写的匹配。在此(仅查询)场景中,无需进行映射设置。

其他特性

  • 创建、读取、更新、删除(CRUD):NPoco 提供了简单的 API 来执行这些基本操作。
  • 分页查询:支持分页查询,便于处理大量数据。
  • SQL 事务支持:可以处理事务,确保数据的一致性。
  • 调试和性能分析:支持使用 MiniProfiler 或 Glimpse 进行调试和性能分析。

3. 项目API使用文档

以下是 NPoco 的一些常用 API:

  • Fetch<T>:执行查询并返回指定类型的列表。
  • Single<T>:执行查询并返回单个对象。
  • Insert<T>:插入一个新对象到数据库。
  • Update<T>:更新数据库中的对象。
  • Delete<T>:从数据库中删除对象。

更多 API 和使用细节,请参考项目 Wiki 文档。

4. 项目安装方式

除了通过 NuGet 包管理器安装外,还可以通过以下方式安装 NPoco:

  • 直接从 GitHub 下载源代码,并将其添加到项目中。
  • 使用 Paket 包管理器安装:
    paket add NPoco
    

确保选择适合项目需求和环境的安装方式。

通过以上指南,您应该能够成功安装和使用 NPoco。如果您在使用过程中遇到任何问题,可以参考项目 Wiki 文档或向社区寻求帮助。

登录后查看全文
热门项目推荐
相关项目推荐