RxDBAdapterSqlite

Defined in: packages/rxdb-adapter-wa-sqlite/src/RxDBAdapterSqlite.ts:6

Backend-agnostic base class for SQLite adapters.

Subclasses provide createClient() and adapterName.

Extends

• RxDBAdapterSqliteBase

Constructors

Constructor

new RxDBAdapterSqlite(rxdb, options): RxDBAdapterWaSqlite;

Defined in: packages/rxdb-adapter-wa-sqlite/src/RxDBAdapterSqlite.ts:10

Parameters

Parameter	Type
rxdb	RxDB
options	SqliteOptions

Returns

RxDBAdapterWaSqlite

Overrides

RxDBAdapterSqliteBase.constructor

Properties

name

readonly name: string = ADAPTER_NAME;

Defined in: packages/rxdb-adapter-wa-sqlite/src/RxDBAdapterSqlite.ts:8

Overrides

RxDBAdapterSqliteBase.name

---

options

readonly options: SqliteOptions;

Defined in: packages/rxdb-adapter-wa-sqlite/src/RxDBAdapterSqlite.ts:12

Accessors

encryption

Get Signature

get encryption(): AdapterEncryptionFacade;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:52

Returns

AdapterEncryptionFacade

Inherited from

RxDBAdapterSqliteBase.encryption

---

encryptionContext

Get Signature

get encryptionContext(): EncryptionContext;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:51

Returns

EncryptionContext

Inherited from

RxDBAdapterSqliteBase.encryptionContext

Methods

cacheRowIdEntity()

cacheRowIdEntity(rowId, entity): void;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:65

Parameters

Parameter	Type
rowId	bigint
entity	any

Returns

void

Inherited from

RxDBAdapterSqliteBase.cacheRowIdEntity

---

cleanAllCache()

cleanAllCache(): void;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:69

Returns

void

Inherited from

RxDBAdapterSqliteBase.cleanAllCache

---

connect()

connect(): Promise<IRxDBAdapter>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:55

Returns

Promise<IRxDBAdapter>

Inherited from

RxDBAdapterSqliteBase.connect

---

createClient()

protected createClient(): Promise<SqliteClientLike>;

Defined in: packages/rxdb-adapter-wa-sqlite/src/RxDBAdapterSqlite.ts:18

Create or obtain the SQLite client. Concrete adapters implement this with their backend-specific logic.

Returns

Promise<SqliteClientLike>

Overrides

RxDBAdapterSqliteBase.createClient

---

createTables()

createTables<T>(EntityTypes, entities?): Promise<boolean>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:62

Type Parameters

Type Parameter
T extends EntityType

Parameters

Parameter	Type
EntityTypes	T[]
entities?	InstanceType<T>[]

Returns

Promise<boolean>

Inherited from

RxDBAdapterSqliteBase.createTables

---

deleteByIds()

deleteByIds(entityName, ids): Observable<void>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:84

Parameters

Parameter	Type
entityName	string
ids	string[]

Returns

Observable<void>

Inherited from

RxDBAdapterSqliteBase.deleteByIds

---

disconnect()

disconnect(): Promise<void>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:56

Returns

Promise<void>

Inherited from

RxDBAdapterSqliteBase.disconnect

---

getEntityByRowId()

getEntityByRowId(rowId, EntityType): any;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:67

Parameters

Parameter	Type
rowId	bigint
EntityType	EntityType

Returns

any

Inherited from

RxDBAdapterSqliteBase.getEntityByRowId

---

getMetadataByIds()

getMetadataByIds(entityName, ids): Observable<Map<string, string>>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:82

Parameters

Parameter	Type
entityName	string
ids	string[]

Returns

Observable<Map<string, string>>

Inherited from

RxDBAdapterSqliteBase.getMetadataByIds

---

getRepository()

getRepository<T, RT>(EntityType): RT;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:54

Type Parameters

Type Parameter	Default type
T extends EntityType	-
RT	SqliteRepository<T>

Parameters

Parameter	Type
EntityType	T

Returns

RT

Inherited from

RxDBAdapterSqliteBase.getRepository

---

getRowIdByEntity()

getRowIdByEntity(entity): bigint | undefined;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:68

Parameters

Parameter	Type
entity	any

Returns

bigint | undefined

Inherited from

RxDBAdapterSqliteBase.getRowIdByEntity

---

getRxDBChangeSequence()

getRxDBChangeSequence(): Promise<number>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:80

Returns

Promise<number>

Inherited from

RxDBAdapterSqliteBase.getRxDBChangeSequence

