sqlocal / index / SQLocal

Class: SQLocal

Defined in: src/client.ts:52

This class is your entry point for connecting to and interacting with an on-device SQLite database in the browser.

See

https://sqlocal.dev/guide/setup

Extended by

• SQLocalDrizzle
• SQLocalKysely

Constructors

Constructor

new SQLocal(databasePath): SQLocal;

Defined in: src/client.ts:73

Parameters

Parameter	Type
databasePath	DatabasePath

Returns

SQLocal

Constructor

new SQLocal(config): SQLocal;

Defined in: src/client.ts:74

Parameters

Parameter	Type
config	ClientConfig

Returns

SQLocal

Methods

batch()

batch<Result>(passStatements): Promise<Result[][]>;

Defined in: src/client.ts:313

Execute a batch of SQL queries against the database in an atomic way.

Type Parameters

Type Parameter
Result extends Record<string, any>

Parameters

Parameter	Type
passStatements	(sql) => Statement[]

Returns

Promise<Result[][]>

See

https://sqlocal.dev/api/batch

---

createAggregateFunction()

createAggregateFunction(funcName, func): Promise<void>;

Defined in: src/client.ts:613

Create a SQL function that can be called from queries to combine multiple rows into a single result row.

Parameters

Parameter	Type
funcName	string
func	{ final: (...args) => any; step: (...args) => void; }
func.final	(...args) => any
func.step	(...args) => void

Returns

Promise<void>

See

https://sqlocal.dev/api/createaggregatefunction

---

createCallbackFunction()

createCallbackFunction(funcName, func): Promise<void>;

Defined in: src/client.ts:566

Create a SQL function that can be called from queries to trigger a JavaScript callback.

Parameters

Parameter	Type
funcName	string
func	(...args) => void

Returns

Promise<void>

See

https://sqlocal.dev/api/createcallbackfunction

---

createScalarFunction()

createScalarFunction(funcName, func): Promise<void>;

Defined in: src/client.ts:584

Create a SQL function that can be called from queries to transform column values or to filter rows.

Parameters

Parameter	Type
funcName	string
func	(...args) => any

Returns

Promise<void>

See

https://sqlocal.dev/api/createscalarfunction

---

deleteDatabaseFile()

deleteDatabaseFile(beforeUnlock?, destroy?): Promise<void>;

Defined in: src/client.ts:723

Delete the SQLite database file.

Parameters

Parameter	Type	Default value
beforeUnlock?	() => void | Promise<void>	undefined
destroy?	boolean	false

Returns

Promise<void>

See

https://sqlocal.dev/api/deletedatabasefile

---

destroy()

destroy(skipOptimize?): Promise<void>;

Defined in: src/client.ts:771

Disconnect this SQLocal client from the database and terminate its worker thread.

Parameters

Parameter	Type	Default value
skipOptimize	boolean	false

Returns

Promise<void>

See

https://sqlocal.dev/api/destroy

---

getDatabaseFile()

getDatabaseFile(): Promise<File>;

Defined in: src/client.ts:657

Access the SQLite database file so that it can be uploaded to the server or allowed to be downloaded by the user.

Returns

Promise<File>

See

https://sqlocal.dev/api/getdatabasefile

---

getDatabaseInfo()

getDatabaseInfo(): Promise<DatabaseInfo>;

Defined in: src/client.ts:642

Retrieve information about the SQLite database file.

Returns

Promise<DatabaseInfo>

See

https://sqlocal.dev/api/getdatabaseinfo

---

overwriteDatabaseFile()

overwriteDatabaseFile(databaseFile, beforeUnlock?): Promise<void>;

Defined in: src/client.ts:673

Replace the contents of the SQLite database file.

Parameters

Parameter	Type
databaseFile	| ArrayBuffer | Uint8Array<ArrayBuffer> | ReadableStream<Uint8Array<ArrayBuffer>> | File | Blob
beforeUnlock?	() => void | Promise<void>

Returns

Promise<void>

See

https://sqlocal.dev/api/overwritedatabasefile

---

reactiveQuery()

reactiveQuery<Result>(passStatement): ReactiveQuery<Result>;

Defined in: src/client.ts:448

Subscribe to a SQL query and receive the latest results whenever the read tables change.

Type Parameters

Type Parameter
Result extends Record<string, any>

Parameters

Parameter	Type
passStatement	StatementInput<Result>

Returns

ReactiveQuery<Result>

See

https://sqlocal.dev/api/reactivequery

---

sql()

sql<Result>(queryTemplate, ...params): Promise<Result[]>;

Defined in: src/client.ts:296

Execute SQL queries against the database.

Type Parameters

Type Parameter
Result extends Record<string, any>

Parameters

Parameter	Type
queryTemplate	string | TemplateStringsArray
...params	unknown[]

Returns

Promise<Result[]>

See

https://sqlocal.dev/api/sql

---

transaction()

transaction<Result>(transaction): Promise<Result>;

Defined in: src/client.ts:405

Execute SQL transactions against the database.

Type Parameters

Type Parameter
Result

Parameters

Parameter	Type
transaction	(tx) => Promise<Result>

Returns

Promise<Result>

See

https://sqlocal.dev/api/transaction