Isar Database

Quickstart • Documentation • Sample Apps • Support & Ideas • Pub.dev

? recipients; @enumerated Status status = Status.pending; } @embedded class Recipient { String? name; String? address; } enum Status { draft, pending, sent, } ``` ### 3. Open a database instance ```dart final dir = await getApplicationDocumentsDirectory(); final isar = await Isar.open( [EmailSchema], directory: dir.path, ); ``` ### 4. Query the database ```dart final emails = await isar.emails.filter() .titleContains('awesome', caseSensitive: false) .sortByStatusDesc() .limit(10) .findAll(); ``` ## Isar Database Inspector The Isar Inspector allows you to inspect the Isar instances & collections of your app in real-time. You can execute queries, edit properties, switch between instances and sort the data. To launch the inspector, just run your Isar app in debug mode and open the Inspector link in the logs. ## CRUD operations All basic crud operations are available via the `IsarCollection`. ```dart final newEmail = Email()..title = 'Amazing new database'; await isar.writeTxn(() { await isar.emails.put(newEmail); // insert & update }); final existingEmail = await isar.emails.get(newEmail.id!); // get await isar.writeTxn(() { await isar.emails.delete(existingEmail.id!); // delete }); ``` ## Database Queries Isar database has a powerful query language that allows you to make use of your indexes, filter distinct objects, use complex `and()`, `or()` and `.xor()` groups, query links and sort the results. ```dart final importantEmails = isar.emails .where() .titleStartsWith('Important') // use index .limit(10) .findAll() final specificEmails = isar.emails .filter() .recipient((q) => q.nameEqualTo('David')) // query embedded objects .or() .titleMatches('*university*', caseSensitive: false) // title containing 'university' (case insensitive) .findAll() ``` ## Database Watchers With Isar database, you can watch collections, objects, or queries. A watcher is notified after a transaction commits successfully and the target actually changes. Watchers can be lazy and not reload the data or they can be non-lazy and fetch new results in the background. ```dart Stream collectionStream = isar.emails.watchLazy(); Stream> queryStream = importantEmails.watch(); queryStream.listen((newResult) { // do UI updates }) ``` ## Benchmarks Benchmarks only give a rough idea of the performance of a database but as you can see, Isar NoSQL database is quite fast 😇 | | | | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | | | | If you are interested in more benchmarks or want to check how Isar performs on your device you can run the [benchmarks](https://github.com/isar/isar_benchmark) yourself. ## Unit tests If you want to use Isar database in unit tests or Dart code, call `await Isar.initializeIsarCore(download: true)` before using Isar in your tests. Isar NoSQL database will automatically download the correct binary for your platform. You can also pass a `libraries` map to adjust the download location for each platform. Make sure to use `flutter test -j 1` to avoid tests running in parallel. This would break the automatic download. ## Contributors ✨ Big thanks go to these wonderful people:

Alexis	Burak	Carlo Loguercio	Frostedfox	Hafeez Rana	Hamed H.	JT
Jack Rivers	Joachim Nohl	Johnson	LaLucid	Lety	Michael	Moseco
Nelson Mutane	Peyman	Simon Leier	Ura	blendthink	mnkeis	nobkd

### License ``` Copyright 2022 Simon Leier Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ```