/
SqliteConnectionOptions.ts
43 lines (36 loc) · 1.27 KB
/
SqliteConnectionOptions.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
import {BaseConnectionOptions} from "../../connection/BaseConnectionOptions";
/**
* Sqlite-specific connection options.
*/
export interface SqliteConnectionOptions extends BaseConnectionOptions {
/**
* Database type.
*/
readonly type: "sqlite";
/**
* Storage type or path to the storage.
*/
readonly database: string;
/**
* Encryption key for for SQLCipher.
*/
readonly key?: string;
/**
* In your SQLite application when you perform parallel writes its common to face SQLITE_BUSY error.
* This error indicates that SQLite failed to write to the database file since someone else already writes into it.
* Since SQLite cannot handle parallel saves this error cannot be avoided.
*
* To simplify life's of those who have this error this particular option sets a timeout within which ORM will try
* to perform requested write operation again and again until it receives SQLITE_BUSY error.
*
* Enabling WAL can improve your app performance and face less SQLITE_BUSY issues.
* Time in milliseconds.
*/
readonly busyErrorRetry?: number;
/**
* Enables WAL mode. By default its disabled.
*
* @see https://www.sqlite.org/wal.html
*/
readonly enableWAL?: boolean;
}