sqlocal / index / SQLocalDriver
Interface: SQLocalDriver
Defined in: src/types.ts:77
Properties
clear
ts
clear: () => Promise<void>;Defined in: src/types.ts:99
Returns
Promise<void>
createFunction
ts
createFunction: (fn) => Promise<void>;Defined in: src/types.ts:88
Parameters
| Parameter | Type |
|---|---|
fn | UserFunction |
Returns
Promise<void>
destroy
ts
destroy: () => Promise<void>;Defined in: src/types.ts:100
Returns
Promise<void>
exec
ts
exec: (statement) => Promise<RawResultData>;Defined in: src/types.ts:80
Parameters
| Parameter | Type |
|---|---|
statement | DriverStatement |
Returns
Promise<RawResultData>
execBatch
ts
execBatch: (statements, method?) => Promise<RawResultData[]>;Defined in: src/types.ts:81
Parameters
| Parameter | Type |
|---|---|
statements | DriverStatement[] |
method? | "transaction" | "savepoint" |
Returns
Promise<RawResultData[]>
export
ts
export: () => Promise<{
data: ArrayBuffer | Uint8Array<ArrayBuffer>;
name: string;
}>;Defined in: src/types.ts:95
Returns
Promise<{ data: ArrayBuffer | Uint8Array<ArrayBuffer>; name: string; }>
getDatabaseSizeBytes
ts
getDatabaseSizeBytes: () => Promise<number>;Defined in: src/types.ts:87
Returns
Promise<number>
import
ts
import: (database) => Promise<void>;Defined in: src/types.ts:89
Parameters
| Parameter | Type |
|---|---|
database | | ArrayBuffer | Uint8Array<ArrayBuffer> | ReadableStream<Uint8Array<ArrayBuffer>> |
Returns
Promise<void>
init
ts
init: (config) => Promise<void>;Defined in: src/types.ts:79
Parameters
| Parameter | Type |
|---|---|
config | DriverConfig |
Returns
Promise<void>
isDatabasePersisted
ts
isDatabasePersisted: () => Promise<boolean>;Defined in: src/types.ts:86
Returns
Promise<boolean>
onWrite
ts
onWrite: (callback) => () => void;Defined in: src/types.ts:85
Parameters
| Parameter | Type |
|---|---|
callback | (change) => void |
Returns
() => void
storageType
ts
readonly storageType: Sqlite3StorageType;Defined in: src/types.ts:78