RNQSDBAdapter

Adapter for React Native Quick SQLite

Extends

• { close: () => void | Promise<void>; name: string; readLock: <T>(fn, options?) => Promise<T>; refreshSchema: () => Promise<void>; writeLock: <T>(fn, options?) => Promise<T>; execute: Promise<QueryResult>; executeBatch: Promise<QueryResult>; executeRaw: Promise<any[][]>; get: Promise<T>; getAll: Promise<T[]>; getOptional: Promise<null | T>; readTransaction: Promise<T>; registerListener: () => void; writeTransaction: Promise<T>; } & RNQSConnectionPool<this>

Implements

• DBAdapter

Constructors

new RNQSDBAdapter()

new RNQSDBAdapter(baseDB, name): RNQSDBAdapter

Parameters

Parameter	Type
baseDB	QuickSQLiteConnection
name	string

Returns

RNQSDBAdapter

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).constructor

Properties

Property	Type	Description	Inherited from
close	() => void | Promise<void> & () => void	-	DBAdapter.close DBAdapterDefaultMixin(RNQSConnectionPool).close
name	string	-	DBAdapter.name DBAdapterDefaultMixin(RNQSConnectionPool).name
readLock	<T>(fn, options?) => Promise<T> & <T>(fn, options?) => Promise<T>	-	DBAdapter.readLock DBAdapterDefaultMixin(RNQSConnectionPool).readLock
refreshSchema	() => Promise<void> & () => Promise<void>	This method refreshes the schema information across all connections. This is for advanced use cases, and should generally not be needed.	DBAdapter.refreshSchema DBAdapterDefaultMixin(RNQSConnectionPool).refreshSchema
writeLock	<T>(fn, options?) => Promise<T> & <T>(fn, options?) => Promise<T>	-	DBAdapter.writeLock DBAdapterDefaultMixin(RNQSConnectionPool).writeLock

Methods

dispose()

dispose(): void

Returns

void

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).dispose

---

execute()

execute(query, params?): Promise<QueryResult>

Execute a single write statement.

Parameters

Parameter	Type
query	string
params?	any[]

Returns

Promise<QueryResult>

Implementation of

DBAdapter.execute

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).execute

---

executeBatch()

executeBatch(query, params): Promise<QueryResult>

Parameters

Parameter	Type	Default value
query	string	undefined
params	any[][]	[]

Returns

Promise<QueryResult>

Implementation of

DBAdapter.executeBatch

Overrides

DBAdapterDefaultMixin(RNQSConnectionPool).executeBatch

---

executeRaw()

executeRaw(query, params?): Promise<any[][]>

Execute a single write statement and return raw results. Unlike execute, which returns an object with structured key-value pairs, executeRaw returns a nested array of raw values, where each row is represented as an array of column values without field names.

Example result:

[ [ '1', 'list 1', '33', 'Post content', '1' ] ]

Where as execute's rows._array would have been:

[ { id: '33', name: 'list 1', content: 'Post content', list_id: '1' } ]

Parameters

Parameter	Type
query	string
params?	any[]

Returns

Promise<any[][]>

Implementation of

DBAdapter.executeRaw

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).executeRaw

---

generateContext()

generateContext<T>(ctx): QuickSqliteContext

Type Parameters

Type Parameter
T extends LockContext

Parameters

Parameter	Type
ctx	T

Returns

QuickSqliteContext

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).generateContext

---

get()

get<T>(sql, parameters?): Promise<T>

Execute a read-only query and return the first result, error if the ResultSet is empty.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
sql	string
parameters?	any[]

Returns

Promise<T>

Implementation of

DBAdapter.get

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).get

---

getAll()

getAll<T>(sql, parameters?): Promise<T[]>

Execute a read-only query and return results.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
sql	string
parameters?	any[]

Returns

Promise<T[]>

Implementation of

DBAdapter.getAll

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).getAll

---

getOptional()

getOptional<T>(sql, parameters?): Promise<null | T>

Execute a read-only query and return the first result, or null if the ResultSet is empty.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
sql	string
parameters?	any[]

Returns

Promise<null | T>

Implementation of

DBAdapter.getOptional

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).getOptional

---

iterateAsyncListeners()

iterateAsyncListeners(cb): Promise<void>

Parameters

Parameter	Type
cb	(listener) => Promise<any>

Returns

Promise<void>

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).iterateAsyncListeners

---

iterateListeners()

iterateListeners(cb): void

Parameters

Parameter	Type
cb	(listener) => any

Returns

void

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).iterateListeners

---

readTransaction()

readTransaction<T>(fn, options?): Promise<T>

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
fn	(tx) => Promise<T>
options?	DBLockOptions

Returns

Promise<T>

Implementation of

DBAdapter.readTransaction

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).readTransaction

---

registerListener()

registerListener(listener): () => void

Parameters

Parameter	Type
listener	Partial<DBAdapterListener>

Returns

Function

Returns

void

Implementation of

DBAdapter.registerListener

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).registerListener

---

writeTransaction()

writeTransaction<T>(fn, options?): Promise<T>

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
fn	(tx) => Promise<T>
options?	DBLockOptions

Returns

Promise<T>

Implementation of

DBAdapter.writeTransaction

Inherited from

DBAdapterDefaultMixin(RNQSConnectionPool).writeTransaction