DS-EasyDB Hive #

Hive storage implementation for DS-EasyDB (https://github.com/Dragon-InterActive/ds_easy_db). Provides fast, local key-value storage for Flutter applications.

Features #

• Fast Performance: Hive is optimized for mobile devices
• Type-Safe: Strongly typed operations
• Zero Native Dependencies: Pure Dart implementation
• Offline-First: Perfect for local data storage
• Automatic Box Management: Handles box opening/closing automatically

Installation #

Add to your pubspec.yaml:

dependencies:
  ds_easy_db: ^1.0.0
  ds_easy_db_hive: ^1.0.0

Usage #

Basic Setup #

import 'package:ds_easy_db/ds_easy_db.dart';
import 'package:ds_easy_db_hive/ds_easy_db_hive.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  db.configure(
    prefs: HiveDatabase(),
    // ... other configurations
  );
  
  await db.init();
  
  runApp(MyApp());
}

Configuration File #

In your ds_easy_db_config.dart:

import 'package:ds_easy_db/ds_easy_db.dart';
import 'package:ds_easy_db_hive/ds_easy_db_hive.dart';

class DS-EasyDBConfig {
  static DatabaseRepository get prefs => HiveDatabase();
  // ... other configurations
}

Examples #

Store User Preferences #

// Save theme preference
await db.prefs.set('settings', 'theme', {
  'mode': 'dark',
  'primaryColor': '#FF5722',
});

// Read preference
final theme = await db.prefs.get('settings', 'theme');
print(theme?['mode']); // dark

// Update preference
await db.prefs.update('settings', 'theme', {
  'mode': 'light',
});

Store App State #

// Save app state
await db.prefs.set('state', 'current', {
  'lastPage': '/home',
  'isLoggedIn': true,
  'timestamp': DatabaseRepository.serverTS, // Uses DateTime.now()
});

// Check if exists
if (await db.prefs.exists('state', 'current')) {
  final state = await db.prefs.get('state', 'current');
  print('Last page: ${state?['lastPage']}');
}

Query Data #

// Store multiple items
await db.prefs.set('tasks', 'task1', {'title': 'Buy milk', 'done': false});
await db.prefs.set('tasks', 'task2', {'title': 'Call John', 'done': true});
await db.prefs.set('tasks', 'task3', {'title': 'Read book', 'done': false});

// Query incomplete tasks
final incomplete = await db.prefs.query('tasks', 
  where: {'done': false}
);
print('Incomplete tasks: ${incomplete.length}'); // 2

// Get all tasks
final allTasks = await db.prefs.getAll('tasks');
print('Total tasks: ${allTasks?.length}'); // 3

Delete Data #

// Delete single item
await db.prefs.delete('settings', 'theme');

// Check existence before delete
if (await db.prefs.exists('settings', 'theme')) {
  await db.prefs.delete('settings', 'theme');
}

Notes #

• No Encryption: Hive data is not encrypted by default. Use ds_easy_db_secure_storage for sensitive data.
• Box Management: Boxes are automatically opened when needed and remain open for the app lifetime.
• Data Persistence: All data is stored locally on the device.
• Performance: Hive is very fast for reads and writes, suitable for preferences and app state.

When to Use #

Use ds_easy_db_hive for:

• ✅ User preferences and settings
• ✅ App configuration
• ✅ Cached data
• ✅ Offline-first applications
• ✅ Fast local storage needs

Don't use it for:

• ❌ Sensitive data (use ds_easy_db_secure_storage instead)
• ❌ Large datasets (consider SQLite)
• ❌ Real-time sync (use ds_easy_db_firebase_realtime)
• ❌ Complex queries (consider SQLite or Firestore)

Hive Community Edition #

This package uses Hive CE (Community Edition) - an actively maintained continuation of Hive v2 with improved performance, Flutter WASM support, and isolate support. Hive CE is faster and more reliable than the original Hive package.

License #

BSD-3-Clause License - see LICENSE file for details.

Copyright (c) 2025, MasterNemo (Dragon Software)

Feel free to clone and extend. It's free to use and share.