Getting Started
Quick Start Guide
Quick Start Guide
This guide starts after WhoDB is running and you have connected to a database.
Tip
WhoDB uses source-first terminology. Most database tables, collections, buckets, or equivalent objects are shown as Storage Units.
Current Interface
After login, the left sidebar is the primary navigation surface. Depending on the connected source, it can show:
- Chat when AI chat is supported and a provider/model is configured
- Storage Units for browsing tables, collections, views, or similar objects
- Graph when relationship visualization is supported
- Scratchpad when custom query execution is supported
- Settings when the settings page is enabled
The Storage Units page is the default browse view. It can show cards or a list. Use the search field at the top of the page to filter object names.
First Five Minutes
Viewing And Filtering Data
On a storage unit data page:
- Search highlights and scrolls to matching values in currently loaded rows. Use WHERE conditions when you want to filter the result set.
- Where condition opens the condition builder. Add field/operator/value conditions, then click Query on the page to reload data with those conditions.
- Page Size controls how many rows WhoDB asks the backend for per page. Built-in options include
10,25,50,100,250,500,1000, andCustom, subject to the configured maximum. - Pagination appears at the bottom when more pages are available.
- Column headers can be clicked to sort. Sorting is sent back through the data request.
Managing Rows
Row write actions are only shown when the connected source and object allow them.
- Add Row is below the table, beside pagination. It opens a right-side sheet with one input per column, or a JSON editor for records from sources like MongoDB.
- Edit Row is available from a row context menu or by focusing a row and pressing
Enter/Mod + E. It opens a right-side edit sheet. - Delete Row is available from a row context menu or
Mod + Delete/Mod + Backspaceon a focused row. Current CE code shows a confirmation dialog before deleting. - Select rows with checkboxes. The header checkbox toggles all currently loaded rows.
Warning
Writes are sent to the connected database. Test changes on a development database and keep backups for important data.
Scratchpad Basics
Scratchpad is organized as pages. Each page contains one or more query cells.
- Click the
+tab to add a new page. - Double-click a page name to rename it.
- Use the
+button that appears on a cell to add another cell below it. - Use the cell three-dot menu for Clear, Copy Code, and Query History.
- Query results render below the editor. Action statements show an action-executed result after confirmation.
- Query history is stored per cell and contains status, timestamp, copy, clone-to-editor, rerun, and clear-history actions.
Graph Basics
The Graph page has two parts:
- A left graph sidebar with a search field and checkboxes for selecting storage units.
- A React Flow canvas showing selected nodes and relationship edges.
Graph controls are on the canvas:
- React Flow zoom, fit, and lock/pan controls are at the lower-left.
- WhoDB download and layout buttons are at the lower-right.
- Holding
Spaceenables drag-pan behavior; scroll/pinch gestures zoom or pan according to browser and React Flow behavior. - Clicking a node loads that node's columns when needed. Node cards show metadata and columns directly.
- Use the Data button inside a node to open the storage unit data page.
Export Basics
Use the table Export All button, or selected-row export from the table context menu.
Current CE formats are:
- CSV for tabular exports, with delimiter options
,,;, and| - Excel (
.xlsx) for tabular exports - JSON Lines (NDJSON) for records from sources like MongoDB when supported
For full SQL backups or migration dumps, use your database's native tools such as pg_dump, mysqldump, or mongodump.
Useful Shortcuts
Mod means Cmd on macOS and Ctrl on Windows/Linux.
Shortcut | Action |
|---|---|
? | Open shortcut help |
Mod + K | Open command palette |
Mod + B | Toggle sidebar |
Mod + Enter | Run the current Scratchpad editor |
Mod + U | Clear the current editor |
Mod + R | Refresh table data |
Mod + Shift + E | Open export |
Mod + I | Open import when supported |
Mod + Shift + G | Open mock data generation when supported |
See Keyboard Shortcuts for the full current list.
Next Steps
Previous