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.
Creating Database Connections
QueryBox uses a connection-based workflow to interact with your databases. Each connection stores metadata locally and credentials securely in your operating system’s keyring.Adding a New Connection
Open the Connections Window
Click the + button in the Connections panel sidebar, or navigate to the Connections window from the menu bar.The Connections window displays all your saved connections and allows you to create new ones.
Select Your Database Type
QueryBox supports multiple database types through its plugin system:
- PostgreSQL - Relational database with advanced features
- MySQL / MariaDB - Popular open-source relational database
- SQLite - Lightweight file-based database (local files or Turso Cloud)
- Redis - In-memory key-value store
- ArangoDB - Multi-model database (documents, graphs, key-value)
Fill in Connection Details
The connection form adapts based on your database type. Common fields include:
- PostgreSQL / MySQL
- SQLite
- Redis
- Host - Database server address (e.g.,
localhostordb.example.com) - Port - Server port (default: 5432 for PostgreSQL, 3306 for MySQL)
- Username - Database user account
- Password - User password (securely stored in OS keyring)
- Database - Default database name
- SSL/TLS Options - Connection encryption settings
Test Your Connection
If the plugin supports it, click Test Connection to verify your credentials before saving.QueryBox will attempt to connect and display a success message or error details.
Save the Connection
Give your connection a memorable name and click Save.
- The connection name appears in the Connections panel sidebar
- Connection metadata is stored in
connections.db - Credentials are stored securely in your OS keyring (Keychain on macOS, Credential Manager on Windows, Secret Service on Linux)
Managing Existing Connections
Connecting to a Database
Click a connection name in the sidebar to load its database tree structure. QueryBox will:- Retrieve credentials from the secure keyring
- Execute the
connection-treeplugin command - Display databases, tables, schemas, and other objects in the tree view
Reconnecting
If a connection tree is already loaded, hover over the connection name to reveal the Connect button. Click it to refresh the tree structure.Deleting a Connection
Connection Storage
QueryBox stores connection data in two locations:| Data Type | Storage Location | Platform-Specific Path |
|---|---|---|
| Metadata (name, driver type, timestamps) | SQLite database | ~/Library/Application Support/querybox/connections.db (macOS)%APPDATA%\querybox\connections.db (Windows)~/.config/querybox/connections.db (Linux) |
| Credentials (passwords, tokens) | OS keyring | macOS Keychain Windows Credential Manager Linux Secret Service |
If the OS keyring is unavailable (e.g., on headless servers), QueryBox falls back to a local SQLite credentials store, then to ephemeral in-memory storage.
Searching Connections
Use the search bar at the top of the Connections panel to filter connections by name. Only matching connections remain visible in the tree.Tips
- Connection Names: Use descriptive names that identify the environment (e.g., “Production DB”, “Local Dev MySQL”)
- Multiple Connections: You can create multiple connections to the same database server with different credentials or default databases
- File Paths: For SQLite, relative paths are resolved from your current working directory; absolute paths are recommended
- Port Numbers: If using non-standard ports, double-check the value before saving