---

internalQuery()

internalQuery(sql, bindings?): Promise<SqliteSuccessResult>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:78

Parameters

Parameter	Type
sql	string
bindings?	SQLiteCompatibleType[]

Returns

Promise<SqliteSuccessResult>

Inherited from

RxDBAdapterSqliteBase.internalQuery

---

isTableExisted()

isTableExisted<T>(EntityType): Promise<boolean>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:61

Type Parameters

Type Parameter
T extends EntityType

Parameters

Parameter	Type
EntityType	T

Returns

Promise<boolean>

Inherited from

RxDBAdapterSqliteBase.isTableExisted

---

localRxDBBranch()

localRxDBBranch(): SqliteRepository<any>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:77

Returns

SqliteRepository<any>

Inherited from

RxDBAdapterSqliteBase.localRxDBBranch

---

localRxDBChange()

localRxDBChange(): SqliteTreeRepository<any>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:79

Returns

SqliteTreeRepository<any>

Inherited from

RxDBAdapterSqliteBase.localRxDBChange

---

mergeChanges()

mergeChanges(
   actions, 
   localChanges?, 
   disableTriggers?): Promise<void>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:64

Parameters

Parameter	Type
actions	SwitchVersionActions
localChanges?	Omit<RxDBChange, "id">[]
disableTriggers?	boolean

Returns

Promise<void>

Inherited from

RxDBAdapterSqliteBase.mergeChanges

---

mutations()

mutations(options): Promise<any[]>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:60

Parameters

Parameter	Type
options	RxDBMutationsMap<any>

Returns

Promise<any[]>

Inherited from

RxDBAdapterSqliteBase.mutations

---

query()

query(sql, bindings?): Promise<SqliteSuccessResult>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:70

Parameters

Parameter	Type
sql	string
bindings?	SQLiteCompatibleType[]

Returns

Promise<SqliteSuccessResult>

Inherited from

RxDBAdapterSqliteBase.query

---

rawQuery()

rawQuery(sql, params?): Promise<{
  columns: string[];
  rows: SQLiteCompatibleType[][];
  rowsAffected: number;
}>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:71

Parameters

Parameter	Type
sql	string
params?	unknown[]

Returns

Promise<{ columns: string[]; rows: SQLiteCompatibleType[][]; rowsAffected: number; }>

Inherited from

RxDBAdapterSqliteBase.rawQuery

---

removeCacheEntity()

removeCacheEntity(entity): void;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:66

Parameters

Parameter	Type
entity	any

Returns

void

Inherited from

RxDBAdapterSqliteBase.removeCacheEntity

---

removeMany()

removeMany<T>(entities): Promise<InstanceType<T>[]>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:59

Type Parameters

Type Parameter
T extends EntityType

Parameters

Parameter	Type
entities	InstanceType<T>[]

Returns

Promise<InstanceType<T>[]>

Inherited from

RxDBAdapterSqliteBase.removeMany

---

saveMany()

saveMany<T>(entities): Promise<InstanceType<T>[]>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:58

Type Parameters

Type Parameter
T extends EntityType

Parameters

Parameter	Type
entities	InstanceType<T>[]

Returns

Promise<InstanceType<T>[]>

Inherited from

RxDBAdapterSqliteBase.saveMany

---

setRxDBChangeSequence()

setRxDBChangeSequence(sequence): Promise<void>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:81

Parameters

Parameter	Type
sequence	number

Returns

Promise<void>

Inherited from

RxDBAdapterSqliteBase.setRxDBChangeSequence

---

switchBranch()

switchBranch(options): Promise<void>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:63

Parameters

Parameter	Type
options	SwitchBranchOptions

Returns

Promise<void>

Inherited from

RxDBAdapterSqliteBase.switchBranch

---

transaction()

transaction<T>(transactionFun, transactionLog?): Promise<Awaited<ReturnType<T>>>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:76

Type Parameters

Type Parameter
T extends TransactionFun

Parameters

Parameter	Type
transactionFun	T
transactionLog?	boolean

Returns

Promise<Awaited<ReturnType<T>>>

Inherited from

RxDBAdapterSqliteBase.transaction

---

upsertMany()

upsertMany<T>(entityName, data): Observable<void>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:83

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
entityName	string
data	T[]

Returns

Observable<void>

Inherited from

RxDBAdapterSqliteBase.upsertMany

---

version()

version(): Promise<string>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/RxDBAdapterSqliteBase.d.ts:57

Returns

Promise<string>

Inherited from

RxDBAdapterSqliteBase.version