CapacitorSQLiteAdapter

Experimental Alpha

An implementation of DBAdapter using the Capacitor Community SQLite plugin.

This is currently experimental and may change without a major version bump.

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>; } & CapacitorConnectionPool<this>

Constructors

new CapacitorSQLiteAdapter()

new CapacitorSQLiteAdapter(options): CapacitorSQLiteAdapter

Alpha Experimental

Parameters

Parameter	Type
options	CapacitorSQLiteOpenFactoryOptions

Returns

CapacitorSQLiteAdapter

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).constructor

Properties

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

Methods

dispose()

dispose(): void

Alpha Experimental

Returns

void

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).dispose

---

execute()

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

Alpha Experimental

Parameters

Parameter	Type
query	string
params?	any[]

Returns

Promise<QueryResult>

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).execute

---

executeBatch()

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

Alpha Experimental

Parameters

Parameter	Type
query	string
params?	any[][]

Returns

Promise<QueryResult>

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).executeBatch

---

executeRaw()

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

Alpha Experimental

Parameters

Parameter	Type
query	string
params?	any[]

Returns

Promise<any[][]>

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).executeRaw

---

get()

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

Alpha Experimental

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
sql	string
parameters?	any[]

Returns

Promise<T>

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).get

---

getAll()

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

Alpha Experimental

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
sql	string
parameters?	any[]

Returns

Promise<T[]>

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).getAll

---

getOptional()

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

Alpha Experimental

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
sql	string
parameters?	any[]

Returns

Promise<null | T>

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).getOptional

---

iterateAsyncListeners()

iterateAsyncListeners(cb): Promise<void>

Alpha Experimental

Parameters

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

Returns

Promise<void>

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).iterateAsyncListeners

---

iterateListeners()

iterateListeners(cb): void

Alpha Experimental

Parameters

Parameter	Type
cb	(listener) => any

Returns

void

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).iterateListeners

---

readTransaction()

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

Alpha Experimental

Type Parameters

Type Parameter
T

Parameters

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

Returns

Promise<T>

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).readTransaction

---

registerListener()

registerListener(listener): () => void

Alpha Experimental

Parameters

Parameter	Type
listener	Partial<DBAdapterListener>

Returns

Function

Returns

void

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).registerListener

---

writeTransaction()

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

Alpha Experimental

Type Parameters

Type Parameter
T

Parameters

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

Returns

Promise<T>

Inherited from

DBAdapterDefaultMixin(CapacitorConnectionPool).writeTransaction