uql-orm 0.62.0 → 0.63.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bunSql/bunSql.util.d.ts +15 -15
- package/dist/bunSql/bunSql.util.js +22 -35
- package/dist/bunSql/bunSqlQuerier.d.ts +2 -2
- package/dist/bunSql/bunSqlQuerier.js +3 -3
- package/dist/bunSql/bunSqlQuerierPool.d.ts +1 -13
- package/dist/bunSql/bunSqlQuerierPool.js +3 -34
- package/dist/d1/d1Querier.d.ts +12 -4
- package/dist/d1/d1Querier.js +6 -11
- package/dist/d1/d1QuerierPool.d.ts +7 -3
- package/dist/d1/d1QuerierPool.js +5 -3
- package/dist/entity/decorator/entity.d.ts +5 -9
- package/dist/entity/decorator/entity.js +3 -7
- package/dist/entity/metadata/definition.d.ts +2 -2
- package/dist/entity/metadata/definition.js +13 -22
- package/dist/libsql/libsqlDialect.d.ts +1 -1
- package/dist/libsql/libsqlDialect.js +1 -1
- package/dist/libsql/libsqlQuerierPool.d.ts +18 -9
- package/dist/libsql/libsqlQuerierPool.js +32 -20
- package/dist/migrate/codegen/index.d.ts +1 -1
- package/dist/migrate/codegen/index.js +1 -1
- package/dist/migrate/codegen/indexDecoratorSource.d.ts +1 -1
- package/dist/migrate/codegen/indexDecoratorSource.js +4 -8
- package/dist/migrate/codegen/migrationFile.d.ts +0 -4
- package/dist/migrate/codegen/migrationFile.js +0 -2
- package/dist/querier/abstractSharedHandleQuerierPool.d.ts +5 -5
- package/dist/querier/abstractSharedHandleQuerierPool.js +5 -5
- package/dist/sqlite/abstractSqliteQuerier.d.ts +11 -28
- package/dist/sqlite/abstractSqliteQuerier.js +14 -33
- package/dist/sqlite/bunSqliteAdapter.bun.d.ts +5 -4
- package/dist/sqlite/bunSqliteAdapter.bun.js +1 -1
- package/dist/sqlite/hranaQuerier.d.ts +6 -4
- package/dist/sqlite/hranaQuerier.js +4 -13
- package/dist/sqlite/index.d.ts +0 -1
- package/dist/sqlite/index.js +0 -1
- package/dist/sqlite/localSqliteQuerierPool.d.ts +14 -5
- package/dist/sqlite/nodeSqliteAdapter.d.ts +3 -4
- package/dist/sqlite/nodeSqliteAdapter.js +3 -6
- package/dist/sqlite/nodeSqliteQuerierPool.d.ts +2 -3
- package/dist/sqlite/nodeSqliteQuerierPool.js +3 -1
- package/dist/sqlite/sqliteDialect.d.ts +1 -1
- package/dist/sqlite/sqliteDialect.js +1 -1
- package/dist/sqlite/sqlitePragmas.d.ts +2 -11
- package/dist/sqlite/sqlitePragmas.js +1 -1
- package/dist/sqlite/sqliteQuerier.d.ts +29 -10
- package/dist/sqlite/sqliteQuerier.js +26 -4
- package/dist/sqlite/sqliteQuerierPool.d.ts +7 -3
- package/dist/sqlite/sqliteQuerierPool.js +12 -8
- package/dist/turso/index.d.ts +1 -0
- package/dist/turso/index.js +1 -0
- package/dist/turso/local.d.ts +1 -1
- package/dist/turso/local.js +1 -1
- package/dist/turso/tursoDialect.d.ts +4 -9
- package/dist/turso/tursoDialect.js +4 -12
- package/dist/turso/tursoLocalDialect.d.ts +10 -0
- package/dist/turso/tursoLocalDialect.js +13 -0
- package/dist/turso/tursoLocalQuerierPool.d.ts +8 -13
- package/dist/turso/tursoLocalQuerierPool.js +6 -5
- package/dist/turso/tursoQuerierPool.d.ts +15 -30
- package/dist/turso/tursoQuerierPool.js +13 -23
- package/dist/turso/tursoSessionQuerier.d.ts +57 -0
- package/dist/turso/tursoSessionQuerier.js +50 -0
- package/dist/type/entity.d.ts +37 -62
- package/dist/type/queryRaw.d.ts +8 -0
- package/dist/type/queryRaw.js +11 -0
- package/dist/util/ddlExpression.util.d.ts +2 -2
- package/dist/util/ddlExpression.util.js +5 -12
- package/dist/util/raw.d.ts +6 -1
- package/dist/util/raw.js +11 -8
- package/dist/util/wideNumber.d.ts +2 -2
- package/dist/util/wideNumber.js +2 -2
- package/package.json +2 -2
- package/dist/sqlite/hranaQuerierPool.d.ts +0 -20
- package/dist/sqlite/hranaQuerierPool.js +0 -26
- package/dist/turso/tursoLocalQuerier.d.ts +0 -24
- package/dist/turso/tursoLocalQuerier.js +0 -20
|
@@ -1,39 +1,51 @@
|
|
|
1
1
|
import { dialectOptionsFrom } from '../dialect/abstractDialect.js';
|
|
2
|
+
import { AbstractSharedHandleQuerierPool } from '../querier/abstractSharedHandleQuerierPool.js';
|
|
2
3
|
import { HranaQuerier } from '../sqlite/hranaQuerier.js';
|
|
3
|
-
import { AbstractHranaQuerierPool } from '../sqlite/hranaQuerierPool.js';
|
|
4
4
|
import { LibsqlDialect } from './libsqlDialect.js';
|
|
5
|
-
/**
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
return { ...rest, url: syncUrl };
|
|
13
|
-
}
|
|
14
|
-
export class LibsqlQuerierPool extends AbstractHranaQuerierPool {
|
|
5
|
+
/**
|
|
6
|
+
* Pool for libSQL. One client serves every querier, since Hrana keeps no per-connection state: a
|
|
7
|
+
* transaction takes its own session handle. The pool builds that client from `@libsql/client`'s
|
|
8
|
+
* `Config`, or shares one the caller built (`@libsql/client/web`, `@libsql/client-wasm`), which stays
|
|
9
|
+
* theirs to close.
|
|
10
|
+
*/
|
|
11
|
+
export class LibsqlQuerierPool extends AbstractSharedHandleQuerierPool {
|
|
15
12
|
conf;
|
|
16
13
|
constructor(conf, extra) {
|
|
17
14
|
super(new LibsqlDialect(dialectOptionsFrom(extra)), extra);
|
|
18
15
|
this.conf = conf;
|
|
19
16
|
}
|
|
20
|
-
|
|
21
|
-
return this.createClient(this.conf);
|
|
17
|
+
async openDb() {
|
|
18
|
+
return 'execute' in this.conf ? this.conf : this.createClient(this.conf);
|
|
19
|
+
}
|
|
20
|
+
buildQuerier(client) {
|
|
21
|
+
return new HranaQuerier(client, this.dialect, this.extra);
|
|
22
|
+
}
|
|
23
|
+
async end() {
|
|
24
|
+
if (!('execute' in this.conf)) {
|
|
25
|
+
await super.end();
|
|
26
|
+
}
|
|
22
27
|
}
|
|
23
28
|
/**
|
|
24
|
-
* For embedded
|
|
25
|
-
*
|
|
29
|
+
* For an embedded replica - a `file:` url with a `syncUrl` - a querier on the sync url, so migrations
|
|
30
|
+
* reach sqld, its client closing with it. Anything else migrates like any other querier.
|
|
26
31
|
*/
|
|
27
32
|
async getMigrationQuerier() {
|
|
28
|
-
if (
|
|
33
|
+
if ('execute' in this.conf) {
|
|
29
34
|
return this.getQuerier();
|
|
30
35
|
}
|
|
31
|
-
const remote =
|
|
32
|
-
|
|
36
|
+
const { syncUrl, url, ...remote } = this.conf;
|
|
37
|
+
if (!syncUrl || !url.startsWith('file:')) {
|
|
38
|
+
return this.getQuerier();
|
|
39
|
+
}
|
|
40
|
+
const client = await this.createClient({ ...remote, url: syncUrl });
|
|
41
|
+
return new HranaQuerier(client, this.dialect, this.extra, { closeClientOnRelease: true });
|
|
33
42
|
}
|
|
34
|
-
/**
|
|
43
|
+
/**
|
|
44
|
+
* Imported on use, so `uql-orm/libsql` loads without the optional `@libsql/client` peer installed.
|
|
45
|
+
* Integers read as `bigint` whatever the config asks, so the querier decodes one past 2^53 exactly.
|
|
46
|
+
*/
|
|
35
47
|
async createClient(conf) {
|
|
36
48
|
const { createClient } = await import('@libsql/client');
|
|
37
|
-
return createClient(conf);
|
|
49
|
+
return createClient({ ...conf, intMode: 'bigint' });
|
|
38
50
|
}
|
|
39
51
|
}
|
|
@@ -5,4 +5,4 @@
|
|
|
5
5
|
*/
|
|
6
6
|
export { createEntityCodeGenerator, EntityCodeGenerator, type EntityCodeGeneratorOptions, type GeneratedEntity, } from './entityCodeGenerator.js';
|
|
7
7
|
export { entityTypesSource } from './entityTypes.js';
|
|
8
|
-
export { buildMigrationModule,
|
|
8
|
+
export { buildMigrationModule, EMPTY_MANUAL_MIGRATION_DOWN_INNER, EMPTY_MANUAL_MIGRATION_UP_INNER, emitMongoCommandCalls, emitSqlRunCall, emitSqlRunCalls, type MigrationModuleOptions, type MigrationQuerierType, } from './migrationFile.js';
|
|
@@ -6,4 +6,4 @@
|
|
|
6
6
|
// Entity code generator
|
|
7
7
|
export { createEntityCodeGenerator, EntityCodeGenerator, } from './entityCodeGenerator.js';
|
|
8
8
|
export { entityTypesSource } from './entityTypes.js';
|
|
9
|
-
export { buildMigrationModule,
|
|
9
|
+
export { buildMigrationModule, EMPTY_MANUAL_MIGRATION_DOWN_INNER, EMPTY_MANUAL_MIGRATION_UP_INNER, emitMongoCommandCalls, emitSqlRunCall, emitSqlRunCalls, } from './migrationFile.js';
|
|
@@ -7,7 +7,7 @@ import type { IndexNode } from '../../schema/types.js';
|
|
|
7
7
|
export declare function isPlainFieldIndex(index: IndexNode): boolean;
|
|
8
8
|
/**
|
|
9
9
|
* One `@Index((user) => [...])` as source, for an index no `@Field` can express, its columns read off the
|
|
10
|
-
*
|
|
10
|
+
* refs `param` names. Emits `raw` for an expression entry, so callers import `raw` when
|
|
11
11
|
* {@link indexNeedsRaw} holds.
|
|
12
12
|
*/
|
|
13
13
|
export declare function buildIndexDecoratorSource(index: IndexNode, propertyName: (column: string) => string, param: string): string;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { isVectorIndexType } from '../../type/index.js';
|
|
1
2
|
import { isIdentifierName, quoted, rawTag } from './sourceLiteral.js';
|
|
2
3
|
/**
|
|
3
4
|
* A vector index carries its metric in the operator class pgvector names after it
|
|
@@ -54,12 +55,12 @@ export function isPlainFieldIndex(index) {
|
|
|
54
55
|
}
|
|
55
56
|
/**
|
|
56
57
|
* One `@Index((user) => [...])` as source, for an index no `@Field` can express, its columns read off the
|
|
57
|
-
*
|
|
58
|
+
* refs `param` names. Emits `raw` for an expression entry, so callers import `raw` when
|
|
58
59
|
* {@link indexNeedsRaw} holds.
|
|
59
60
|
*/
|
|
60
61
|
export function buildIndexDecoratorSource(index, propertyName, param) {
|
|
61
62
|
const entries = index.entries.map((entry) => indexEntrySource(entry, propertyName, param)).join(', ');
|
|
62
|
-
const isVector = index.type
|
|
63
|
+
const isVector = isVectorIndexType(index.type);
|
|
63
64
|
const distance = isVector ? vectorDistance(index) : undefined;
|
|
64
65
|
const options = [];
|
|
65
66
|
if (index.name)
|
|
@@ -88,12 +89,7 @@ export function indexNeedsRaw(index) {
|
|
|
88
89
|
return Boolean(index.where) || index.entries.some((entry) => entry.expression);
|
|
89
90
|
}
|
|
90
91
|
function indexEntrySource(entry, propertyName, param) {
|
|
91
|
-
|
|
92
|
-
const expression = `() => ${rawTag(entry.column)}`;
|
|
93
|
-
const modifiers = significantModifiers(entry);
|
|
94
|
-
return modifiers.length === 0 ? expression : `{ column: ${expression}, ${modifiers.join(', ')} }`;
|
|
95
|
-
}
|
|
96
|
-
const column = memberSource(param, propertyName(entry.column));
|
|
92
|
+
const column = entry.expression ? rawTag(entry.column) : memberSource(param, propertyName(entry.column));
|
|
97
93
|
const modifiers = significantModifiers(entry);
|
|
98
94
|
return modifiers.length === 0 ? column : `{ column: ${column}, ${modifiers.join(', ')} }`;
|
|
99
95
|
}
|
|
@@ -15,8 +15,6 @@ export type MigrationModuleOptions = {
|
|
|
15
15
|
/** Indented body inside `async down` (including newlines). */
|
|
16
16
|
downInner: string;
|
|
17
17
|
};
|
|
18
|
-
/** @deprecated Use {@link MigrationModuleOptions}. */
|
|
19
|
-
export type SqlMigrationModuleOptions = MigrationModuleOptions;
|
|
20
18
|
/**
|
|
21
19
|
* Emit one `await querier.run(...)` line for entity-generated migrations.
|
|
22
20
|
* Uses `JSON.stringify` so SQL with backticks (SQLite/LibSQL), quotes, `${`, etc. stays valid TS source.
|
|
@@ -47,5 +45,3 @@ export declare const migrationSource: {
|
|
|
47
45
|
* Full contents of a `export default { async up/down(querier) { ... } }` migration module.
|
|
48
46
|
*/
|
|
49
47
|
export declare function buildMigrationModule(options: MigrationModuleOptions): string;
|
|
50
|
-
/** @deprecated Use {@link buildMigrationModule}. */
|
|
51
|
-
export declare const buildSqlQuerierMigrationModule: typeof buildMigrationModule;
|
|
@@ -2,13 +2,13 @@ import type { AbstractSqlDialect } from '../dialect/index.js';
|
|
|
2
2
|
import type { SqlQuerier } from '../type/index.js';
|
|
3
3
|
import { AbstractSqlQuerierPool } from './abstractSqlQuerierPool.js';
|
|
4
4
|
/**
|
|
5
|
-
* Base pool for
|
|
6
|
-
*
|
|
5
|
+
* Base pool for a handle opened once and kept for the pool's lifetime: the one connection every local
|
|
6
|
+
* SQLite driver, the embedded Turso engine and PGlite give per database, or libSQL's client.
|
|
7
7
|
*
|
|
8
8
|
* The handle is shared, but each acquisition gets its own querier, so transaction state stays per unit
|
|
9
|
-
* of work.
|
|
10
|
-
*
|
|
11
|
-
*
|
|
9
|
+
* of work. On a single connection that state is not *isolated*, which is the one way these differ from
|
|
10
|
+
* a real pool: two queriers cannot hold independent transactions, and a unit of work that needs one needs
|
|
11
|
+
* its own pool and therefore its own database. libSQL's client opens a session per transaction instead.
|
|
12
12
|
*
|
|
13
13
|
* What a second `BEGIN` then does is the engine's, not this class's: SQLite and the embedded Turso
|
|
14
14
|
* engine both refuse it ("cannot start a transaction within a transaction"), while PGlite accepts it
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { AbstractSqlQuerierPool } from './abstractSqlQuerierPool.js';
|
|
2
2
|
/**
|
|
3
|
-
* Base pool for
|
|
4
|
-
*
|
|
3
|
+
* Base pool for a handle opened once and kept for the pool's lifetime: the one connection every local
|
|
4
|
+
* SQLite driver, the embedded Turso engine and PGlite give per database, or libSQL's client.
|
|
5
5
|
*
|
|
6
6
|
* The handle is shared, but each acquisition gets its own querier, so transaction state stays per unit
|
|
7
|
-
* of work.
|
|
8
|
-
*
|
|
9
|
-
*
|
|
7
|
+
* of work. On a single connection that state is not *isolated*, which is the one way these differ from
|
|
8
|
+
* a real pool: two queriers cannot hold independent transactions, and a unit of work that needs one needs
|
|
9
|
+
* its own pool and therefore its own database. libSQL's client opens a session per transaction instead.
|
|
10
10
|
*
|
|
11
11
|
* What a second `BEGIN` then does is the engine's, not this class's: SQLite and the embedded Turso
|
|
12
12
|
* engine both refuse it ("cannot start a transaction within a transaction"), while PGlite accepts it
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { AbstractSqlQuerier } from '../querier/index.js';
|
|
2
|
+
import type { RawRow } from '../type/index.js';
|
|
2
3
|
/**
|
|
3
4
|
* Values every SQLite driver accepts as a bound parameter.
|
|
4
5
|
*
|
|
@@ -8,41 +9,23 @@ import { AbstractSqlQuerier } from '../querier/index.js';
|
|
|
8
9
|
* driver as one; leaving `boolean` here only invited a runtime throw that is now a compile error.
|
|
9
10
|
*/
|
|
10
11
|
export type SqliteBindValue = null | string | number | bigint | Uint8Array;
|
|
11
|
-
/**
|
|
12
|
-
export type
|
|
13
|
-
|
|
14
|
-
|
|
12
|
+
/** What a statement came back with on a SQLite driver: the rows it read, and how many rows it changed. */
|
|
13
|
+
export type SqliteExecution = {
|
|
14
|
+
readonly rows: RawRow[];
|
|
15
|
+
readonly changes: number;
|
|
15
16
|
};
|
|
16
|
-
/** Bound parameters reach a driver as `unknown[]` from the compiler; every driver types them narrowly. */
|
|
17
|
-
export declare function toSqliteBindValues(values?: unknown[]): SqliteBindValue[];
|
|
18
17
|
/**
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
* awaits either.
|
|
18
|
+
* Querier for every SQLite driver. Each supplies one hook, {@link execute}; what they share - the
|
|
19
|
+
* wide-integer decode, and a RETURNING statement counted by its rows - is written once here.
|
|
22
20
|
*/
|
|
23
|
-
export type SqlitePreparedStatement = {
|
|
24
|
-
/** True for any statement returning rows, including one with a `RETURNING` clause. */
|
|
25
|
-
readonly reader: boolean;
|
|
26
|
-
all(...values: SqliteBindValue[]): unknown[] | Promise<unknown[]>;
|
|
27
|
-
run(...values: SqliteBindValue[]): SqliteRunResult | Promise<SqliteRunResult>;
|
|
28
|
-
iterate(...values: SqliteBindValue[]): Iterable<unknown> | AsyncIterable<unknown>;
|
|
29
|
-
};
|
|
30
21
|
export declare abstract class AbstractSqliteQuerier extends AbstractSqlQuerier {
|
|
22
|
+
/** Runs one statement, answering its rows as the driver read them. */
|
|
23
|
+
protected abstract execute(query: string, values?: unknown[]): Promise<SqliteExecution>;
|
|
24
|
+
internalAll<T>(query: string, values?: unknown[]): Promise<T[]>;
|
|
25
|
+
internalRun(query: string, values?: unknown[]): Promise<import("../type/query.js").QueryUpdateResult>;
|
|
31
26
|
/**
|
|
32
27
|
* SQLite drivers hold a single shared handle rather than a connection from a pool, so releasing
|
|
33
28
|
* a querier returns nothing at all. Drivers owning a closable per-querier connection override this.
|
|
34
29
|
*/
|
|
35
30
|
internalRelease(): Promise<void>;
|
|
36
31
|
}
|
|
37
|
-
/**
|
|
38
|
-
* Querier for the SQLite drivers that expose prepared statements: `better-sqlite3`, `bun:sqlite`
|
|
39
|
-
* (through `adaptBunSqlite`) and the embedded Turso engine. They differ only in whether preparing and
|
|
40
|
-
* stepping are synchronous, which `await` and `for await` absorb, so the read/write/stream logic -
|
|
41
|
-
* including the `reader` rule below, whose loss silently drops inserted ids - is written once.
|
|
42
|
-
*/
|
|
43
|
-
export declare abstract class PreparedSqliteQuerier extends AbstractSqliteQuerier {
|
|
44
|
-
protected abstract prepare(query: string): SqlitePreparedStatement | Promise<SqlitePreparedStatement>;
|
|
45
|
-
internalAll<T>(query: string, values?: unknown[]): Promise<T[]>;
|
|
46
|
-
internalStream<T>(query: string, values?: unknown[]): AsyncGenerator<Awaited<T>, void, unknown>;
|
|
47
|
-
internalRun(query: string, values?: unknown[]): Promise<import("../type/query.js").QueryUpdateResult>;
|
|
48
|
-
}
|
|
@@ -1,41 +1,22 @@
|
|
|
1
1
|
import { AbstractSqlQuerier } from '../querier/index.js';
|
|
2
|
-
|
|
3
|
-
export function toSqliteBindValues(values) {
|
|
4
|
-
return (values || []);
|
|
5
|
-
}
|
|
6
|
-
export class AbstractSqliteQuerier extends AbstractSqlQuerier {
|
|
7
|
-
/**
|
|
8
|
-
* SQLite drivers hold a single shared handle rather than a connection from a pool, so releasing
|
|
9
|
-
* a querier returns nothing at all. Drivers owning a closable per-querier connection override this.
|
|
10
|
-
*/
|
|
11
|
-
async internalRelease() { }
|
|
12
|
-
}
|
|
2
|
+
import { decodeBigInts } from '../util/wideNumber.js';
|
|
13
3
|
/**
|
|
14
|
-
* Querier for
|
|
15
|
-
*
|
|
16
|
-
* stepping are synchronous, which `await` and `for await` absorb, so the read/write/stream logic -
|
|
17
|
-
* including the `reader` rule below, whose loss silently drops inserted ids - is written once.
|
|
4
|
+
* Querier for every SQLite driver. Each supplies one hook, {@link execute}; what they share - the
|
|
5
|
+
* wide-integer decode, and a RETURNING statement counted by its rows - is written once here.
|
|
18
6
|
*/
|
|
19
|
-
export class
|
|
7
|
+
export class AbstractSqliteQuerier extends AbstractSqlQuerier {
|
|
20
8
|
async internalAll(query, values) {
|
|
21
|
-
const
|
|
22
|
-
return
|
|
23
|
-
}
|
|
24
|
-
async *internalStream(query, values) {
|
|
25
|
-
const stmt = await this.prepare(query);
|
|
26
|
-
for await (const row of stmt.iterate(...toSqliteBindValues(values))) {
|
|
27
|
-
yield row;
|
|
28
|
-
}
|
|
9
|
+
const { rows } = await this.execute(query, values);
|
|
10
|
+
return rows.map(decodeBigInts);
|
|
29
11
|
}
|
|
30
12
|
async internalRun(query, values) {
|
|
31
|
-
const
|
|
32
|
-
//
|
|
33
|
-
|
|
34
|
-
if (stmt.reader) {
|
|
35
|
-
const rows = (await stmt.all(...toSqliteBindValues(values)));
|
|
36
|
-
return this.buildUpdateResult({ rows });
|
|
37
|
-
}
|
|
38
|
-
const { changes, lastInsertRowid } = await stmt.run(...toSqliteBindValues(values));
|
|
39
|
-
return this.buildUpdateResult({ changes, id: lastInsertRowid });
|
|
13
|
+
const { rows, changes } = await this.execute(query, values);
|
|
14
|
+
// A driver's own count is unreliable for a RETURNING statement (Hrana answers 0), so its rows answer.
|
|
15
|
+
return this.buildUpdateResult({ rows: rows.map(decodeBigInts), changes: rows.length || changes });
|
|
40
16
|
}
|
|
17
|
+
/**
|
|
18
|
+
* SQLite drivers hold a single shared handle rather than a connection from a pool, so releasing
|
|
19
|
+
* a querier returns nothing at all. Drivers owning a closable per-querier connection override this.
|
|
20
|
+
*/
|
|
21
|
+
async internalRelease() { }
|
|
41
22
|
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import type { SqliteBindValue
|
|
2
|
-
import type {
|
|
1
|
+
import type { SqliteBindValue } from './abstractSqliteQuerier.js';
|
|
2
|
+
import type { LocalSqliteDatabase } from './localSqliteQuerierPool.js';
|
|
3
|
+
import type { SqliteRunResult } from './sqliteQuerier.js';
|
|
3
4
|
/** A `bun:sqlite` statement: better-sqlite3-shaped, except it reports columns instead of `reader`. */
|
|
4
5
|
type BunStatement = {
|
|
5
6
|
columnNames: string[];
|
|
@@ -13,7 +14,7 @@ type BunDatabase = {
|
|
|
13
14
|
close(): unknown;
|
|
14
15
|
};
|
|
15
16
|
/**
|
|
16
|
-
* Presents a `bun:sqlite` handle as a {@link
|
|
17
|
+
* Presents a `bun:sqlite` handle as a {@link LocalSqliteDatabase}.
|
|
17
18
|
*
|
|
18
19
|
* @remarks Its statements expose no `reader`, so without deriving one every `RETURNING` statement
|
|
19
20
|
* would take the `run()` path, which discards returned rows, and inserts would report no ids.
|
|
@@ -22,5 +23,5 @@ type BunDatabase = {
|
|
|
22
23
|
* Lives in a `.bun.ts` file because it only ever executes under Bun: the Node coverage run cannot
|
|
23
24
|
* reach it, and `sqliteQuerier.bun.test.ts` covers it under `test:bun` instead.
|
|
24
25
|
*/
|
|
25
|
-
export declare function adaptBunSqlite(db: BunDatabase):
|
|
26
|
+
export declare function adaptBunSqlite(db: BunDatabase): LocalSqliteDatabase;
|
|
26
27
|
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Presents a `bun:sqlite` handle as a {@link
|
|
2
|
+
* Presents a `bun:sqlite` handle as a {@link LocalSqliteDatabase}.
|
|
3
3
|
*
|
|
4
4
|
* @remarks Its statements expose no `reader`, so without deriving one every `RETURNING` statement
|
|
5
5
|
* would take the `run()` path, which discards returned rows, and inserts would report no ids.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ExtraOptions } from '../type/index.js';
|
|
1
|
+
import type { ExtraOptions, RawRow } from '../type/index.js';
|
|
2
2
|
import { AbstractSqliteQuerier, type SqliteBindValue } from './abstractSqliteQuerier.js';
|
|
3
3
|
import type { SqliteDialect } from './sqliteDialect.js';
|
|
4
4
|
/**
|
|
@@ -11,7 +11,6 @@ export type HranaInValue = SqliteBindValue | ArrayBuffer | Date;
|
|
|
11
11
|
export type HranaResultSet = {
|
|
12
12
|
rows: unknown[];
|
|
13
13
|
rowsAffected: number;
|
|
14
|
-
lastInsertRowid?: bigint;
|
|
15
14
|
};
|
|
16
15
|
export type HranaExecutor = {
|
|
17
16
|
execute(stmt: {
|
|
@@ -44,8 +43,11 @@ export declare class HranaQuerier extends AbstractSqliteQuerier {
|
|
|
44
43
|
private tx?;
|
|
45
44
|
private readonly closeClientOnRelease;
|
|
46
45
|
constructor(client: HranaClient, dialect: SqliteDialect, extra?: ExtraOptions | undefined, connection?: HranaQuerierConnectionOptions);
|
|
47
|
-
|
|
48
|
-
|
|
46
|
+
/** Runs on the open transaction's handle when there is one. */
|
|
47
|
+
protected execute(query: string, values?: unknown[]): Promise<{
|
|
48
|
+
rows: RawRow[];
|
|
49
|
+
changes: number;
|
|
50
|
+
}>;
|
|
49
51
|
protected internalBegin(): Promise<void>;
|
|
50
52
|
/**
|
|
51
53
|
* Both drop the handle before the call, not after: one that outlived a failed commit would carry
|
|
@@ -16,18 +16,10 @@ export class HranaQuerier extends AbstractSqliteQuerier {
|
|
|
16
16
|
this.extra = extra;
|
|
17
17
|
this.closeClientOnRelease = connection?.closeClientOnRelease ?? false;
|
|
18
18
|
}
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
const res = await
|
|
22
|
-
return res.rows;
|
|
23
|
-
}
|
|
24
|
-
async internalRun(query, values) {
|
|
25
|
-
const target = this.tx || this.client;
|
|
26
|
-
const res = await target.execute({ sql: query, args: values });
|
|
27
|
-
const rows = res.rows;
|
|
28
|
-
// `rowsAffected` is unreliably 0 whenever the statement has a RETURNING clause, so prefer
|
|
29
|
-
// the actual row count when rows were returned.
|
|
30
|
-
return this.buildUpdateResult({ rows, changes: rows.length || res.rowsAffected, id: res.lastInsertRowid });
|
|
19
|
+
/** Runs on the open transaction's handle when there is one. */
|
|
20
|
+
async execute(query, values) {
|
|
21
|
+
const res = await (this.tx ?? this.client).execute({ sql: query, args: values });
|
|
22
|
+
return { rows: res.rows, changes: res.rowsAffected };
|
|
31
23
|
}
|
|
32
24
|
async internalBegin() {
|
|
33
25
|
this.tx = await this.client.transaction('write');
|
|
@@ -47,7 +39,6 @@ export class HranaQuerier extends AbstractSqliteQuerier {
|
|
|
47
39
|
await tx?.rollback();
|
|
48
40
|
}
|
|
49
41
|
async internalRelease() {
|
|
50
|
-
await super.internalRelease();
|
|
51
42
|
if (this.closeClientOnRelease) {
|
|
52
43
|
this.client.close();
|
|
53
44
|
}
|
package/dist/sqlite/index.d.ts
CHANGED
package/dist/sqlite/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { AbstractSharedHandleQuerierPool } from '../querier/abstractSharedHandleQuerierPool.js';
|
|
2
2
|
import type { ExtraOptions } from '../type/index.js';
|
|
3
3
|
import { SqliteDialect } from './sqliteDialect.js';
|
|
4
|
-
import { type
|
|
4
|
+
import { type SqlitePreparedStatement, SqliteQuerier } from './sqliteQuerier.js';
|
|
5
5
|
/** What every local SQLite pool accepts on top of its driver's own options. */
|
|
6
6
|
export type LocalSqlitePoolOptions = {
|
|
7
7
|
/**
|
|
@@ -11,6 +11,15 @@ export type LocalSqlitePoolOptions = {
|
|
|
11
11
|
*/
|
|
12
12
|
extensions?: readonly string[];
|
|
13
13
|
};
|
|
14
|
+
/**
|
|
15
|
+
* A database opened in this process by a driver that answers at once, and installs loadable extensions
|
|
16
|
+
* (`sqlite-vec`, ...) into its connection.
|
|
17
|
+
*/
|
|
18
|
+
export type LocalSqliteDatabase = {
|
|
19
|
+
prepare(sql: string): SqlitePreparedStatement;
|
|
20
|
+
loadExtension(path: string): void;
|
|
21
|
+
close(): unknown;
|
|
22
|
+
};
|
|
14
23
|
/**
|
|
15
24
|
* Pool for a SQLite database opened in this process, whichever driver provides it. SQLite gives one
|
|
16
25
|
* connection per file, so the shared-handle lifecycle is {@link AbstractSharedHandleQuerierPool}'s.
|
|
@@ -18,11 +27,11 @@ export type LocalSqlitePoolOptions = {
|
|
|
18
27
|
* Subclasses supply only {@link createDb}: configuring the connection on the way up - the pragmas,
|
|
19
28
|
* then the extensions - is the same for `better-sqlite3`, `bun:sqlite` and `node:sqlite`.
|
|
20
29
|
*/
|
|
21
|
-
export declare abstract class AbstractLocalSqliteQuerierPool<O extends LocalSqlitePoolOptions> extends AbstractSharedHandleQuerierPool<
|
|
30
|
+
export declare abstract class AbstractLocalSqliteQuerierPool<O extends LocalSqlitePoolOptions> extends AbstractSharedHandleQuerierPool<LocalSqliteDatabase, SqliteQuerier, SqliteDialect> {
|
|
22
31
|
readonly opts?: O | undefined;
|
|
23
32
|
constructor(opts?: O | undefined, extra?: ExtraOptions);
|
|
24
33
|
/** Opens the driver's database, and nothing more: the caller configures it. */
|
|
25
|
-
protected abstract createDb(): Promise<
|
|
26
|
-
protected openDb(): Promise<
|
|
27
|
-
protected buildQuerier(db:
|
|
34
|
+
protected abstract createDb(): Promise<LocalSqliteDatabase>;
|
|
35
|
+
protected openDb(): Promise<LocalSqliteDatabase>;
|
|
36
|
+
protected buildQuerier(db: LocalSqliteDatabase): SqliteQuerier;
|
|
28
37
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { SqliteBindValue } from './abstractSqliteQuerier.js';
|
|
2
|
-
import type {
|
|
2
|
+
import type { LocalSqliteDatabase } from './localSqliteQuerierPool.js';
|
|
3
3
|
/**
|
|
4
4
|
* A `node:sqlite` statement: better-sqlite3-shaped, except it describes columns instead of reporting
|
|
5
5
|
* `reader`, and types `changes` as possibly `bigint` where better-sqlite3 always answers a `number`.
|
|
@@ -9,7 +9,6 @@ type NodeSqliteStatement = {
|
|
|
9
9
|
all(...values: SqliteBindValue[]): unknown[];
|
|
10
10
|
run(...values: SqliteBindValue[]): {
|
|
11
11
|
changes: number | bigint;
|
|
12
|
-
lastInsertRowid: number | bigint;
|
|
13
12
|
};
|
|
14
13
|
iterate(...values: SqliteBindValue[]): Iterable<unknown>;
|
|
15
14
|
};
|
|
@@ -23,12 +22,12 @@ export type NodeSqliteDatabase = {
|
|
|
23
22
|
close(): void;
|
|
24
23
|
};
|
|
25
24
|
/**
|
|
26
|
-
* Presents a `node:sqlite` handle as a {@link
|
|
25
|
+
* Presents a `node:sqlite` handle as a {@link LocalSqliteDatabase}.
|
|
27
26
|
*
|
|
28
27
|
* @remarks Its statements expose no `reader`, so without deriving one every `RETURNING` statement
|
|
29
28
|
* would take the `run()` path, which discards returned rows, and inserts would report no ids.
|
|
30
29
|
* `columns()` is non-empty for exactly the statements better-sqlite3 marks as readers, including
|
|
31
30
|
* `INSERT ... RETURNING` and `DELETE ... RETURNING`.
|
|
32
31
|
*/
|
|
33
|
-
export declare function adaptNodeSqlite(db: NodeSqliteDatabase):
|
|
32
|
+
export declare function adaptNodeSqlite(db: NodeSqliteDatabase): LocalSqliteDatabase;
|
|
34
33
|
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Presents a `node:sqlite` handle as a {@link
|
|
2
|
+
* Presents a `node:sqlite` handle as a {@link LocalSqliteDatabase}.
|
|
3
3
|
*
|
|
4
4
|
* @remarks Its statements expose no `reader`, so without deriving one every `RETURNING` statement
|
|
5
5
|
* would take the `run()` path, which discards returned rows, and inserts would report no ids.
|
|
@@ -14,11 +14,8 @@ export function adaptNodeSqlite(db) {
|
|
|
14
14
|
reader: stmt.columns().length > 0,
|
|
15
15
|
all: (...values) => stmt.all(...values),
|
|
16
16
|
// `changes` is narrowed to `number` to match every other driver; a row count cannot exceed
|
|
17
|
-
// the safe-integer range, so nothing is lost.
|
|
18
|
-
run: (...values) => {
|
|
19
|
-
const { changes, lastInsertRowid } = stmt.run(...values);
|
|
20
|
-
return { changes: Number(changes), lastInsertRowid };
|
|
21
|
-
},
|
|
17
|
+
// the safe-integer range, so nothing is lost.
|
|
18
|
+
run: (...values) => ({ changes: Number(stmt.run(...values).changes) }),
|
|
22
19
|
iterate: (...values) => stmt.iterate(...values),
|
|
23
20
|
};
|
|
24
21
|
},
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import type { ExtraOptions } from '../type/index.js';
|
|
2
|
-
import { AbstractLocalSqliteQuerierPool, type LocalSqlitePoolOptions } from './localSqliteQuerierPool.js';
|
|
3
|
-
import type { SqliteDatabase } from './sqliteQuerier.js';
|
|
2
|
+
import { AbstractLocalSqliteQuerierPool, type LocalSqliteDatabase, type LocalSqlitePoolOptions } from './localSqliteQuerierPool.js';
|
|
4
3
|
/**
|
|
5
4
|
* The `DatabaseSync` options worth surfacing, plus the loadable extensions to install. Declared here
|
|
6
5
|
* rather than imported from `node:sqlite` so this module needs no ambient Node types; unknown keys
|
|
@@ -24,5 +23,5 @@ export type NodeSqlitePoolOptions = LocalSqlitePoolOptions & {
|
|
|
24
23
|
export declare class NodeSqliteQuerierPool extends AbstractLocalSqliteQuerierPool<NodeSqlitePoolOptions> {
|
|
25
24
|
readonly filename: string;
|
|
26
25
|
constructor(filename?: string, opts?: NodeSqlitePoolOptions, extra?: ExtraOptions);
|
|
27
|
-
protected createDb(): Promise<
|
|
26
|
+
protected createDb(): Promise<LocalSqliteDatabase>;
|
|
28
27
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AbstractLocalSqliteQuerierPool } from './localSqliteQuerierPool.js';
|
|
1
|
+
import { AbstractLocalSqliteQuerierPool, } from './localSqliteQuerierPool.js';
|
|
2
2
|
import { adaptNodeSqlite } from './nodeSqliteAdapter.js';
|
|
3
3
|
/**
|
|
4
4
|
* Pool backed by Node's built-in `node:sqlite`, so SQLite works with **no dependency at all** rather
|
|
@@ -20,6 +20,8 @@ export class NodeSqliteQuerierPool extends AbstractLocalSqliteQuerierPool {
|
|
|
20
20
|
const { extensions, ...driverOpts } = this.opts ?? {};
|
|
21
21
|
const nodeDb = new DatabaseSync(this.filename, {
|
|
22
22
|
...driverOpts,
|
|
23
|
+
// Integers as `bigint`, which the querier decodes exactly past 2^53.
|
|
24
|
+
readBigInts: true,
|
|
23
25
|
// `node:sqlite` refuses `loadExtension` unless the database was opened with this on.
|
|
24
26
|
...(extensions?.length ? { allowExtension: true } : undefined),
|
|
25
27
|
});
|
|
@@ -16,7 +16,7 @@ export declare class SqliteDialect extends AbstractSqlDialect {
|
|
|
16
16
|
/** SQLite locks the whole database, not rows, so `$lock` has nothing to map onto. */
|
|
17
17
|
readonly supportsRowLocks = false;
|
|
18
18
|
readonly booleanLiteral = "integer";
|
|
19
|
-
/**
|
|
19
|
+
/** SQLite's own cap on a function call before 3.48, which libSQL and `bun:sqlite`'s build still have. */
|
|
20
20
|
readonly maxFunctionArgs: number;
|
|
21
21
|
readonly insertIdSource = "returning";
|
|
22
22
|
/**
|
|
@@ -39,7 +39,7 @@ export class SqliteDialect extends AbstractSqlDialect {
|
|
|
39
39
|
/** SQLite locks the whole database, not rows, so `$lock` has nothing to map onto. */
|
|
40
40
|
supportsRowLocks = false;
|
|
41
41
|
booleanLiteral = 'integer';
|
|
42
|
-
/**
|
|
42
|
+
/** SQLite's own cap on a function call before 3.48, which libSQL and `bun:sqlite`'s build still have. */
|
|
43
43
|
maxFunctionArgs = 127;
|
|
44
44
|
// SQLite supports `RETURNING` (including on `INSERT ... ON CONFLICT`), so IDs are exact per row.
|
|
45
45
|
insertIdSource = 'returning';
|
|
@@ -1,12 +1,3 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
/**
|
|
3
|
-
* How every local SQLite connection opens. WAL, so a reader does not wait on the writer, and
|
|
4
|
-
* `foreign_keys`, which SQLite ships off per connection for backward compatibility: without it the
|
|
5
|
-
* constraints uql's own DDL declares are decorative - a declared `onDelete: 'CASCADE'` silently does
|
|
6
|
-
* nothing and a dangling reference is accepted.
|
|
7
|
-
*/
|
|
8
|
-
export declare const SQLITE_PRAGMAS: readonly ['journal_mode = WAL', 'foreign_keys = ON'];
|
|
1
|
+
import type { SqliteDatabase } from './sqliteQuerier.js';
|
|
9
2
|
/** Runs {@link SQLITE_PRAGMAS} through a driver's own statements, whether it answers now or later. */
|
|
10
|
-
export declare function applySqlitePragmas(db:
|
|
11
|
-
prepare(sql: string): SqlitePreparedStatement | Promise<SqlitePreparedStatement>;
|
|
12
|
-
}): Promise<void>;
|
|
3
|
+
export declare function applySqlitePragmas(db: Pick<SqliteDatabase, 'prepare'>): Promise<void>;
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* constraints uql's own DDL declares are decorative - a declared `onDelete: 'CASCADE'` silently does
|
|
5
5
|
* nothing and a dangling reference is accepted.
|
|
6
6
|
*/
|
|
7
|
-
|
|
7
|
+
const SQLITE_PRAGMAS = ['journal_mode = WAL', 'foreign_keys = ON'];
|
|
8
8
|
/** Runs {@link SQLITE_PRAGMAS} through a driver's own statements, whether it answers now or later. */
|
|
9
9
|
export async function applySqlitePragmas(db) {
|
|
10
10
|
for (const pragma of SQLITE_PRAGMAS) {
|