Connection API

The Connection type is the primary interface for database operations.

Opening & Closing

const sqlite = @import("sqlite");

var db = try sqlite.open(std.heap.page_allocator, "my.db");
defer db.close();

Executing Raw SQL

// DDL
var result = try db.exec("CREATE TABLE users (id INTEGER, name TEXT);");
result.deinit();

// DML
result = try db.exec("INSERT INTO users VALUES (1, 'Alice');");
result.deinit();

// Query
var rows = try db.exec("SELECT * FROM users;");
defer rows.deinit();

std.debug.print("Rows: {d}\n", .{rows.rowCount()});
for (rows.rows) |row| {
    std.debug.print("id={d} name={s}\n", .{ row[0].integer, row[1].text });
}

DSL Query Interface

const User = sqlite.table("users", struct { id: i64, name: []const u8 });

// Create table
try db.createTable(User, .{ .if_not_exists = true });

// Insert
var result = try db.from(User).insert(.{ .id = 1, .name = "Alice" });
result.deinit();

// Select
var rows = try db.from(User).fetchAll();
defer rows.deinit();

// With WHERE
var filtered = try db.from(User)
    .where(User.column("id").eq(1))
    .fetchAll();
defer filtered.deinit();

Transactions

try db.begin();
// ... operations ...
try db.commit();

// or rollback
try db.rollback();

Savepoints

try db.begin();
try db.savepoint("sp1");
// ... operations ...
try db.rollbackToSavepoint("sp1");
try db.releaseSavepoint("sp1");
try db.commit();

Schema Operations

// Create table
try db.createTable(User, .{
    .if_not_exists = true,
    .primary_key_key = User.key("id"),
});

// Truncate table
try db.truncate(User);

Result Handling

var result = try db.exec("SELECT * FROM users;");
defer result.deinit();

// Number of rows
const count = result.rowCount();

// Access rows
for (result.rows) |row| {
    // row is a []Value
    const id = row[0].integer;
    const name = row[1].text;
}