isar_db_inspector - Dart API docs

Isar Inspector

A powerful, real-time database inspector for Isar DB that allows you to view, query, and debug your Isar database during development.

Overview

Isar Inspector is a development tool that provides a beautiful and intuitive interface for inspecting your Isar database. It connects to your running Flutter app and allows you to explore your data in real-time.

Features

Real-time Updates: See changes to your database as they happen
Query Builder: Execute complex queries with an intuitive interface
Schema View: Inspect collection schemas and relationships
Data Editing: Modify properties directly in the inspector
Multi-Instance Support: Switch between multiple Isar instances
Filtering & Sorting: Easily filter and sort your data
JSON Import/Export: Import and export data in JSON format
Performance Metrics: View query performance and database statistics

Installation

Add isar_db_inspector to your pubspec.yaml:

dev_dependencies:
  isar_db_inspector: ^1.0.0

Usage

The inspector automatically appears when you run your Flutter app in debug mode. Look for the connection URL in your debug console:

═══╡ Isar Inspector ╞═══
Connect to: http://localhost:8080/...

Open the URL in your browser to start inspecting your database.

Requirements

Flutter SDK: >=3.24.0
Dart SDK: >=3.7.0
For use in debug/development mode only

Documentation

For more information, see the main Isar DB documentation.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.