QueryCraft Studio User Documentation

1Getting Started

Install the alpha build, launch QueryCraft Studio, and sign in with Google OAuth. On desktop, sign-in opens your browser for authentication and then returns you to the app automatically.

• Install and launch QueryCraft Studio (Alpha).
• Sign in with your Google account.
• Complete first-run setup before writing queries.

2Core Features

3Connections

QueryCraft Studio currently supports PostgreSQL, MySQL/MariaDB, and SQL Server. Create each connection once, then reuse it across tabs and workflows.

• Fields explained: connection name, host, port, database, username, password, SSL options.
• Use Test Connection before saving to validate network and credentials.
• Status meanings: Connected, Checking, Disconnected.
• Export connections with or without passwords. Prefer excluding passwords when sharing files.
• Import review shows each item as added, updated, or unchanged before applying.

4SQL Editor & Tabs

Run queries using the Run button or keyboard shortcut Ctrl/Cmd + Enter. Each tab keeps its own SQL draft and connection context.

• Open multiple tabs for parallel investigation.
• Pin important tabs to avoid accidental close.
• Use tab actions: close current, close others, close to the right, duplicate tab.
• Connection banner indicates which database/context your tab targets before execution.

5Safe Mode (Guardrails)

Safe Mode helps reduce production mistakes. It blocks or challenges potentially destructive SQL before execution.

• Blocks known dangerous patterns by default in protected environments.
• Requests explicit confirmation for risky operations.
• Works best when paired with permission-aware roles and read-only sessions.

6Results Grid & JSON

Use the results grid to inspect output quickly and drill into structured data without leaving the query context.

• Pagination loads results in chunks to keep large datasets responsive.
• Use global search in the grid for quick filtering.
• Apply column-level filters for targeted analysis.
• Open JSON cells in structured viewer mode for readable nested data.
• Pin JSON fields into columns by extracting key paths you use frequently.

7Query History & Favorites

History tracks executed queries by project and connection, while Favorites stores reusable statements for your team workflows.

• Save frequently-used SQL to Favorites with clear names.
• Reopen recent queries from History to continue investigation.
• Cleaning history requires confirmation to prevent accidental data loss.

8ER Diagram

Open ER Diagram from the schema explorer to understand table relationships visually before writing joins.

• Search tables and focus on one domain area at a time.
• Expand/collapse columns to reduce noise while exploring.
• Use auto-arrange for quick layout cleanup.
• Use AI arrange to propose a clearer map for complex schemas.

9AI Assistant & Scratchpad

AI Assistant helps generate SQL, explain existing queries, and suggest performance or readability improvements.

• Generate SQL from natural language tasks.
• Explain what a query does before running it.
• Suggest safer or faster alternatives for heavy operations.
• Include context from current connection/schema.
• Optionally include your current query for better suggestions.

10Offline & Sync Behavior

When offline, your local workspace remains usable. QueryCraft Studio syncs pending changes when connectivity is restored.

• You can continue drafting queries and organizing local work.
• Queued sync operations resume automatically when online.
• If you see sync issues: retry first, then verify connectivity and project access.

11Desktop Tools

If enabled in your build, desktop tools include PostgreSQL backup and restore workflows directly from the app.

• Find tools in the connection actions menu for PostgreSQL connections.
• Backup types: full backup or schema-only backup.
• Restore always requests explicit safety confirmation before running.