local_db_explorer library

A lightweight in-app database viewer/inspector for debugging local storage.

This package provides a simple way to inspect and debug databases like Sqflite, Hive, and SharedPreferences during development.

Usage

1. Register database adapters:

// For Sqflite
DBViewer.registerAdapter(SqfliteAdapter(database));

// For Hive (when implemented)
DBViewer.registerAdapter(HiveAdapter(hive));

// For SharedPreferences (when implemented)
DBViewer.registerAdapter(SharedPreferencesAdapter(prefs));

2. Open the inspector:

ElevatedButton(
  onPressed: () {
    DBViewer.open();
  },
  child: Text("Open DB Explorer"),
);

Security

The inspector only works in debug mode (kDebugMode). In release builds, all DBViewer methods are no-ops to prevent accidental exposure of database contents.

Classes

DBAdapter

Abstract base class for database adapters.

DBExplorer

The main controller for the DBViewer package.

HiveAdapter

Adapter for Hive databases.

InspectorScreen

Full-screen database inspector with mobile-optimized design.

SharedPreferencesAdapter

Adapter for SharedPreferences.

SqfliteAdapter

Adapter for Sqflite databases.