NitroSQLite

NitroSQLite

API Reference


API Reference / react-native-nitro-sqlite / NitroSQLite

Variable: NitroSQLite

const NitroSQLite: object

Type Declaration

execute

execute: <Row>(dbName, query, params?) => QueryResult<Row>

Type Parameters

Row

Row extends QueryResultRow = never

Parameters

dbName

string

query

string

params?

SQLiteQueryParams

Returns

QueryResult<Row>

executeAsync

executeAsync: <Row>(dbName, query, params?) => Promise<QueryResult<Row>>

Type Parameters

Row

Row extends QueryResultRow = never

Parameters

dbName

string

query

string

params?

SQLiteQueryParams

Returns

Promise<QueryResult<Row>>

executeBatch

executeBatch: (dbName, commands) => BatchQueryResult

Parameters

dbName

string

commands

BatchQueryCommand[]

Returns

BatchQueryResult

executeBatchAsync

executeBatchAsync: (dbName, commands) => Promise<BatchQueryResult>

Parameters

dbName

string

commands

BatchQueryCommand[]

Returns

Promise<BatchQueryResult>

native

native: NitroSQLite = HybridNitroSQLite

open

open: (options) => NitroSQLiteConnection

Parameters

options

NitroSQLiteConnectionOptions

Returns

NitroSQLiteConnection

transaction

transaction: <Result>(dbName, transactionCallback, isExclusive) => Promise<Result>

Type Parameters

Result

Result = void

Parameters

dbName

string

transactionCallback

(tx) => Promise<Result>

isExclusive?

boolean = false

Returns

Promise<Result>

attach()

attach(mainDbName, dbNameToAttach, alias, location?): void

Parameters

mainDbName

string

dbNameToAttach

string

alias

string

location?

string

Returns

void

close()

close(dbName): void

Parameters

dbName

string

Returns

void

detach()

detach(mainDbName, alias): void

Parameters

mainDbName

string

alias

string

Returns

void

drop()

drop(dbName, location?): void

Parameters

dbName

string

location?

string

Returns

void

loadFile()

loadFile(dbName, location): FileLoadResult

Parameters

dbName

string

location

string

Returns

FileLoadResult

loadFileAsync()

loadFileAsync(dbName, location): Promise<FileLoadResult>

Parameters

dbName

string

location

string

Returns

Promise<FileLoadResult>