sqlocal / index / SQLiteKvvfsDriver

Class: SQLiteKvvfsDriver

Defined in: src/drivers/sqlite-kvvfs-driver.ts:13

A SQLocal driver that implements the interface needed for interacting with SQLite databases in localStorage or sessionStorage.

Extends

• SQLiteMemoryDriver

Implements

• SQLocalDriver

Constructors

Constructor

new SQLiteKvvfsDriver(storageType, sqlite3InitModule?): SQLiteKvvfsDriver;

Defined in: src/drivers/sqlite-kvvfs-driver.ts:19

Parameters

Parameter	Type
storageType	"local" | "session"
sqlite3InitModule?	Sqlite3InitModule

Returns

SQLiteKvvfsDriver

Overrides

SQLiteMemoryDriver.constructor

Properties

storageType

readonly storageType: "local" | "session";

Defined in: src/drivers/sqlite-kvvfs-driver.ts:20

Implementation of

SQLocalDriver.storageType

Inherited from

SQLiteMemoryDriver.storageType

Methods

clear()

clear(): Promise<void>;

Defined in: src/drivers/sqlite-kvvfs-driver.ts:83

Returns

Promise<void>

Implementation of

SQLocalDriver.clear

Overrides

SQLiteMemoryDriver.clear

---

createFunction()

createFunction(fn): Promise<void>;

Defined in: src/drivers/sqlite-memory-driver.ts:136

Parameters

Parameter	Type
fn	UserFunction

Returns

Promise<void>

Implementation of

SQLocalDriver.createFunction

Inherited from

SQLiteMemoryDriver.createFunction

---

destroy()

destroy(): Promise<void>;

Defined in: src/drivers/sqlite-kvvfs-driver.ts:89

Returns

Promise<void>

Implementation of

SQLocalDriver.destroy

Overrides

SQLiteMemoryDriver.destroy

---

exec()

exec(statement): Promise<RawResultData>;

Defined in: src/drivers/sqlite-memory-driver.ts:65

Parameters

Parameter	Type
statement	DriverStatement

Returns

Promise<RawResultData>

Implementation of

SQLocalDriver.exec

Inherited from

SQLiteMemoryDriver.exec

---

execBatch()

execBatch(statements, method?): Promise<RawResultData[]>;

Defined in: src/drivers/sqlite-memory-driver.ts:71

Parameters

Parameter	Type	Default value
statements	DriverStatement[]	undefined
method	"transaction" | "savepoint"	'transaction'

Returns

Promise<RawResultData[]>

Implementation of

SQLocalDriver.execBatch

Inherited from

SQLiteMemoryDriver.execBatch

---

export()

export(): Promise<{
  data: ArrayBuffer | Uint8Array<ArrayBuffer>;
  name: string;
}>;

Defined in: src/drivers/sqlite-memory-driver.ts:185

Returns

Promise<{ data: ArrayBuffer | Uint8Array<ArrayBuffer>; name: string; }>

Implementation of

SQLocalDriver.export

Inherited from

SQLiteMemoryDriver.export

---

getDatabaseSizeBytes()

getDatabaseSizeBytes(): Promise<number>;

Defined in: src/drivers/sqlite-kvvfs-driver.ts:61

Returns

Promise<number>

Implementation of

SQLocalDriver.getDatabaseSizeBytes

Overrides

SQLiteMemoryDriver.getDatabaseSizeBytes

---

import()

import(database): Promise<void>;

Defined in: src/drivers/sqlite-kvvfs-driver.ts:67

Parameters

Parameter	Type
database	| ArrayBuffer | Uint8Array<ArrayBuffer> | ReadableStream<Uint8Array<ArrayBuffer>>

Returns

Promise<void>

Implementation of

SQLocalDriver.import

Overrides

SQLiteMemoryDriver.import

---

init()

init(config): Promise<void>;

Defined in: src/drivers/sqlite-kvvfs-driver.ts:26

Parameters

Parameter	Type
config	DriverConfig

Returns

Promise<void>

Implementation of

SQLocalDriver.init

Overrides

SQLiteMemoryDriver.init

---

isDatabasePersisted()

isDatabasePersisted(): Promise<boolean>;

Defined in: src/drivers/sqlite-kvvfs-driver.ts:57

Returns

Promise<boolean>

Implementation of

SQLocalDriver.isDatabasePersisted

Overrides

SQLiteMemoryDriver.isDatabasePersisted

---

onWrite()

onWrite(callback): () => void;

Defined in: src/drivers/sqlite-memory-driver.ts:57

Parameters

Parameter	Type
callback	(change) => void

Returns

() => void

Implementation of

SQLocalDriver.onWrite

Inherited from

SQLiteMemoryDriver.onWrite