Isar Datenbank

Schnellstart

Holla, die Waldfee! Du bist bestimmt hier um mit der coolsten Flutter-Datenbank zu starten...

Dieser Schnellstart wird wenig um den heißen Brei herumreden und direkt mit dem Coden beginnen.

1. Abhängigkeiten hinzufügen

Bevor es losgeht, müssen wir ein paar Pakete zur pubspec.yaml hinzufügen. Damit es schneller geht lassen wir pub das für uns erledigen.

dart pub add isar:^3.1.8 isar_flutter_libs:^3.1.8 --hosted-url=https://pub.isar-community.dev
dart pub add dev:isar_generator:^3.1.8 --hosted-url=https://pub.isar-community.dev

2. Klassen annotieren

Annotiere deine Collection-Klassen mit @collection und wähle ein Id-Feld.

part 'user.g.dart';

@collection
class User {
  Id id = Isar.autoIncrement; // Für auto-increment kannst du auch id = null zuweisen 

  String? name;

  int? age;
}

IDs identifizieren Objekte in einer Collection eindeutig und erlauben es dir, sie später wiederzufinden.

3. Code-Generator ausführen

Führe den folgenden Befehl aus, um den build_runner zu starten:

dart run build_runner build

Wenn du Flutter verwendest:

flutter pub run build_runner build

4. Isar-Instanz öffnen

Öffne eine neue Isar-Instanz und übergebe alle Collection-Schemata. Optional kannst du einen Instanznamen und ein Verzeichnis angeben.

final dir = await getApplicationDocumentsDirectory();
final isar = await Isar.open(
  [UserSchema],
  directory: dir.path,
);

5. Schreiben und lesen

Wenn deine Instanz geöffnet ist, hast du Zugriff auf die Collections.

Alle grundlegenden CRUD-Operationen sind über die IsarCollection verfügbar .

final newUser = User()..name = 'Jane Doe'..age = 36;

await isar.writeTxn(() async {
  await isar.users.put(newUser); // Einfügen & akualisieren
});

final existingUser = await isar.users.get(newUser.id); // Erhalten

await isar.writeTxn(() async {
  await isar.users.delete(existingUser.id!); // Löschen
});

Weitere Ressourcen

Du lernst am besten visuell? Schau dir diese Videos an, um mit Isar zu starten: