An wrapper around PocketBase allowing for easy offline use. Designed for my RSS reader Stratum (iOS, Android).

State Groups

This package uses the broadcast feature of state_groups as an alternative to passing listeners around. These are the events currently used:

• pocketcache/pre-local-update ((String tableName, RecordModel record))
• pocketcache/record-updated-resync ((String tableName, Map<String, dynamic> record))
• pocketcache/local-cache-updated
• pocketcache/network-state-changed (bool canConnect)

Getting started

This package uses sqlite3. It should work on all platforms except for web without additional configuration.

Note that this package reserves the following:

• Column names starting in _offline_bool_ and _offline_json_
• The column name _downloaded
• The tables _offline_queue, _offline_queue_params, and _last_sync_times

In addition it expects all of PocketBases data to have the id, created, and updated fields.

Usage

Init the package:

final String path = (await getApplicationDocumentsDirectory()).path;
pb = PbOfflineCache(PocketBase('http://127.0.0.1:8090/'), path);

Then you can use any of the exposed wrappers.

List<Map<String, dynamic>> data = await pb.getRecords("some_collection", page: 1, page_count: 1);
await pb.deleteRecord("some_collection", id);
await pb.updateRecord("some_collection", id, data);
await pb.createRecord("some_collection", data);
await pb.countRecords("some_collection");

Alternately you can use the NoSQL-like builder syntax which allows you to build your query up. This can be useful for simplifying your querying building logic or making two versions of the same base query.

await pb.collection("test")
    .where("abc", isNotEqualTo: "xyz")
    .where("1", isGreaterThan: 3)
    .where("2", isLessThan: 6)
    .where("abc", isGreaterThanOrEqualTo: 44).get();

Additional information

Be careful about updating columns with uniqueness constraints or adding rows with uniqueness constraints. Database rules are not enforced on the client and these operations may fail when sent to the server.