cindel 0.5.0

Ultra-fast, lightweight NoSQL local database for Flutter and Dart apps, powered by a compact Rust native core.

cindel

Ultra-fast, lightweight NoSQL local database API for Flutter and Dart apps. Cindel provides typed collections, generated schemas, indexed queries, transactions, watchers, and a compact Rust native runtime behind Dart FFI.

Usage

dependencies:
  cindel: ^0.5.0
  cindel_flutter_libs: ^0.5.0

dev_dependencies:
  build_runner: ^2.15.0
  cindel_generator: ^0.5.0

Define a collection:

import 'package:cindel/cindel.dart';

part 'user.g.dart';

@Collection(name: 'users')
class User {
  Id id = autoIncrement;

  @Index(unique: true)
  late String email;

  late String name;
}

Generate code:

dart run build_runner build --delete-conflicting-outputs

Open a database:

final db = await Cindel.open(
  directory: directory.path,
  schemas: [UserSchema],
);

For tests and short-lived work:

final db = await Cindel.openInMemory(schemas: [UserSchema]);

MDBX is the default storage backend. SQLite remains available when a caller needs the older storage layout explicitly:

final db = await Cindel.open(
  directory: directory.path,
  schemas: [UserSchema],
  backend: CindelStorageBackend.sqlite,
);

Existing SQLite database directories are not migrated automatically by the default switch. Open them with backend: CindelStorageBackend.sqlite until an explicit migration helper exists in a later release.

Features

• Typed collection CRUD and bulk writes.
• Native auto-increment IDs.
• Indexed equality, range, prefix, hash, case-insensitive, unique, word token, composite, and primitive list membership queries.
• Filter builders, sorting, pagination, distinct, primitive projections, and property aggregates.
• Explicit read and write transactions.
• Document, collection, object, query, and lazy watchers.
• Native local watcher change sets with polling fallback for external handles.
• Embedded objects and embedded object lists.
• Schema versions and compatible additive schema updates.

Supported Platforms

The current release ships prebuilt native binaries for Android, Windows, and Linux through cindel_flutter_libs.

iOS and macOS support are planned, but they are not advertised as available until their native binaries are generated and validated.

Release Status

Cindel is still pre-1.0.0. The 0.5.0 package line ships MDBX as the default backend, SQLite as an explicit compatibility backend, and optimized typed MDBX paths for bulk writes, get/getAll, native query plans, filters, partial updates, deletes, projections, watcher change sets, and aggregate scalars. The default native runtime no longer depends on serde_json.