Documentation Index
Fetch the complete documentation index at: https://mintlify.com/felixdotgo/querybox/llms.txt
Use this file to discover all available pages before exploring further.
Executing Queries
QueryBox provides a powerful query editor with syntax highlighting, autocomplete, and multi-tab result management.Writing Queries
Opening the Query Editor
The query editor appears in the main workspace area. To open a new query tab:Editor Features
The QueryBox editor is powered by Monaco Editor (the same engine as VS Code) with database-specific enhancements:- Syntax Highlighting - Keywords, strings, and identifiers are color-coded
- Autocomplete - Press
Ctrl+Space(or start typing) to see suggestions:- SQL keywords (
SELECT,FROM,WHERE, etc.) - Table names from your database schema
- Column names (type
tablename.to trigger) - Database and schema names
- SQL keywords (
- Multi-line Editing - Write complex queries with proper indentation
- Word Wrap - Long queries wrap automatically for readability
Running Queries
Execute with Keyboard Shortcut
Press Cmd+Enter (macOS) or Ctrl+Enter (Windows/Linux) to execute the current query.Execute from Tree Actions
Click a database object in the tree to run its default action:- Tables/Views - Automatically runs
SELECT * FROM table LIMIT 100 - Collections (MongoDB-style) - Fetches documents
- Keys (Redis) - Retrieves key values
Action Buttons
Nodes in the connection tree may display action buttons on hover:- Select - Query all rows/documents
- Describe - Show table structure
- Drop - Delete the object (with confirmation)
Query Results
Result Tabs
Each query opens a result tab in the workspace. Tabs display:- Title - Table name or query description
- Status Indicator - Loading spinner or error badge
- Timestamp - When the query was executed
Result Formats
QueryBox adapts the result viewer based on your database type:- SQL (Relational)
- Document Store
- Key-Value
Results appear in a data grid with:
- Column Headers - Sortable and resizable
- Row Numbers - For easy reference
- Pagination Controls - If your query returns many rows
LIMIT clause automatically append LIMIT 100).Handling Errors
If a query fails, the result tab displays:- Error Icon - Red badge on the tab
- Error Message - Full error text from the database
- Query Context - The query that caused the error
Advanced Query Features
EXPLAIN Queries
For databases that support query planning (PostgreSQL, MySQL, SQLite):Click the Explain Button
If the database plugin advertises
explain-query capability, an Explain button appears in the result toolbar.The Explain button only appears for plugins that support it. Check the plugin documentation for availability.
Refreshing Results
Click the Refresh icon in a result tab toolbar to re-run the same query with current data. This is useful for:- Monitoring changes in real-time
- Verifying that an
UPDATEorDELETEtook effect - Re-fetching after another tool modified the database
Context-Aware Queries
When you run a query from a tree node, QueryBox automatically sets the database context:- Clicking
production.userstable setsdatabase: "production" - Your query runs against the correct database without needing
USEstatements
Multi-Tab Workflow
Opening Multiple Queries
- Each tree action or manual query opens a new tab
- Tabs persist until you close them
- Switch between tabs by clicking their titles
Comparing Results
Open multiple queries side-by-side:- Run a query in one tab
- Click another table or write a new query
- Compare results across tabs
Closing Tabs
Hover over a tab and click the × icon to close it. There’s no “unsaved changes” warning since tabs are ephemeral.Query Types by Database
- PostgreSQL / MySQL
- SQLite
- Redis
- ArangoDB
SELECT,INSERT,UPDATE,DELETECREATE TABLE,ALTER TABLE,DROP TABLECREATE INDEX,DROP INDEXBEGIN,COMMIT,ROLLBACK(transactions)EXPLAIN(query planning)
Tips
- Keyboard Shortcut: Memorize
Cmd/Ctrl+Enterfor fast query execution - Limit Rows: Always include a
LIMITclause on production databases to avoid overwhelming results - Autocomplete: Type
database.table.to see column suggestions - Error Logs: Check the Logs panel (bottom toolbar) for detailed error messages
- Plugin Capabilities: Some features (like Explain) depend on plugin support; see the Plugins window for details