Project Icon

sqlite-net

跨平台轻量级 .NET SQLite 数据访问库

sqlite-net 是一个开源的轻量级 .NET SQLite 数据访问库,适用于 .NET、.NET Core 和 Mono 应用。该库提供简单的 CRUD 操作和查询方法,支持同步和异步 API,通过反射机制实现 ORM 功能。sqlite-net 兼容多种 .NET 平台,如 Xamarin、UWP 和 Azure,为开发者提供高效的数据库访问解决方案。

SQLite-net

[GitHub 操作] [代码覆盖率报告]

使用以下其中一个包:

版本描述
NuGet 包sqlite-net-pcl.NET 标准库
带加密的 NuGet 包sqlite-net-sqlcipher支持加密
使用 P/Invoke 的 NuGet 包sqlite-net-static使用 P/Invoke 调用平台提供的 sqlite3 的特殊版本
不含 SQLitePCLRaw 包的 NuGet 包sqlite-net-base不含 SQLitePCLRaw 包,您可以选择自己的提供程序

SQLite-net 是一个开源的、最小化的库,允许 .NET、.NET Core 和 Mono 应用程序在 SQLite 3 数据库 中存储数据。它最初设计用于 Xamarin.iOS,但现在已经发展到可以在所有平台(Xamarin.*、.NET、UWP、Azure 等)上使用。

SQLite-net 被设计为快速且方便的数据库层。它的设计遵循以下目标:

  • 与现有项目非常容易集成,并且可在所有 .NET 平台上运行。

  • 对 SQLite 进行轻量级封装,快速高效。(本库不应成为您查询的性能瓶颈。)

  • 提供非常简单的方法来安全地执行 CRUD 操作和查询(使用参数),并以强类型方式检索这些查询的结果。

  • 适用于您的数据模型,无需强制您更改类。(包含一个小型的反射驱动 ORM 层。)

NuGet 安装

从 NuGet 安装 sqlite-net-pcl

**重要提示:**您需要将 NuGet 包同时添加到 .NET Standard 库项目平台相关的应用项目 中。

源代码安装

SQLite-net 全部包含在一个文件中(我知道,很酷对吧?),很容易添加到您的项目中。只需将 SQLite.cs 添加到您的项目中,就可以开始创建表了。异步实现可以在 SQLiteAsync.cs 中找到。

欢迎贡献!

这是一个开源项目,欢迎使用者提供贡献/建议/错误报告。如果您有任何改进库的想法,请在 GitHub 上提交问题。请查看如何贡献

示例时间!

请查阅 Wiki 以获取,咳咳,完整文档

该库包含简单的属性,您可以用它们来控制表的构建。在一个简单的股票程序中,您可能会使用:

public class Stock
{
	[PrimaryKey, AutoIncrement]
	public int Id { get; set; }
	public string Symbol { get; set; }
}

public class Valuation
{
	[PrimaryKey, AutoIncrement]
	public int Id { get; set; }
	[Indexed]
	public int StockId { get; set; }
	public DateTime Time { get; set; }
	public decimal Price { get; set; }
	[Ignore]
	public string IgnoreField { get; set; }
}

一旦您定义了模型中的对象,您就有了 API 的选择。您可以使用"同步 API",其中调用一次阻塞一次,或者您可以使用"异步 API",其中调用不会阻塞。您可能会考虑在移动应用程序中使用异步 API 以提高响应性。

两种 API 都在下面两个部分中进行了解释。

同步 API

一旦您定义了实体,就可以通过调用 CreateTable 自动在数据库中生成表:

// 获取数据库文件的绝对路径
var databasePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments), "MyData.db");

var db = new SQLiteConnection(databasePath);
db.CreateTable<Stock>();
db.CreateTable<Valuation>();

您可以使用 Insert 在数据库中插入行。如果表包含自增主键,那么插入后该键的值将对您可用:

public static void AddStock(SQLiteConnection db, string symbol) {
	var stock = new Stock() {
		Symbol = symbol
	};
	db.Insert(stock);
	Console.WriteLine("{0} == {1}", stock.Symbol, stock.Id);
}

类似的方法还有UpdateDelete

查询数据最直接的方式是使用Table方法。这可以使用谓词来通过WHERE子句进行约束和/或添加ORDER BY子句:

