Documentation
User Guides
- AI Assistance
Updated
AKML SQL can use an AI model of your choice to write, explain, fix, and tune SQL. Every AI suggestion is shown for review first — nothing is applied or executed without your confirmation.
- Connecting to SQL Server
Updated
AKML SQL works with the connection your query window already uses. Connect in SSMS the way you normally do, and AKML SQL picks up the active connection, loads the database schema, and starts offering…
- Formatting SQL
Updated
AKML SQL reformats T-SQL according to a formatting style. It fixes indentation, line breaks, commas, keyword casing, and more — without changing what the query does. If the formatter cannot prove the…
- Getting Started
Updated
AKML SQL is a SQL development plugin for SQL Server Management Studio (SSMS) 22. It adds IntelliSense, SQL formatting, static code analysis, refactoring, snippets, query history, and optional AI…
- IntelliSense
Updated
AKML SQL replaces the built-in completion list with a schema-aware IntelliSense engine. It reads your actual database, so suggestions match your tables, columns, and aliases — not just keywords.
- Options
New
Every AKML SQL setting lives in one Options window. This page walks through it page by page, in the order the pages appear in the window.
- Refactoring
Updated
Refactoring rewrites your SQL into a cleaner or safer shape without changing what it does. AKML SQL offers schema-aware operations such as Smart Rename, plus a set of quick text-level rewrites. Find…
- Set up the AKML browser workspace
New
AKML provides a browser workspace for SQL Server and PostgreSQL. The browser is the editor; a connected AKML engine handles database access. The SSMS 22 extension is the separate desktop experience…
- Snippets
Updated
Snippets are reusable SQL templates. Type a short code, press Tab, and the full template expands in the editor with placeholders you can tab through and fill in.
- SQL History
Updated
AKML SQL records every query you execute — automatically, without you saving anything. The history is crash-safe: if SSMS closes unexpectedly, your executed queries are still there on the next start.
- Static Code Analysis
Updated
AKML SQL checks your T-SQL for problems as you type and when you save. It ships with more than 130 rules, grouped into 8 categories.
- Troubleshooting
Updated
Most problems come down to a stale IDE cache, a stopped engine process, or a missing setting. Work through the sections below in order.
Reference
- Configuration Guide
Updated
The configuration file is stored at:
- Formatter Reference
Updated
The SQL formatter rewrites T-SQL text according to a formatting profile (.akmlstyle), preserving semantic equivalence. It runs as part of the out-of-process Engine and is invoked via the IPC API.
- Static Code Analysis Rules
Updated
The analysis engine ships with 132 rules across 8 categories. Rules run as you type (debounced). A separate set of 52 rules analyses PostgreSQL connections: see PostgreSQL rules.
- PostgreSQL reference
New
This file is generated. Do not edit it: change the generator in tools/pg-reference/ and run it again, see its README.
New = added in the last 30 days · Updated = changed in the last 30 days