hive_ce 2.23.3

hive_ce: ^2.23.3 copied to clipboard

Fast, Enjoyable & Secure NoSQL Database

Hive is a lightweight and blazing fast key-value database written in pure Dart. Inspired by Bitcask.

Documentation & Samples 📖 #

Features #

• 🚀 Cross platform: mobile, desktop, browser
• ⚡ Great performance (see benchmarks)
• ❤️ Simple, powerful, & intuitive API
• 🔒 Strong encryption built in
• 🎈 NO native dependencies
• 🔋 Batteries included

New features in Hive CE #

Hive CE is a spiritual continuation of Hive v2 with the following new features:

• Tooling
  • Hive CE Inspector DevTools extension to browse and search the contents of your boxes
• Platforms
  • Isolate support through IsolatedHive
  • Flutter web WASM support
• Code generation
  • Generate adapters with the GenerateAdapters annotation instead of annotating every type and field
  • Generate adapters for classes outside the current package
  • Register every generated adapter in one call with the HiveRegistrar extension
  • Support for Freezed, constructor parameter defaults, and named imports
• Types
  • Built-in support for Set and Duration
  • DateTime and Duration keep microsecond precision
  • Type IDs up to 65439 instead of 223
• Performance
  • Faster batch writes and opening of large boxes, including encrypted boxes
  • Lazy boxes open several times faster
  • IsolatedHive individual writes are faster than Hive CE
  • See the benchmarks

Getting Started #

Hive CE requires Dart 3. Ensure that you have the following in your pubspec.yaml file:

environment:
  sdk: ^3.0.0

Usage #

You can use Hive just like a map. Writes are readable immediately, but a write can be lost if the process is killed before its future completes. On the VM, flush() waits for pending writes and flushes them to disk.

import 'package:hive_ce/hive_ce.dart';

void example() {
  final box = Hive.box('myBox');
  box.put('name', 'David');
  final name = box.get('name');
  print('Name: $name');
}

Benchmarks #

Run on an M3 Max MacBook Pro with values of a class with ten int fields. See the benchmark code.

Speed #

Times are averaged over several runs. Runs that took longer than 1 minute were stopped.

Individual writes

Writing values one at a time, then flushing once. Hive v4, sqflite, drift, and ObjectBox commit every write.

Batch writes

Writing every value with a single addAll, then flushing.

Opening and reading

Opening a database and reading every value.

Queries

Finding the tenth of the values within a range of an integer field, right after opening. sqflite, drift, and ObjectBox index the field. Hive has no query API, so Hive boxes filter their values in Dart, and Hive v4 reads them from disk first.

Encrypted and lazy boxes

Hive v2 → Hive CE. Lazy boxes only load keys when opened.

Database size #

Hive v4 sizes grow with the length of model field names. sqflite, drift, and ObjectBox sizes include the query index.

Memory usage #

Peak memory with 1,000,000 values, including native memory, averaged over three runs. Regular Hive boxes keep every value in memory while open. Lazy boxes keep only keys and read values with getAt.