@rindle/sql-client/drizzle

0.0.0 · Public export map; development manifest version (0.0.0).

Source revision 05d0bf2c2e56 · build details

Source revision: 05d0bf2c2e56.
TypeScript input SHA-256: aabe6cfcc4172b870d5e272142958e9ea8d8784c2aa23133156e5a7ee633318e
Generated 2026-09-04T23:58:25.590Z with TypeScript 6.0.3. Public TypeScript checks and declaration emit passed. Package runtime tests are separate.

Entry point source

createDrizzleClient

FunctionDeclaration · Source: packages/sql-client/src/drizzle.ts:296 · Supporting declarations

Create the structural libSQL-client facade used by drizzle-orm/libsql.

export declare function createDrizzleClient(options: ClientOptions | SqlClient): DrizzleClient;

DrizzleArgs

TypeAliasDeclaration · Source: packages/sql-client/src/drizzle.ts:41 · Supporting declarations

export type DrizzleArgs = readonly unknown[] | Readonly<Record<string, unknown>>;

DrizzleClient

InterfaceDeclaration · Source: packages/sql-client/src/drizzle.ts:70 · Supporting declarations

export interface DrizzleClient {
    readonly protocol: string;
    readonly closed: boolean;
    execute(statement: DrizzleInputStatement, args?: DrizzleArgs): Promise<DrizzleResultSet>;
    batch(statements: DrizzleInputStatement[], mode?: DrizzleTransactionMode): Promise<DrizzleResultSet[]>;
    /** Present for structural Client typing; Drizzle's libSQL migrator is deliberately unsupported. */
    migrate(statements: DrizzleInputStatement[]): Promise<DrizzleResultSet[]>;
    transaction(mode?: DrizzleTransactionMode): Promise<DrizzleTransaction>;
    executeMultiple(sql: string): Promise<void>;
    /** Embedded-replica sync is deliberately unsupported. */
    sync(): Promise<never>;
    reconnect(): void;
    close(): void;
    /** Escape hatch for Rindle-specific operations and session-cursor persistence. */
    readonly rindle: SqlClient;
}

DrizzleInputStatement

TypeAliasDeclaration · Source: packages/sql-client/src/drizzle.ts:42 · Supporting declarations

export type DrizzleInputStatement = string | DrizzleStatement | readonly [
    sql: string,
    args?: DrizzleArgs
];

DrizzleResultSet

InterfaceDeclaration · Source: packages/sql-client/src/drizzle.ts:51 · Supporting declarations

export interface DrizzleResultSet {
    columns: string[];
    columnTypes: string[];
    rows: DrizzleRow[];
    rowsAffected: number;
    lastInsertRowid: bigint | undefined;
    toJSON(): unknown;
}

DrizzleRow

TypeAliasDeclaration · Source: packages/sql-client/src/drizzle.ts:49 · Supporting declarations

export type DrizzleRow = DrizzleValue[] & Record<string, DrizzleValue>;

DrizzleStatement

InterfaceDeclaration · Source: packages/sql-client/src/drizzle.ts:36 · Supporting declarations

The small, structural statement shape consumed by drizzle-orm/libsql.

export interface DrizzleStatement {
    sql: string;
    args?: DrizzleArgs;
}

DrizzleTransaction

InterfaceDeclaration · Source: packages/sql-client/src/drizzle.ts:60 · Supporting declarations

export interface DrizzleTransaction {
    readonly closed: boolean;
    execute(statement: DrizzleInputStatement): Promise<DrizzleResultSet>;
    batch(statements: DrizzleInputStatement[]): Promise<DrizzleResultSet[]>;
    executeMultiple(sql: string): Promise<void>;
    commit(): Promise<void>;
    rollback(): Promise<void>;
    close(): void;
}

DrizzleTransactionMode

TypeAliasDeclaration · Source: packages/sql-client/src/drizzle.ts:43 · Supporting declarations

export type DrizzleTransactionMode = "write" | "read" | "deferred";

DrizzleValue

TypeAliasDeclaration · Source: packages/sql-client/src/drizzle.ts:48 · Supporting declarations

export type DrizzleValue = Exclude<SqlValue, boolean>;

rindleBigint

VariableDeclaration · Source: packages/sql-client/src/drizzle.ts:28 · Supporting declarations

The exact-i64 column for Drizzle schemas (design 226 §7.2). Three promises, lined up with the column contract: generated DDL says BIGINT (the opt-in exact int64 declaration), bind/predicate values are JS bigint, and selected values infer as JS bigint. Drizzle's own integer() remains the number/date/boolean surface and still emits INTEGER (the safe-range f64 plane).

Caveat (§7.2): decltype dispatch fires only for direct column references. SQLite reports no decltype for expression results, so max(big_id) or big_id + 1 falls into the safe-number arm and is a typed VALUE_UNSUPPORTED past the round-trip bound — never a rounded number. For exact expression results, use the native client with intMode: "bigint".

export declare const rindleBigint: {
    (): import("drizzle-orm/sqlite-core").SQLiteCustomColumnBuilder<{
        name: "";
        dataType: "custom";
        columnType: "SQLiteCustomColumn";
        data: bigint;
        driverParam: bigint;
        enumValues: undefined;
    }>;
    <TConfig extends Record<string, any>>(fieldConfig?: TConfig | undefined): import("drizzle-orm/sqlite-core").SQLiteCustomColumnBuilder<{
        name: "";
        dataType: "custom";
        columnType: "SQLiteCustomColumn";
        data: bigint;
        driverParam: bigint;
        enumValues: undefined;
    }>;
    <TName extends string>(dbName: TName, fieldConfig?: unknown): import("drizzle-orm/sqlite-core").SQLiteCustomColumnBuilder<{
        name: TName;
        dataType: "custom";
        columnType: "SQLiteCustomColumn";
        data: bigint;
        driverParam: bigint;
        enumValues: undefined;
    }>;
};

toDrizzleResultSet

FunctionDeclaration · Source: packages/sql-client/src/drizzle.ts:151 · Supporting declarations

Convert Rindle's lossless positional result into libSQL's positional + named hybrid rows.

export declare function toDrizzleResultSet(result: StatementResult): DrizzleResultSet;