RNQSDBAdapter

Adapter for React Native Quick SQLite

Extends

• BaseObserver<DBAdapterListener>

Implements

• DBAdapter

Constructors

new RNQSDBAdapter()

new RNQSDBAdapter(baseDB, name): RNQSDBAdapter

Parameters

Parameter	Type
baseDB	QuickSQLiteConnection
name	string

Returns

RNQSDBAdapter

Overrides

BaseObserver.constructor

Properties

Property	Modifier	Type	Description
get	public	<T>(sql: string, parameters?: any[]) => Promise<T>	Execute a read-only query and return the first result, error if the ResultSet is empty.
getAll	public	<T>(sql: string, parameters?: any[]) => Promise<T[]>	Execute a read-only query and return results.
getOptional	public	<T>(sql: string, parameters?: any[]) => Promise<null | T>	Execute a read-only query and return the first result, or null if the ResultSet is empty.
name	public	string	-

Methods

close()

close(): void

Returns

void

Implementation of

DBAdapter.close

---

dispose()

dispose(): void

Returns

void

Inherited from

BaseObserver.dispose

---

execute()

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

Parameters

Parameter	Type
query	string
params?	any[]

Returns

Promise<QueryResult>

Implementation of

DBAdapter.execute

---

executeBatch()

executeBatch(query, params): Promise<QueryResult>

Parameters

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

Returns

Promise<QueryResult>

Implementation of

DBAdapter.executeBatch

---

executeRaw()

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

'executeRaw' is not implemented in RNQS, this falls back to 'execute'.

Parameters

Parameter	Type
query	string
params?	any[]

Returns

Promise<any[][]>

Implementation of

DBAdapter.executeRaw

---

generateContext()

generateContext<T>(ctx): T & {
  executeRaw: (sql, params?) => Promise<unknown[][]>;
}

Type Parameters

Type Parameter
T extends LockContext

Parameters

Parameter	Type
ctx	T

Returns

T & { executeRaw: (sql, params?) => Promise<unknown[][]>; }

---

iterateAsyncListeners()

iterateAsyncListeners(cb): Promise<void>

Parameters

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

Returns

Promise<void>

Inherited from

BaseObserver.iterateAsyncListeners

---

iterateListeners()

iterateListeners(cb): void

Parameters

Parameter	Type
cb	(listener) => any

Returns

void

Inherited from

BaseObserver.iterateListeners

---

readLock()

readLock<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.readLock

---

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

---

refreshSchema()

refreshSchema(): Promise<void>

This method refreshes the schema information across all connections. This is for advanced use cases, and should generally not be needed.

Returns

Promise<void>

Implementation of

DBAdapter.refreshSchema

---

registerListener()

registerListener(listener): () => void

Register a listener for updates to the PowerSync client.

Parameters

Parameter	Type
listener	Partial<DBAdapterListener>

Returns

Function

Returns

void

Implementation of

DBAdapter.registerListener

Inherited from

BaseObserver.registerListener

---

writeLock()

writeLock<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.writeLock

---

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