WASQLiteDBAdapter
Adapter for WA-SQLite SQLite connections.
Extends
InternalWASQLiteDBAdapter
Constructors
new WASQLiteDBAdapter()
new WASQLiteDBAdapter(options): WASQLiteDBAdapter
Parameters
| Parameter | Type |
|---|---|
options | WASQLiteDBAdapterOptions |
Returns
Overrides
InternalWASQLiteDBAdapter.constructor
Properties
| Property | Type | Inherited from |
|---|---|---|
closed | boolean | InternalWASQLiteDBAdapter.closed |
closing | boolean | InternalWASQLiteDBAdapter.closing |
Accessors
name
Get Signature
get name(): string
Returns
string
Inherited from
InternalWASQLiteDBAdapter.name
Methods
close()
close(): Promise<void>
Attempts to close the connection. Shared workers might not actually close the connection if other tabs are still using it.
Returns
Promise<void>
Inherited from
InternalWASQLiteDBAdapter.close
dispose()
dispose(): void
Returns
void
Inherited from
InternalWASQLiteDBAdapter.dispose
execute()
execute(query, params?): Promise<QueryResult>
Parameters
| Parameter | Type |
|---|---|
query | string |
params? | any[] |
Returns
Promise<QueryResult>
Inherited from
InternalWASQLiteDBAdapter.execute
executeBatch()
executeBatch(query, params?): Promise<QueryResult>
Parameters
| Parameter | Type |
|---|---|
query | string |
params? | any[][] |
Returns
Promise<QueryResult>
Inherited from
InternalWASQLiteDBAdapter.executeBatch
executeRaw()
executeRaw(query, params?): Promise<any[][]>
Parameters
| Parameter | Type |
|---|---|
query | string |
params? | any[] |
Returns
Promise<any[][]>
Inherited from
InternalWASQLiteDBAdapter.executeRaw
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>
Inherited from
InternalWASQLiteDBAdapter.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[]>
Inherited from
InternalWASQLiteDBAdapter.getAll
getConfiguration()
getConfiguration(): WebDBAdapterConfiguration
Returns
WebDBAdapterConfiguration
Inherited from
InternalWASQLiteDBAdapter.getConfiguration
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>
Inherited from
InternalWASQLiteDBAdapter.getOptional
init()
init(): Promise<void>
Init is automatic, this helps catch errors or explicitly await initialization
Returns
Promise<void>
Inherited from
InternalWASQLiteDBAdapter.init
iterateAsyncListeners()
iterateAsyncListeners(cb): Promise<void>
Parameters
| Parameter | Type |
|---|---|
cb | (listener) => Promise<any> |
Returns
Promise<void>
Inherited from
InternalWASQLiteDBAdapter.iterateAsyncListeners
iterateListeners()
iterateListeners(cb): void
Parameters
| Parameter | Type |
|---|---|
cb | (listener) => any |
Returns
void
Inherited from
InternalWASQLiteDBAdapter.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>
Inherited from
InternalWASQLiteDBAdapter.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>
Inherited from
InternalWASQLiteDBAdapter.readTransaction
refreshSchema()
refreshSchema(): Promise<void>
This is currently a no-op on web
Returns
Promise<void>
Inherited from
InternalWASQLiteDBAdapter.refreshSchema
registerListener()
registerListener(listener): () => void
Register a listener for updates to the PowerSync client.
Parameters
| Parameter | Type |
|---|---|
listener | Partial<LockedAsyncDatabaseAdapterListener> |
Returns
Function
Returns
void
Inherited from
InternalWASQLiteDBAdapter.registerListener
reOpenInternalDB()
reOpenInternalDB(): Promise<void>
Re-opens the underlying database. Returns a pending operation if one is already in progress.
Returns
Promise<void>
Inherited from
InternalWASQLiteDBAdapter.reOpenInternalDB
shareConnection()
shareConnection(): Promise<SharedConnectionWorker>
Get a MessagePort which can be used to share the internals of this connection.
Returns
Promise<SharedConnectionWorker>
Inherited from
InternalWASQLiteDBAdapter.shareConnection
writeLock()
writeLock<T>(fn, options?): Promise<T>
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
fn | (tx) => Promise<T> |
options? | DBLockOptions |
Returns
Promise<T>
Inherited from
InternalWASQLiteDBAdapter.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>
Inherited from
InternalWASQLiteDBAdapter.writeTransaction