Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Readme.md

Turso .NET

ADO.NET bindings for Turso local databases.

The Turso.Data.Sqlite package includes both a SQLite-compatible Turso.Data.Sqlite facade and Turso-specific System.Data.Common types such as TursoConnection, TursoCommand, TursoDataReader, TursoParameter, TursoTransaction, and TursoFactory.

Install

dotnet add package Turso.Data.Sqlite

Application code only needs to reference Turso.Data.Sqlite.

The package targets net8.0, net9.0, and net10.0. It includes native runtime assets for Windows, Linux, macOS, Android (android-arm64, android-arm, android-x64, and android-x86), and iOS as an XCFramework with device and simulator slices.

Getting started

using Turso;

using var connection = new TursoConnection("Data Source=:memory:");
connection.Open();

connection.ExecuteNonQuery("CREATE TABLE t(a, b)");
var rowsAffected = connection.ExecuteNonQuery("INSERT INTO t(a, b) VALUES (1, 2), (3, 4)");
Console.WriteLine($"RowsAffected: {rowsAffected}");

using var command = connection.CreateCommand();
command.CommandText = "SELECT * FROM t";
using var reader = command.ExecuteReader();
while (reader.Read())
{
    var a = reader.GetInt32(0);
    var b = reader.GetInt32(1);
    Console.WriteLine($"Value1: {a}, Value2: {b}");
}

ADO.NET usage

Code written against DbConnection can use TursoConnection directly:

using System.Data.Common;
using Turso;

await using DbConnection connection = new TursoConnection("Data Source=app.db");
connection.Open();

await using var command = connection.CreateCommand();
command.CommandText = "SELECT $value";
var parameter = command.CreateParameter();
parameter.ParameterName = "$value";
parameter.Value = 42;
command.Parameters.Add(parameter);

var value = command.ExecuteScalar();

Provider factories are available through TursoFactory.Instance:

DbProviderFactory factory = TursoFactory.Instance;
using var connection = factory.CreateConnection();
connection!.ConnectionString = "Data Source=:memory:";
connection.Open();

Migrating from Microsoft.Data.Sqlite

For common embedded SQLite usage, Turso.Data.Sqlite exposes a SQLite-compatible facade over the Turso engine:

- using Microsoft.Data.Sqlite;
+ using Turso.Data.Sqlite;

- using var connection = new SqliteConnection("Data Source=app.db");
+ using var connection = new SqliteConnection("Data Source=app.db");

Supported common connection string keywords include:

Keyword Notes
Data Source Database path or :memory:. Aliases include DataSource and Filename.
Mode Parsed and preserved for compatibility.
Cache Parsed and preserved for compatibility.
Foreign Keys Parsed and preserved for compatibility.
Recursive Triggers Parsed and preserved for compatibility.
Default Timeout Used as the default command timeout. Aliases include Command Timeout.
Pooling Parsed and preserved for compatibility.
Vfs Parsed and preserved for compatibility.
Encryption Cipher Turso local encryption cipher.
Encryption Key Hex-encoded encryption key used with Encryption Cipher.

SQLite-compatible facade coverage

  • Turso.Data.Sqlite is the migration-oriented facade. It includes SQLite-style connection strings, commands, readers, schema metadata, transactions and savepoints, backup, SQL-backed blob streams, scalar and aggregate UDFs, custom collations, and disabled-by-default extension loading.
  • Raw SQLitePCL sqlite3* handle interop is intentionally unsupported. SqliteConnection.Handle returns null rather than exposing a fake SQLite handle.
  • PRAGMA read_uncommitted is tracked as connection-local state for API compatibility, but Turso does not currently implement SQLite shared-cache dirty reads.
  • SqliteBlob preserves fixed-length blob stream behavior through SQL reads and writes. It is not yet backed by a native incremental-blob storage handle.
  • SQLite virtual-table modules such as FTS3/FTS5 are not built in unless provided by a Turso extension/module.
  • Async methods currently use the base ADO.NET behavior rather than a dedicated async native path.