@probitas/client-sql-sqlite

SQLite client for Probitas scenario testing framework.

This package provides a SQLite client designed for integration testing, with transaction support and in-memory database capabilities.

Features

• Query Execution: Parameterized queries with type-safe results
• Transactions: Full transaction support with isolation levels
• In-Memory Databases: Perfect for isolated test scenarios
• File-Based Databases: Persist data for stateful testing
• Resource Management: Implements AsyncDisposable for proper cleanup

Installation

deno add jsr:@probitas/client-sql-sqlite

Quick Start

import { createSqliteClient } from "@probitas/client-sql-sqlite";

// In-memory database for testing
const client = await createSqliteClient({
  path: ":memory:",
});

// Create table
await client.query(`
  CREATE TABLE users (
    id INTEGER PRIMARY KEY,
    name TEXT NOT NULL,
    active INTEGER DEFAULT 1
  )
`);

// Insert and query with parameters (uses ? placeholders)
await client.query("INSERT INTO users (name) VALUES (?)", ["Alice"]);

const result = await client.query<{ id: number; name: string }>(
  "SELECT id, name FROM users WHERE active = ?",
  [1]
);
console.log(result.rows);

await client.close();

Transactions

import { createSqliteClient } from "@probitas/client-sql-sqlite";
import type { SqlTransaction } from "@probitas/client-sql";

const client = await createSqliteClient({ path: ":memory:" });
await client.transaction(async (tx: SqlTransaction) => {
  await tx.query("INSERT INTO accounts (id, balance) VALUES (?, ?)", [1, 100]);
  await tx.query("INSERT INTO accounts (id, balance) VALUES (?, ?)", [2, 200]);
  // Automatically committed if no error, rolled back on exception
});
await client.close();

Using with using Statement

import { createSqliteClient } from "@probitas/client-sql-sqlite";

await using client = await createSqliteClient({ path: ":memory:" });

await client.query("CREATE TABLE test (id INTEGER PRIMARY KEY)");
// Client automatically closed when block exits

Related Packages

Links

• GitHub Repository
• Probitas Framework
• SQLite

deno add jsr:@probitas/client-sql-sqlite

class BusyError extends SqliteError

new BusyError(message: string, options?: SqliteErrorOptions)

class ConstraintError extends SqlError

new ConstraintError(
  message: string,
  constraint: string,
  options?: SqlErrorOptions,
)

class DatabaseLockedError extends SqliteError

new DatabaseLockedError(message: string, options?: SqliteErrorOptions)

class DeadlockError extends SqlError

new DeadlockError(message: string, options?: SqlErrorOptions)

class QuerySyntaxError extends SqlError

new QuerySyntaxError(message: string, options?: SqlErrorOptions)

class ReadonlyDatabaseError extends SqliteError

new ReadonlyDatabaseError(message: string, options?: SqliteErrorOptions)

class SqlConnectionError extends SqlError

new SqlConnectionError(message: string, options?: SqlErrorOptions)

class SqlError extends ClientError

new SqlError(message: string, kind: SqlErrorKind, options?: SqlErrorOptions)

class SqliteError extends SqlError

new SqliteError(message: string, options?: SqliteErrorOptions)

class SqliteTransactionImpl implements SqlTransaction

new SqliteTransactionImpl(db: Database)

static begin(): unknown

query(): unknown

queryOne(): unknown

commit(): unknown

rollback(): unknown

interface SqlErrorOptions extends ErrorOptions

interface SqliteClient extends AsyncDisposable

query<T = Record<string, any>>(
  sql: string,
  params?: unknown[],
  options?: SqlQueryOptions,
): Promise<SqlQueryResult<T>>

queryOne<T = Record<string, any>>(
  sql: string,
  params?: unknown[],
  options?: SqlQueryOptions,
): Promise<T | undefined>

transaction<T>(
  fn: (tx: SqlTransaction) => unknown,
  options?: SqlTransactionOptions | SqliteTransactionOptions,
): Promise<T>

backup(destPath: string): Promise<void>

vacuum(): Promise<void>

close(): Promise<void>

interface SqliteClientConfig extends CommonOptions

interface SqliteErrorOptions extends SqlErrorOptions

interface SqliteTransactionOptions extends SqlTransactionOptions

interface SqlQueryOptions extends CommonOptions

interface SqlQueryResultError<T = any> extends SqlQueryResultBase<T>

interface SqlQueryResultFailure<T = any> extends SqlQueryResultBase<T>

interface SqlQueryResultSuccess<T = any> extends SqlQueryResultBase<T>

interface SqlQueryResultSuccessParams<T = any>

interface SqlTransaction

query<T = Record<string, any>>(
  sql: string,
  params?: unknown[],
  options?: SqlQueryOptions,
): Promise<SqlQueryResult<T>>

queryOne<T = Record<string, any>>(
  sql: string,
  params?: unknown[],
  options?: SqlQueryOptions,
): Promise<T | undefined>

commit(): Promise<void>

rollback(): Promise<void>

interface SqlTransactionOptions

function convertSqliteError(error: unknown): SqlError

function createSqliteClient(config: SqliteClientConfig): Promise<SqliteClient>

import { createSqliteClient } from "@probitas/client-sql-sqlite";

const client = await createSqliteClient({
  path: "./data.db",
});

const result = await client.query<{ id: number; name: string }>(
  "SELECT * FROM users WHERE id = ?",
  [1],
);
if (result.ok) {
  console.log(result.rows[0]);  // { id: 1, name: "Alice" }
}

await client.close();

import { createSqliteClient } from "@probitas/client-sql-sqlite";

const client = await createSqliteClient({
  path: ":memory:",
});
await client.close();

import { createSqliteClient } from "@probitas/client-sql-sqlite";
import type { SqlTransaction } from "@probitas/client-sql";

const client = await createSqliteClient({ path: ":memory:" });
const user = await client.transaction(async (tx: SqlTransaction) => {
  await tx.query("INSERT INTO users (name) VALUES (?)", ["Alice"]);
  const result = await tx.query<{ id: number }>("SELECT last_insert_rowid() as id");
  if (!result.ok) throw result.error;
  return result.rows[0];
});
await client.close();

import { createSqliteClient } from "@probitas/client-sql-sqlite";

const client = await createSqliteClient({ path: "./data.db" });
await client.backup("./backup.db");
await client.close();

import { createSqliteClient } from "@probitas/client-sql-sqlite";

await using client = await createSqliteClient({ path: "./data.db" });

const result = await client.query("SELECT 1");
// Client automatically closed when scope exits

function isConnectionError(error: unknown): boolean

type SqlErrorKind = "query" | "constraint" | "deadlock" | "connection" | "unknown"

type SqlFailureError = SqlConnectionError | AbortError | TimeoutError

type SqlIsolationLevel = "read_uncommitted" | "read_committed" | "repeatable_read" | "serializable"

type SqliteErrorKind = "database_locked" | "readonly" | "busy"

type SqliteTransactionMode = "deferred" | "immediate" | "exclusive"

type SqlOperationError = QuerySyntaxError | ConstraintError | DeadlockError | SqlError

type SqlQueryResult<T = any> = SqlQueryResultSuccess<T> | SqlQueryResultError<T> | SqlQueryResultFailure<T>