sqlocal / kysely / SQLocalKysely
Class: SQLocalKysely
Defined in: src/kysely/client.ts:18
A subclass of the SQLocal client that provides an additional property for using SQLocal as a dialect for the Kysely query builder.
See
https://sqlocal.dev/kysely/setup
Extends
Constructors
Constructor
new SQLocalKysely(databasePath): SQLocalKysely;Defined in: src/client.ts:75
Parameters
| Parameter | Type |
|---|---|
databasePath | DatabasePath |
Returns
SQLocalKysely
Inherited from
Constructor
new SQLocalKysely(config): SQLocalKysely;Defined in: src/client.ts:76
Parameters
| Parameter | Type |
|---|---|
config | ClientConfig |
Returns
SQLocalKysely
Inherited from
Properties
dialect
dialect: Dialect;Defined in: src/kysely/client.ts:24
A Kysely dialect that implements the interface needed for Kysely to interact with databases through SQLocal.
See
https://sqlocal.dev/kysely/setup
Methods
batch()
batch<Result>(passStatements): Promise<Result[][]>;Defined in: src/client.ts:315
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
Inherited from
createAggregateFunction()
createAggregateFunction(funcName, func): Promise<void>;Defined in: src/client.ts:628
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
Inherited from
SQLocal.createAggregateFunction
createCallbackFunction()
createCallbackFunction(funcName, func): Promise<void>;Defined in: src/client.ts:604
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
Inherited from
SQLocal.createCallbackFunction
createScalarFunction()
createScalarFunction(funcName, func): Promise<void>;Defined in: src/client.ts:616
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
Inherited from
createWindowFunction()
createWindowFunction(funcName, func): Promise<void>;Defined in: src/client.ts:640
Create a SQL function that can be called from queries to perform calculations for rows using data from related rows.
Parameters
| Parameter | Type |
|---|---|
funcName | string |
func | { final: (...args) => any; inverse: (...args) => void; step: (...args) => void; value: (...args) => any; } |
func.final | (...args) => any |
func.inverse | (...args) => void |
func.step | (...args) => void |
func.value | (...args) => any |
Returns
Promise<void>
See
https://sqlocal.dev/api/createwindowfunction
Inherited from
deleteDatabaseFile()
deleteDatabaseFile(beforeUnlock?, destroy?): Promise<void>;Defined in: src/client.ts:732
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
Inherited from
destroy()
destroy(skipOptimize?): Promise<void>;Defined in: src/client.ts:780
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
Inherited from
getDatabaseFile()
getDatabaseFile(): Promise<File>;Defined in: src/client.ts:666
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
Inherited from
getDatabaseInfo()
getDatabaseInfo(): Promise<DatabaseInfo>;Defined in: src/client.ts:651
Retrieve information about the SQLite database file.
Returns
Promise<DatabaseInfo>
See
https://sqlocal.dev/api/getdatabaseinfo
Inherited from
overwriteDatabaseFile()
overwriteDatabaseFile(databaseFile, beforeUnlock?): Promise<void>;Defined in: src/client.ts:682
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
Inherited from
reactiveQuery()
reactiveQuery<Result>(passStatement): ReactiveQuery<Result>;Defined in: src/client.ts:450
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
Inherited from
sql()
sql<Result>(queryTemplate, ...params): Promise<Result[]>;Defined in: src/client.ts:298
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
Inherited from
transaction()
transaction<Result>(transaction): Promise<Result>;Defined in: src/client.ts:407
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