Sign in Help sembast 3.1.1 Published Sep 13, 2021• tekartik.comNull safety DARTNATIVEJSFLUTTERANDROIDIOSLINUXMACOSWEBWINDOWS 573 Readme Changelog Example Installing Versions Scores sembast.dart sembast db stands for Simple Embedded Application Store database General Yet another NoSQL persistent store database solution for single process io applications. The whole document based database resides in a single file and is loaded in memory when opened. Changes are appended right away to the file and the file is automatically compacted when needed. Works on Dart VM and Flutter (no plugin needed, 100% Dart so works on all platforms - MacOS/Android/iOS/Linux/Windows). Inspired from IndexedDB, DataStore, WebSql, NeDB, Lawndart... Supports encryption using user-defined codec. Pure dart single file IO VM/Flutter storage supported. Web support (including Flutter Web) through sembast_web. Can work on top of sqflite through sembast_sqflite. Usage example: notepad_sembast: Simple flutter notepad working on all platforms (web/mobile/mac) (online demo) Follow the guide. Usage Opening a database A database is a single file represented by a path in the file system // File path to a file in the current directory String dbPath = 'sample.db'; DatabaseFactory dbFactory = databaseFactoryIo; // We use the database factory to open the database Database db = await dbFactory.openDatabase(dbPath); The db object is ready for use. More information here. Reading and writing records Simple example of writing and reading records // dynamically typed store var store = StoreRef.main(); // Easy to put/get simple values or map // A key can be of type int or String and the value can be anything as long as it can // be properly JSON encoded/decoded await store.record('title').put(db, 'Simple application'); await store.record('version').put(db, 10); await store.record('settings').put(db, {'offline': true}); // read values var title = await store.record('title').get(db) as String; var version = await store.record('version').get(db) as int; var settings = await store.record('settings').get(db) as Map; // ...and delete await store.record('version').delete(db); Store The store has some similarities with IndexedDB store and DataStore entities. The database always has a main store for easy access (like in the example aboves or typically to save singletons) and allows for an infinite number of stores where a developer would store entity specific data (such as a list of records of the same 'type') // Use the animals store using Map records with int keys var store = intMapStoreFactory.store('animals'); // Store some objects await db.transaction((txn) async { await store.add(txn, {'name': 'fish'}); await store.add(txn, {'name': 'cat'}); // You can specify a key await store.record(10).put(txn, {'name': 'dog'}); }); The API takes advantage of Dart strong mode to make database access less error prone. // Use the main store for storing key values as String var store = StoreRef<String, String>.main(); // Writing the data await store.record('username').put(db, 'my_username'); await store.record('url').put(db, 'my_url'); // Reading the data var url = await store.record('url').get(db); var username = await store.record('username').get(db); More info on the store API here When record values are of type Map, record fields can be referenced using a dot (.) unless escaped. var store = intMapStoreFactory.store(); var key = await store.add(db, {'path': {'sub': 'my_value'}, 'with.dots': 'my_other_value'}); var record = await store.record(key).getSnapshot(db); var value = record['path.sub']; // value = 'my_value' var value2 = record[FieldKey.escape('with.dots')]; // value2 = 'my_other_value' Follow the links for more information on how to write or read data Auto increment If no key is provided, the object is inserted with an auto-increment value var store = StoreRef<int, String>.main(); // Auto incrementation is built-in var key1 = await store.add(db, 'value1'); var key2 = await store.add(db, 'value2'); // key1 = 1, key2 = 2... Transaction Actions can be grouped into transactions for consistency and optimization (single write on the file system). If an error is thrown, the transaction is cancelled and the changes reverted. To prevent deadlock, never use an existing Database or Store object. await db.transaction((txn) async { await store.add(txn, 'value1'); await store.add(txn, 'value2'); }); More info on transaction here Simple find mechanism Filtering and sorting can be done on any field More information here. // Use the animals store using Map records with int keys var store = intMapStoreFactory.store('animals'); // Store some objects await db.transaction((txn) async { await store.add(txn, {'name': 'fish'}); await store.add(txn, {'name': 'cat'}); await store.add(txn, {'name': 'dog'}); }); // Look for any animal "greater than" (alphabetically) 'cat' // ordered by name var finder = Finder( filter: Filter.greaterThan('name', 'cat'), sortOrders: [SortOrder('name')]); var records = await store.find(db, finder: finder); expect(records.length, 2); expect(records[0]['name'], 'dog'); expect(records[1]['name'], 'fish'); Listen to changes Similarly to firestore, you can asynchronously listen to record, store or query changes. More information here Triggers For data integrity, you can also track changes during transaction and perform additional operations in the same transaction More information here Codec and encryption Sembast supports using a user-defined codec to encode/decode data when read/written to disk. It provides a way to support encryption. Encryption itself is not part of sembast but an example of a simple encryption codec is provided in the test folder. // Initialize the encryption codec with a user password var codec = getEncryptSembastCodec(password: '[your_user_password]'); // Open the database with the codec Database db = await factory.openDatabase(dbPath, codec: codec); // ...your database is ready to use More information here. Information Storage format Data is stored in a text file where each line is (json format) either: meta information of the database (first line) record data Each data written is appended lazily to the file for best performance. Compact might happen at any moment to prevent record duplication. The whole compact information is done in a new file followed by a rename to make it atomic. More information here. Supported types Supported types depends on JSON supported types. More information here Keys Supported key types are: int (default with autoincrement when no key are passed) String (String keys can also be generated à la firestore) Values Supported value types are: String num (int and double) Map (Map<String, Object?>) List (List<Object?>) bool null (value) Blob (custom type) Timestamp (custom type) Resources Third party examples and tutorials available are listed here. Issue Troubleshooting. Build status Travis: 573 LIKES 130 PUB POINTS 97% POPULARITY Publisher tekartik.com Metadata NoSQL persistent embedded file system document-based database for Dart VM and Flutter with encryption support. Homepage Repository (GitHub) View/report issues Documentation API reference License BSD-3-Clause (LICENSE) Dependencies meta, path, synchronized More Packages that depend on sembast Dart languagePolicyTermsAPI TermsSecurityPrivacyHelp