var query = db.Table<Stock>().Where(v => v.Symbol.StartsWith("A"));

foreach (var stock in query)
	Console.WriteLine("Stock: " + stock.Symbol);

你也可以使用Query方法在底层查询数据库:

public static IEnumerable<Valuation> QueryValuations (SQLiteConnection db, Stock stock) {
	return db.Query<Valuation> ("select * from Valuation where StockId = ?", stock.Id);
}

Query方法的泛型参数指定了为每一行创建的对象类型。它可以是你的表类之一,或者任何其他公共属性与查询返回的列匹配的类。例如,我们可以将上面的查询重写为:

public class Val
{
	public decimal Money { get; set; }
	public DateTime Date { get; set; }
}

public static IEnumerable<Val> QueryVals (SQLiteConnection db, Stock stock) {
	return db.Query<Val> ("select \"Price\" as \"Money\", \"Time\" as \"Date\" from Valuation where StockId = ?", stock.Id);
}

你可以使用Execute方法执行数据库的底层更新。

异步API

异步库使用任务并行库(TPL)。因此,正常使用Task对象以及asyncawait关键字对你来说是可行的。

一旦你定义了实体,你可以通过调用CreateTableAsync自动生成表:

// 获取数据库文件的绝对路径
var databasePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments), "MyData.db");

var db = new SQLiteAsyncConnection(databasePath);

await db.CreateTableAsync<Stock>();

Console.WriteLine("Table created!");

你可以使用Insert在数据库中插入行。如果表包含自增主键,那么该键的值将在插入后可用:

var stock = new Stock()
{
	Symbol = "AAPL"
};

await db.InsertAsync(stock);

Console.WriteLine("Auto stock id: {0}", stock.Id);

类似的方法还有UpdateAsyncDeleteAsync

查询数据最直接的方式是使用Table方法。这将返回一个AsyncTableQuery实例,你可以在其上添加谓词以通过WHERE子句进行约束和/或添加ORDER BY。在调用特殊检索方法 - ToListAsyncFirstAsyncFirstOrDefaultAsync之前,数据库不会被实际触及。

var query = db.Table<Stock>().Where(s => s.Symbol.StartsWith("A"));

var result = await query.ToListAsync();

foreach (var s in result)
	Console.WriteLine("Stock: " + s.Symbol);

有许多底层方法可用。你也可以通过QueryAsync方法直接查询数据库。除了InsertAsync等提供的更改操作外,你还可以使用ExecuteAsync方法直接在数据库中更改数据集。

另一个有用的方法是ExecuteScalarAsync。这允许你轻松地从数据库返回标量值:

var count = await db.ExecuteScalarAsync<int>("select count(*) from Stock");

Console.WriteLine(string.Format("Found '{0}' stock items.", count));

手动SQL

sqlite-net通常作为一个轻量级ORM(对象关系映射器)使用,使用CreateTableTable方法。 然而,你也可以将其用作方便的方式来手动执行查询。

以下是一个创建表、插入数据(使用参数化命令)和查询表的示例,而不使用ORM功能。

db.Execute ("create table Stock(Symbol varchar(100) not null)");
db.Execute ("insert into Stock(Symbol) values (?)", "MSFT");
var stocks = db.Query<Stock> ("select * from Stock");

使用SQLCipher

你可以通过使用sqlite-net-sqlcipher NuGet包来使用加密数据库。

数据库密钥在传递给连接构造函数的SqliteConnectionString中设置:

var options = new SQLiteConnectionString(databasePath, true,
	key: "password");
var encryptedDb = new SQLiteAsyncConnection(options);

如果你需要设置pragmas来控制加密,可以将操作传递给连接字符串:

var options2 = new SQLiteConnectionString (databasePath, true,
	key: "password",
	preKeyAction: db => db.Execute("PRAGMA cipher_default_use_hmac = OFF;"),
	postKeyAction: db => db.Execute ("PRAGMA kdf_iter = 128000;"));
var encryptedDb2 = new SQLiteAsyncConnection (options2);

感谢!

感谢.NET社区对这个项目的欢迎,也感谢所有为使这个项目变得更好而做出贡献的贡献者们。

同时也要感谢Tirza van Dijk (@tirzavdijk)设计的精美logo!

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号