discontinuedPackage electricsql has been discontinued.

ElectricClient<DB extends GeneratedDatabase> class abstract interface

Implemented types

• BaseElectricClient

Implementers

• DriftElectricClient

Properties

adapter → DatabaseAdapter

no setter, inherited

db → DB

no setter

dbDescription → DBSchema

no setter, inherited

dbName → String

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isConnected → bool

no setter, inherited

notifier → Notifier

no setter, inherited

registry → Registry

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

satellite → Satellite

no setter, inherited

syncManager → SyncManager

no setter

Methods

clearTableReplicationTransform<TableDsl extends Table, D>(TableInfo<TableDsl, D> table) → void

Clears any replication transforms set using setReplicationTransform

close() → Future<void>

inherited

connect([String? token]) → Future<void>

inherited

disconnect() → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

potentiallyChanged() → void

inherited

setIsConnected(ConnectivityState connectivityState) → void

inherited

setTableReplicationTransform<TableDsl extends Table, D>(TableInfo<TableDsl, D> table, {required Insertable<D> transformInbound(D row), required Insertable<D> transformOutbound(D row), Insertable<D> toInsertable(D)?}) → void

Puts transforms in place such that any data being replicated to or from this table is first handled appropriately while retaining type consistency.

syncTable<T extends Table>(T table, {SyncIncludeBuilder<T>? include, SyncWhereBuilder<T>? where, String? key}) → Future<ShapeSubscription>

Creates a Shape subscription. A shape is a set of related data that's synced onto the local device. https://electric-sql.com/docs/usage/data-access/shapes

syncTableRaw(SyncInputRaw syncInput) → Future<ShapeSubscription>

Same as syncTable but you would be providing table names, and foreign key relationships manually. This is more low-level and should be avoided if possible.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited