Class Database

The query methods, shared by a database and by a transaction.

Hierarchy

QueryApi
- Database

Implements

SQLiteDatabase

Index

Constructors

constructor

new Database(
    backend: Backend,
    resolvedPath: string,
    options?: DatabaseOptions,
    engines?: string[],
): Database
Parameters
- backend: Backend
- resolvedPath: string
- Optionaloptions: DatabaseOptions
- Optionalengines: string[]
Returns Database
Overrides QueryApi.constructor
- Defined in packages/sqlite-core/database.d.ts:38

Properties

`Protected`backend

backend: Backend

`Readonly`filePath

filePath: string

`Protected`options

options: DatabaseOptions

`Readonly`ready

ready: Promise<void>

resolves when the database is opened, rejects with the open error

Accessors

isOpen

get isOpen(): boolean
true once the database is opened and until it is closed

Returns boolean
Implementation of SQLiteDatabase.isOpen
- Defined in packages/sqlite-core/database.d.ts:41

Methods

batch

batch(
statements: (string | BatchStatement | [string, SqliteParams?])[],
options?: BatchOptions,
): Promise<BatchResult[]>
Parameters
- statements: (string | BatchStatement | [string, SqliteParams?])[]
- Optionaloptions: BatchOptions
Returns Promise<BatchResult[]>
Implementation of SQLiteDatabase.batch
Inherited from QueryApi.batch
- Defined in packages/sqlite-core/database.d.ts:25

canLoadExtensions

canLoadExtensions(): boolean
false when the engine in use cannot load extensions (loadExtension would reject)

Returns boolean
Implementation of SQLiteDatabase.canLoadExtensions
- Defined in packages/sqlite-core/database.d.ts:43

close

close(): Promise<void>
Returns Promise<void>
Implementation of SQLiteDatabase.close
- Defined in packages/sqlite-core/database.d.ts:49

each

each(
    query: string,
    params: SqliteParams,
    callback: (error: Error, row: SqliteRow) => void,
    complete?: (error: Error, count: number) => void,
    options?: SqliteRequestOptions,
): Promise<number>
streams rows in chunks, resolves with the number of rows
Parameters
- query: string
- params: SqliteParams
- callback: (error: Error, row: SqliteRow) => void
- Optionalcomplete: (error: Error, count: number) => void
- Optionaloptions: SqliteRequestOptions
Returns Promise<number>
Implementation of SQLiteDatabase.each
Inherited from QueryApi.each
- Defined in packages/sqlite-core/database.d.ts:24

execute

execute(query: string, params?: SqliteParams): Promise<ExecResult>
Parameters
- query: string
- Optionalparams: SqliteParams
Returns Promise<ExecResult>
Implementation of SQLiteDatabase.execute
Inherited from QueryApi.execute
- Defined in packages/sqlite-core/database.d.ts:10

executeScript

executeScript(script: string): Promise<void>
run several statements separated by ;, without parameters
Parameters
- script: string
Returns Promise<void>
Implementation of SQLiteDatabase.executeScript
Inherited from QueryApi.executeScript
- Defined in packages/sqlite-core/database.d.ts:11

executeSync

executeSync(query: string, params?: SqliteParams): ExecResult
Blocking variants: they wait for the database thread on the calling thread, saving the event loop round trip for small statements in a loop, and block it for the whole statement. Node-API binding only (NativeScript >= 9.1).
Parameters
- query: string
- Optionalparams: SqliteParams
Returns ExecResult
Implementation of SQLiteDatabase.executeSync
Inherited from QueryApi.executeSync
- Defined in packages/sqlite-core/database.d.ts:14

get

get(
    query: string,
    params?: SqliteParams,
    options?: SqliteRequestOptions,
): Promise<SqliteRow>
Parameters
- query: string
- Optionalparams: SqliteParams
- Optionaloptions: SqliteRequestOptions
Returns Promise<SqliteRow>
Implementation of SQLiteDatabase.get
Inherited from QueryApi.get
- Defined in packages/sqlite-core/database.d.ts:22

getArray

getArray(
    query: string,
    params?: SqliteParams,
    options?: SqliteRequestOptions,
): Promise<any[]>
Parameters
- query: string
- Optionalparams: SqliteParams
- Optionaloptions: SqliteRequestOptions
Returns Promise<any[]>
Implementation of SQLiteDatabase.getArray
Inherited from QueryApi.getArray
- Defined in packages/sqlite-core/database.d.ts:23

getArraySync

getArraySync(
    query: string,
    params?: SqliteParams,
    options?: SqliteRequestOptions,
): any[]
Parameters
- query: string
- Optionalparams: SqliteParams
- Optionaloptions: SqliteRequestOptions
Returns any[]
Implementation of SQLiteDatabase.getArraySync
Inherited from QueryApi.getArraySync
- Defined in packages/sqlite-core/database.d.ts:18

getSqliteVersion

getSqliteVersion(): string
version of the SQLite library in use

Returns string
Implementation of SQLiteDatabase.getSqliteVersion
- Defined in packages/sqlite-core/database.d.ts:42

getSync

