WASQLiteDBAdapter
Adapter for WA-SQLite SQLite connections.
Extends
LockedAsyncDatabaseAdapter
Constructors
new WASQLiteDBAdapter()
new WASQLiteDBAdapter(options): WASQLiteDBAdapter
Parameters
| Parameter | Type |
|---|---|
options | WASQLiteDBAdapterOptions |
Returns
Overrides
LockedAsyncDatabaseAdapter.constructor
Accessors
name
Get Signature
get name(): string
Returns
string
Inherited from
LockedAsyncDatabaseAdapter.name
Methods
close()
close(): void
Attempts to close the connection. Shared workers might not actually close the connection if other tabs are still using it.
Returns
void
Inherited from
LockedAsyncDatabaseAdapter.close
execute()
execute(query, params?): Promise<QueryResult>
Parameters
| Parameter | Type |
|---|---|
query | string |
params? | any[] |
Returns
Promise<QueryResult>
Inherited from
LockedAsyncDatabaseAdapter.execute
executeBatch()
executeBatch(query, params?): Promise<QueryResult>
Parameters
| Parameter | Type |
|---|---|
query | string |
params? | any[][] |
Returns
Promise<QueryResult>
Inherited from
LockedAsyncDatabaseAdapter.executeBatch
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
LockedAsyncDatabaseAdapter.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
LockedAsyncDatabaseAdapter.getAll
getConfiguration()
getConfiguration(): ResolvedWebSQLOpenOptions
Get the config options used to open this connection. This is useful for sharing connections.
Returns
Inherited from
LockedAsyncDatabaseAdapter.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
LockedAsyncDatabaseAdapter.getOptional
init()
init(): Promise<void>
Init is automatic, this helps catch errors or explicitly await initialization
Returns
Promise<void>
Inherited from
LockedAsyncDatabaseAdapter.init
iterateAsyncListeners()
iterateAsyncListeners(cb): Promise<void>
Parameters
| Parameter | Type |
|---|---|
cb | (listener) => Promise<any> |
Returns
Promise<void>
Inherited from
LockedAsyncDatabaseAdapter.iterateAsyncListeners
iterateListeners()
iterateListeners(cb): void
Parameters
| Parameter | Type |
|---|---|
cb | (listener) => any |
Returns
void
Inherited from
LockedAsyncDatabaseAdapter.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
LockedAsyncDatabaseAdapter.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
LockedAsyncDatabaseAdapter.readTransaction
refreshSchema()
refreshSchema(): Promise<void>
This is currently a no-op on web
Returns
Promise<void>
Inherited from
LockedAsyncDatabaseAdapter.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
LockedAsyncDatabaseAdapter.registerListener
shareConnection()
shareConnection(): Promise<SharedConnectionWorker>
Get a MessagePort which can be used to share the internals of this connection.
Returns
Promise<SharedConnectionWorker>
Inherited from
LockedAsyncDatabaseAdapter.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
LockedAsyncDatabaseAdapter.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
LockedAsyncDatabaseAdapter.writeTransaction