Isar Database
Quickstart • Documentation • Sample Apps • Support & Ideas • Pub.dev
Isar [ee-zahr]:
- River in Bavaria, Germany.
- Database that will make your life easier.
Features
-
💙 Made for Flutter. Easy to use - zero configuration -
🚀 Highly scalable from hundreds to hundreds of thousands of records -
🔎 Full-text search. Make searching fast and fun -
📱 Multiplatform. iOS, Android, Desktop and the web (soon™) -
🧪 ACID semantics. Rely on consistency -
⏱ Asynchronous. Parallel query operations & multi-isolate support -
💃 Static typing. Compile-time checked and autocompleted queries -
🔒 Strong encryption. Optional authenticated AES-256 GCM encryption
1. Add to pubspec.yaml
dependencies:
isar: 0.4.0
isar_flutter_libs: 0.4.0 # contains the binaries
isar_connect: 0.4.0 # if you want to use the Isar Inspector
dev_dependencies:
isar_generator: 0.4.0
build_runner: any
2. Define a Collection
@Collection()
class Post {
int? id; // auto increment id
@Index(indexType: IndexType.words) // Search index
String title;
Links<Comment> comments; // Link to other collection
}
3. Open an instance
final isar = await openIsar();
Isar Inspector
The Isar Inspector allows you to inspect the Isar instances & collections of your app in real time. You can execute queries, switch between instances and sort the data.
CRUD operations
All basic crud operations are available via the IsarCollection.
final newPost = Post()
..title = 'Amazing new database'
..comments = ['First'];
await isar.writeTxn((isar) {
await isar.posts.put(newPost); // insert
});
final existingPost = await isar.get(newPost.id!); // get
await isar.writeTxn((isar) {
await isar.posts.delete(existingPost.id!); // delete
});
Queries
Isar has a powerful query language that allows you to make use of your indexes, filter distinct objects, use complex and() and or() groups and sort the results.
final isar = await openIsar();
final databasePosts = isar.posts
.where()
.titleWordBeginsWith('DaTAb') // use case insensitive search index
.limit(10)
.findAll()
final postsWithFirstCommentOrTitle = isar.posts
.where()
.filter()
.commentsAnyEqualTo('first', caseSensitive: false)
.or()
.titleEqualTo('first')
.findAll();
Links
You can easily define relationships between objects. In Isar they are called links and backlinks:
@IsarCollection()
class Teacher {
int? id;
String subject;
@Backlink(to: 'teacher')
final students = IsarLinks<Student>();
}
@IsarCollection()
class Student {
int? id;
String name;
final teacher = IsarLink<Teacher>();
}
Watchers
With Isar, 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.
Stream<void> collectionStream = isar.posts.watchLazy;
Stream<List<Post>> queryStream = databasePosts.watch();
queryStream.listen((newResult) {
// do UI updates
})
License
Copyright 2021 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.
65 Oct 31, 2022
14 Nov 4, 2022
16.1k Jan 8, 2023
1 Dec 7, 2021
33 Oct 24, 2022
8 Oct 14, 2022
19 Dec 14, 2022
12 May 2, 2022
39 Oct 1, 2022
0 Nov 9, 2021
4 Nov 9, 2022
3 Jan 21, 2022
380 Dec 14, 2022
61 Dec 29, 2022
6 Sep 19, 2022
36 Nov 12, 2022
12 Jan 8, 2023
14 Nov 4, 2022
10 Nov 11, 2022