22333330403

Committed 24 Feb 2026 01:58AM UTC coverage: 81.418% (-0.03%) from 81.451%

Build # 22333330403

Build Type

push

github

Committed by

web-flow

Commit Message

feat(sqlite)!: drop support for sqlite3 and default to better-sqlite3 (#11836)

Co-authored-by: Lucian Mocanu <alumni@users.noreply.github.com>
Co-authored-by: Giorgio Boa <35845425+gioboa@users.noreply.github.com>

Run Details

26555 of 32182 branches covered (82.52%)

Branch coverage included in aggregate %.

99 of 120 new or added lines in 5 files covered. (82.5%)

30 existing lines in 3 files now uncovered.

94931 of 117030 relevant lines covered (81.12%)

65233.75 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/driver/better-sqlite3/BetterSqlite3DataSourceOptions.ts

import { BaseDataSourceOptions } from "../../data-source/BaseDataSourceOptions"

/**
 * Sqlite-specific connection options.
 */
export interface BetterSqlite3DataSourceOptions extends BaseDataSourceOptions {
    /**
     * Database type.
     */
    readonly type: "better-sqlite3"

    /**
     * Storage type or path to the storage.
     */
    readonly database: string

    /**
     * The driver object
     * This defaults to require("better-sqlite3")
     */
    readonly driver?: any

    /**
     * Encryption key for for SQLCipher.
     */
    readonly key?: string

    /**
     * Cache size of sqlite statement to speed up queries.
     * Default: 100.
     */
    readonly statementCacheSize?: number

    /**
     * Function to run before a database is used in typeorm.
     * You can set pragmas, register plugins or register
     * functions or aggregates in this function.
     */
    readonly prepareDatabase?: (db: any) => void | Promise<void>

    /**
     * Open the database connection in readonly mode.
     * Default: false.
     */
    readonly readonly?: boolean

    /**
     * If the database does not exist, an Error will be thrown instead of creating a new file.
     * This option does not affect in-memory or readonly database connections.
     * Default: false.
     */
    readonly fileMustExist?: boolean

    /**
     * The number of milliseconds to wait when executing queries
     * on a locked database, before throwing a SQLITE_BUSY error.
     * Default: 5000.
     */
    readonly timeout?: number

    /**
     * Provide a function that gets called with every SQL string executed by the database connection.
     */
    readonly verbose?: Function

    /**
     * Relative or absolute path to the native addon (better_sqlite3.node).
     */
    readonly nativeBinding?: string

    /**
     * Not supported by better-sqlite3 (synchronous, single-connection driver).
     */
    readonly poolSize?: never

    /**
     * Enables WAL mode. By default its disabled.
     * @see https://www.sqlite.org/wal.html
     */
    readonly enableWAL?: boolean
}

1	import { BaseDataSourceOptions } from "../../data-source/BaseDataSourceOptions"	×
2		×
3	/**	×
4	* Sqlite-specific connection options.	×
5	*/	×
6	export interface BetterSqlite3DataSourceOptions extends BaseDataSourceOptions {	×
7	/**	×
8	* Database type.	×
9	*/	×
10	readonly type: "better-sqlite3"	×
11		×
12	/**	×
13	* Storage type or path to the storage.	×
14	*/	×
15	readonly database: string	×
16		×
17	/**	×
18	* The driver object	×
19	* This defaults to require("better-sqlite3")	×
20	*/	×
21	readonly driver?: any	×
22		×
23	/**	×
24	* Encryption key for for SQLCipher.	×
25	*/	×
26	readonly key?: string	×
27		×
28	/**	×
29	* Cache size of sqlite statement to speed up queries.	×
30	* Default: 100.	×
31	*/	×
32	readonly statementCacheSize?: number	×
33		×
34	/**	×
35	* Function to run before a database is used in typeorm.	×
36	* You can set pragmas, register plugins or register	×
37	* functions or aggregates in this function.	×
38	*/	×
39	readonly prepareDatabase?: (db: any) => void \| Promise<void>	×
40		×
41	/**	×
42	* Open the database connection in readonly mode.	×
43	* Default: false.	×
44	*/	×
45	readonly readonly?: boolean	×
46		×
47	/**	×
48	* If the database does not exist, an Error will be thrown instead of creating a new file.	×
49	* This option does not affect in-memory or readonly database connections.	×
50	* Default: false.	×
51	*/	×
52	readonly fileMustExist?: boolean	×
53		×
54	/**	×
55	* The number of milliseconds to wait when executing queries	×
56	* on a locked database, before throwing a SQLITE_BUSY error.	×
57	* Default: 5000.	×
58	*/	×
59	readonly timeout?: number	×
60		×
61	/**	×
62	* Provide a function that gets called with every SQL string executed by the database connection.	×
63	*/	×
64	readonly verbose?: Function	×
65		×
66	/**	×
67	* Relative or absolute path to the native addon (better_sqlite3.node).	×
68	*/	×
69	readonly nativeBinding?: string	×
70		×
NEW 71	/**	×
NEW 72	* Not supported by better-sqlite3 (synchronous, single-connection driver).	×
NEW 73	*/	×
74	readonly poolSize?: never	×
75		×
76	/**	×
77	* Enables WAL mode. By default its disabled.	×
78	* @see https://www.sqlite.org/wal.html	×
79	*/	×
80	readonly enableWAL?: boolean	×
81	}	×

typeorm / typeorm / 22333330403

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous