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
BaseObserver<DBAdapterListener>
Implements
DBAdapter
Constructors
new CapacitorSQLiteAdapter()
new CapacitorSQLiteAdapter(options): CapacitorSQLiteAdapter
Alpha Experimental
Parameters
| Parameter | Type |
|---|---|
options | CapacitorSQLiteOpenFactoryOptions |
Returns
Overrides
BaseObserver<DBAdapterListener>.constructor
Accessors
name
Get Signature
get name(): string
Alpha Experimental
Returns
string
Implementation of
DBAdapter.name
Methods
close()
close(): Promise<void>
Alpha Experimental
Returns
Promise<void>
Implementation of
DBAdapter.close
dispose()
dispose(): void
Alpha Experimental
Returns
void
Inherited from
BaseObserver.dispose
execute()
execute(query, params?): Promise<QueryResult>
Alpha Experimental
Parameters
| Parameter | Type |
|---|---|
query | string |
params? | any[] |
Returns
Promise<QueryResult>
Implementation of
DBAdapter.execute
executeBatch()
executeBatch(query, params): Promise<QueryResult>
Alpha Experimental
Parameters
| Parameter | Type | Default value |
|---|---|---|
query | string | undefined |
params | any[][] | [] |
Returns
Promise<QueryResult>
Implementation of
DBAdapter.executeBatch
executeRaw()
executeRaw(query, params?): Promise<any[][]>
Alpha Experimental
Parameters
| Parameter | Type |
|---|---|
query | string |
params? | any[] |
Returns
Promise<any[][]>
Implementation of
DBAdapter.executeRaw
get()
get<T>(sql, parameters?): Promise<T>
Alpha
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
sql | string |
parameters? | any[] |
Returns
Promise<T>
Implementation of
DBAdapter.get
getAll()
getAll<T>(sql, parameters?): Promise<T[]>
Alpha
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
sql | string |
parameters? | any[] |
Returns
Promise<T[]>
Implementation of
DBAdapter.getAll
getOptional()
getOptional<T>(sql, parameters?): Promise<null | T>
Alpha
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
sql | string |
parameters? | any[] |
Returns
Promise<null | T>
Implementation of
DBAdapter.getOptional
iterateAsyncListeners()
iterateAsyncListeners(cb): Promise<void>
Alpha Experimental
Parameters
| Parameter | Type |
|---|---|
cb | (listener) => Promise<any> |
Returns
Promise<void>
Inherited from
BaseObserver.iterateAsyncListeners
iterateListeners()
iterateListeners(cb): void
Alpha Experimental
Parameters
| Parameter | Type |
|---|---|
cb | (listener) => any |
Returns
void
Inherited from
BaseObserver.iterateListeners
readLock()
readLock<T>(fn, options?): Promise<T>
Alpha Experimental
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>
Alpha Experimental
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>
Alpha
Returns
Promise<void>
Implementation of
DBAdapter.refreshSchema
registerListener()
registerListener(listener): () => void
Alpha
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>
Alpha Experimental
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>
Alpha Experimental
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
fn | (tx) => Promise<T> |
options? | DBLockOptions |
Returns
Promise<T>
Implementation of
DBAdapter.writeTransaction