Quickstart • Documentation • Sample Apps • Support & Ideas • Pub.dev
- River in Bavaria, Germany.
- Crazy fast NoSQL database that is a joy to use.
If you want to use Isar in production, please use the stable version 3.
- 💙 Made for Flutter. Easy to use, no config, no boilerplate
- 🚀 Highly scalable The sky is the limit (pun intended)
- 🍭 Feature rich. Composite & multi-entry indexes, query modifiers, JSON support etc.
- ⏱ Asynchronous. Parallel query operations & multi-isolate support by default
- 🦄 Open source. Everything is open source and free forever!
Isar database can do much more (and we are just getting started)
- 🕵️ Full-text search. Make searching fast and fun
- 📱 Multiplatform. iOS, Android, Desktop
- 🧪 ACID semantics. Rely on database consistency
- 💃 Static typing. Compile-time checked and autocompleted queries
- ✨ Beautiful documentation. Readable, easy to understand and ever-improving
Join the Telegram group for discussion and sneak peeks of new versions of the DB.
If you want to say thank you, star us on GitHub and like us on pub.dev 🙌💙
Holy smokes you're here! Let's get started on using the coolest Flutter database out there...
dependencies:
isar: 4.0.0
isar_flutter_libs: 4.0.0 # contains Isar Core
dev_dependencies:
build_runner: anypart 'email.g.dart';
@collection
class Email {
Email({
this.id,
this.title,
this.recipients,
this.status = Status.pending,
});
final int id;
@Index(type: IndexType.value)
final String? title;
final List<Recipient>? recipients;
final Status status;
}
@embedded
class Recipient {
String? name;
String? address;
}
enum Status {
draft,
pending,
sent,
}final dir = await getApplicationDocumentsDirectory();
final isar = await Isar.open(
[EmailSchema],
directory: dir.path,
);final emails = isar.emails.where()
.titleContains('awesome', caseSensitive: false)
.sortByStatusDesc()
.limit(10)
.findAll();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.
All basic crud operations are available via the IsarCollection.
final newEmail = Email()..title = 'Amazing new database';
await isar.writeAsync(() {
isar.emails.put(newEmail); // insert & update
});
final existingEmail = isar.emails.get(newEmail.id!); // get
await isar.writeAsync(() {
isar.emails.delete(existingEmail.id!); // delete
});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.
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()With Isar database, you can watch collections, objects, or queries. A watcher is notified after a transaction commits successfully and the target changes. Watchers can be lazy and not reload the data or they can be non-lazy and fetch new results in the background.
Stream<void> collectionStream = isar.emails.watchLazy();
Stream<List<Post>> queryStream = importantEmails.watch();
queryStream.listen((newResult) {
// do UI updates
})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 yourself.
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.
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 |
 Oscar Palomar |
 Peyman |
 Simon Choi |
 Ura |
 blendthink |
 mnkeis |
 nobkd |
Copyright 2023 Simon Choi
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.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent