Skip to content

Home

Jump to bottom
github-actions[bot] edited this page May 27, 2026 · 20 revisions

SQLite.Framework

A lightweight ORM for SQLite, built for .NET, Avalonia and other AOT-published .NET apps. It gives you LINQ queries, async support, and AOT compatibility, with an API that will feel familiar if you have used Entity Framework before.

SQLiteOptions options = new SQLiteOptionsBuilder("library.db")
    .UseMinimumSqliteVersion(SQLiteMinimumVersion.V3_35)
    .Build();
using SQLiteDatabase db = new(options);

await db.Schema.CreateTableAsync<Book>();

var books = db.Table<Book>();
await books.AddAsync(new Book { Title = "Clean Code", Price = 29.99m });

var affordable = await books.Where(b => b.Price < 30).ToListAsync();

Packages

Package When to use
SQLite.Framework Default. Uses the SQLite version that ships with the OS. Works on all major platforms.
SQLite.Framework.Bundled Ships its own SQLite binary. Use this when the OS-provided SQLite is too old or you need a specific version.
SQLite.Framework.Cipher Uses SQLCipher for encrypted databases. Call UseEncryptionKey on the options builder to enable encryption.
SQLite.Framework.Base No SQLite provider included. Use this when you want to supply your own SQLitePCLRaw provider. You are responsible for calling SQLitePCL.Batteries_V2.Init() before creating a database.
SQLite.Framework.DependencyInjection AddSQLiteDatabase helpers for Microsoft.Extensions.DependencyInjection. Use it to register a SQLiteDatabase (or a subclass) into an IServiceCollection.
SQLite.Framework.SourceGenerator Build-time source generator that writes materializers for your entities and Select projections. Avoids reflection for every public type the generator can see. Recommended for Native AOT builds.

All SQLite-provider packages (Framework, Bundled, Cipher, Base) expose the same API and assembly name, so you can swap between them without changing any code. The other packages layer optional features on top.

Features

  • LINQ queries with IQueryable support
  • Async versions of every operation
  • CRUD operations with typed tables
  • Joins, group by, aggregates, and subqueries
  • Bulk delete and update with ExecuteDelete and ExecuteUpdate
  • Transactions using SQLite savepoints
  • Raw SQL via FromSql
  • Full-text search through SQLite's FTS5 module
  • Spatial queries through SQLite's R-Tree module
  • AOT compatible, works great in .NET MAUI and Avalonia apps
  • Supports .NET 8, 9, and 10

Pages

Clone this wiki locally