getSync(
    query: string,
    params?: SqliteParams,
    options?: SqliteRequestOptions,
): SqliteRow
Parameters
- query: string
- Optionalparams: SqliteParams
- Optionaloptions: SqliteRequestOptions
Returns SqliteRow
Implementation of SQLiteDatabase.getSync
Inherited from QueryApi.getSync
- Defined in packages/sqlite-core/database.d.ts:17

getVersion

getVersion(): Promise<any>
Returns Promise<any>
Implementation of SQLiteDatabase.getVersion
- Defined in packages/sqlite-core/database.d.ts:44

`Protected`handle

handle(): any
Returns any
Overrides QueryApi.handle
- Defined in packages/sqlite-core/database.d.ts:39

loadExtension

loadExtension(path: string, entryPoint?: string): Promise<void>
Loads a SQLite extension into this connection; needs an engine that allows it (see canLoadExtensions). entryPoint defaults to the one SQLite derives from the file name (libfoo.so -> sqlite3_foo_init).
Parameters
- path: string
- OptionalentryPoint: string
Returns Promise<void>
Implementation of SQLiteDatabase.loadExtension
- Defined in packages/sqlite-core/database.d.ts:48

select

select(
    query: string,
    params?: SqliteParams,
    options?: SqliteRequestOptions,
): Promise<SqliteRow[]>
Parameters
- query: string
- Optionalparams: SqliteParams
- Optionaloptions: SqliteRequestOptions
Returns Promise<SqliteRow[]>
Implementation of SQLiteDatabase.select
Inherited from QueryApi.select
- Defined in packages/sqlite-core/database.d.ts:20

selectArray

selectArray(
    query: string,
    params?: SqliteParams,
    options?: SqliteRequestOptions,
): Promise<any[][]>
Parameters
- query: string
- Optionalparams: SqliteParams
- Optionaloptions: SqliteRequestOptions
Returns Promise<any[][]>
Implementation of SQLiteDatabase.selectArray
Inherited from QueryApi.selectArray
- Defined in packages/sqlite-core/database.d.ts:21

selectArraySync

selectArraySync(
    query: string,
    params?: SqliteParams,
    options?: SqliteRequestOptions,
): any[][]
Parameters
- query: string
- Optionalparams: SqliteParams
- Optionaloptions: SqliteRequestOptions
Returns any[][]
Implementation of SQLiteDatabase.selectArraySync
Inherited from QueryApi.selectArraySync
- Defined in packages/sqlite-core/database.d.ts:16

selectSync

selectSync(
    query: string,
    params?: SqliteParams,
    options?: SqliteRequestOptions,
): SqliteRow[]
Parameters
- query: string
- Optionalparams: SqliteParams
- Optionaloptions: SqliteRequestOptions
Returns SqliteRow[]
Implementation of SQLiteDatabase.selectSync
Inherited from QueryApi.selectSync
- Defined in packages/sqlite-core/database.d.ts:15

setVersion

setVersion(version: number): Promise<void>
Parameters
- version: number
Returns Promise<void>
Implementation of SQLiteDatabase.setVersion
- Defined in packages/sqlite-core/database.d.ts:45

transaction

transaction<T = any>(
action: (cancel: () => void, tx: SQLiteTransaction) => T | Promise<T>,
options?: TransactionOptions,
): Promise<T>
Runs action in a transaction: COMMIT when it resolves, ROLLBACK when it throws or cancel() was called. Other calls made on this database meanwhile join it (use tx to be explicit); requests of other parts of the app wait for the end.
Type Parameters
- T = any
Parameters
- action: (cancel: () => void, tx: SQLiteTransaction) => T | Promise<T>
- Optionaloptions: TransactionOptions
Returns Promise<T>
Implementation of SQLiteDatabase.transaction
- Defined in packages/sqlite-core/database.d.ts:46

`Protected`txId

txId(): number
the transaction a call belongs to, 0 for none

Returns number
Overrides QueryApi.txId
- Defined in packages/sqlite-core/database.d.ts:40

Class Database

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Database

Properties

Protectedbackend

ReadonlyfilePath

Protectedoptions

Readonlyready

Accessors

isOpen

Returns boolean

Methods

batch

Parameters

Returns Promise<BatchResult[]>

canLoadExtensions

Returns boolean

close

Returns Promise<void>

each

Parameters

Returns Promise<number>

execute

Parameters

Returns Promise<ExecResult>

executeScript

Parameters

Returns Promise<void>

executeSync

Parameters

Returns ExecResult

get

Parameters

Returns Promise<SqliteRow>

getArray

Parameters

Returns Promise<any[]>

getArraySync

Parameters

Returns any[]

getSqliteVersion

Returns string

getSync

Parameters

Returns SqliteRow

getVersion

Returns Promise<any>

Protectedhandle

Returns any

loadExtension

Parameters

Returns Promise<void>

select

Parameters

Returns Promise<SqliteRow[]>

selectArray

Parameters

Returns Promise<any[][]>

selectArraySync

Parameters

Returns any[][]

selectSync

Parameters

Returns SqliteRow[]

setVersion

Parameters

Returns Promise<void>

transaction

Type Parameters

Parameters

Returns Promise<T>

`Protected`backend

`Readonly`filePath

`Protected`options

`Readonly`ready

`Protected`handle

`Protected`txId