WhoDB Documentation
repository·main·Indexed 26 days ago
https://github.com/clidey/whodbA lightweight, self-hosted workspace for exploring, editing, and querying databases including PostgreSQL, MySQL, SQLite, and MongoDB. It features a browser-based UI, a desktop application, and a CLI/MCP server. The whodb-cli provides a TUI for interactive management, programmatic query execution, and integration with AI assistants like Claude Code, Cursor, and VS Code via the Model Context Protocol (MCP), including specialized agents for database analysis, query optimization, and report generation.
What's inside WhoDB
- WhoDB's AI Chat Assistant allows you to interact with your databases using natural language instead of writing SQL. The assistant analyzes your database schema (tables, columns, and relationships) to generate, execute, and display optimized SQL queries. It supports multiple databases including PostgreSQL, MySQL, MongoDB, SQLite, and Redis.
Overview of WhoDB features
mainWhoDB is an open-source database management tool designed for exploring, querying, and visualizing data across multiple database types.
Key capabilities include:
- Multi-Database Support: Connect to PostgreSQL, MySQL, SQLite, MongoDB, Redis, and more.
- Visual Schema Explorer: Interactive graph visualizations of table relationships and foreign keys.
- Query Interface: Syntax-highlighted SQL editor with history tracking and result visualization.
- Data Management: Spreadsheet-like grid for viewing, adding, editing, and deleting records.
- Mock Data Generation: Tools to generate realistic test data with configurable row counts and modes (append or overwrite).
- Export Capabilities: Export data to CSV, Excel, or JSON Lines (for supported sources like MongoDB).
Explore WhoDB features and capabilities
mainWhoDB is a lightweight, self-hosted database management tool designed for speed and simplicity. Key features include:
- Browser-Based UI: Access via any device with a browser without heavy desktop installations.
- Spreadsheet-Like Data Grid: Sort by column headers, right-click rows for actions, and use
WHEREconditions for server-side filtering. - Visual Schema Explorer: An interactive graph view to visualize tables, relationships, columns, indexes, and foreign keys.
- Powerful Query Editor: A web-based 'Scratchpad' with syntax highlighting, query history, and multi-cell support, or a CLI TUI with autocomplete and formatting.
- Mock Data Generation: Generate realistic test data (1 to 10,000+ rows) with smart data type handling.
- Flexible Export: Export data to CSV, Excel (.xlsx), or JSON Lines (for supported sources like MongoDB).
- Advanced Filtering: Visual interface for complex
WHEREconditions using standard operators (=,!=,>,<,>=,<=), date ranges, text patterns, and NULL handling.
Navigate the WhoDB Interface
mainThe WhoDB interface is navigated via a left sidebar. The available navigation items depend on your connected data source:
- Storage Units: The default view for browsing tables, collections, views, or similar objects. Use the search field at the top to filter object names.
- Chat: Available when AI chat is configured with a provider and model.
- Graph: Used for relationship visualization.
- Scratchpad: Used for custom query execution.
- Settings: Access the settings page if enabled.
Compare WhoDB and DBeaver capabilities
mainWhoDB and DBeaver serve different database management needs.
WhoDB is a lightweight, web-based alternative optimized for speed, modern infrastructure, and team collaboration. It is best for fast workflows, development work, and remote/mobile access via a browser.
DBeaver is a comprehensive, feature-heavy desktop IDE designed for power users. It is best for managing highly diverse database environments (50+ types) and performing complex operations like advanced query profiling and visual query building.
WhoDB Unique Features
mainWhoDB provides several features not found in TablePlus:
- Mock Data Generation: Built-in realistic test data generation for supported column types.
- Interactive Schema Graph: Visual schema exploration with relationship lines, node cards, and data actions.
- Multi-Cell Notebooks: Organize queries into cells similar to Jupyter notebooks for complex workflows.
- Team Collaboration: Central web server for team access and easy sharing of database connections.
- Web-Based Access: Access from any browser on any device (Mac, Windows, Linux, iPad).
Compare WhoDB and TablePlus
mainWhoDB and TablePlus are both database management tools, but they serve different primary use cases:
WhoDB (Web-Based Solution)
- Best for: Teams, Docker deployments, cross-platform access, and open-source projects.
- Key Features: Free (Open Source), web-based (any browser), multi-database support, built-in mock data generation, interactive schema graphs, and multi-cell notebooks.
- Deployment: Central server deployment (Go server + browser UI) allowing team access via a single URL.
TablePlus (Native Desktop Experience)
- Best for: Individual developers, Mac users, and professionals seeking a polished native application.
- Key Features: Paid (one-time license), native desktop app (Mac, Windows, Linux), offline access, and advanced export formats (PDF, XML).
- Deployment: Local desktop installation on each device.
Verify WhoDB Community Edition (CE) licensing and usage
mainWhoDB Community Edition (CE) is free and open source. It can be used for personal and commercial projects without hidden costs or usage limits. For commercial-grade packaging and support, refer to the separate commercial product channels.Understand the Data Page layout
mainThe WhoDB data page provides several tools for inspecting and managing data:
- Object Metadata: Displays the object name and total row count.
- Search Input: Filters currently loaded row values.
- Page Size Selector: Controls how many rows are displayed at once.
- Where Condition Builder: Allows for backend database filtering.
- Query Button: Reloads the data based on the current WHERE conditions.
- Scratchpad: An optional embedded drawer for running commands.
- Data Grid: Includes row checkboxes, sortable headers, row context menus, pagination, import, export, and an Add Row option (when supported by the source).
WhoDB Design System Overview
mainWhoDB follows a 'Clean Terminal' design philosophy, prioritizing functional density, monochrome confidence, and zero decorative noise. The system is designed to be a lightweight, high-performance interface for infrastructure professionals, avoiding the clutter of legacy database tools and the decorative bloat of modern SaaS products.
Key Principles:
- Information as Interface: The design removes itself so data can speak.
- Monochrome Dominance: Uses a restrained palette with a single blue accent used sparingly (≤10% surface coverage).
- Tonal Layering: Depth is achieved through tonal layering (surface → muted surface → code surface) rather than shadows.
- Typography Hierarchy: Uses the Inter variable font family with varying weights to establish hierarchy without font pairing.
- Mode Parity: Light and dark modes are treated as equal citizens.
Configure AWS auto-discovery for WhoDB
mainWhen AWS discovery is enabled (in Production and Self-Hosted stacks), WhoDB automatically discovers the following resources in the same region:
- RDS instances (PostgreSQL, MySQL, MariaDB)
- ElastiCache clusters (Redis)
- DocumentDB clusters (MongoDB-compatible)
Discovered databases will appear on the WhoDB login page. Note that discovery only finds the endpoints; you must still provide the correct credentials to connect. The WhoDB task role is granted read-only permissions (
rds:Describe*,elasticache:Describe*,docdb:Describe*) and cannot modify your databases.WhoDB Interface Features
mainThe WhoDB web interface is a modern React-based UI designed for speed and ease of use. Key features include:
- Spreadsheet-like data grid: Familiar interface for editing data.
- Dark mode support: For comfortable working environments.
- Navigation: Sidebar navigation with schema hierarchy.
- Search & Filtering: Search across loaded rows or use server-side filtering with
WHEREconditions. - Visualization: Interactive schema and relationship graphs (supports PNG export, pan, and zoom).
- Context Menus: Right-click menus for common actions.
- Keyboard Shortcuts: For power users.