Getting Started

Learn how to install and begin using StyleSQL.

Prerequisites

• SSMS 21 or 22 (required). Support for SSMS 18-20 coming soon. Works with SQL Server instances reachable from SSMS.
• Permissions to read object definitions in the target database.
• To execute generated scripts, you’ll need standard ALTER permissions for target objects.

Install

• Download and install the StyleSQL MSI. Once installed, restart SSMS.
• No server components are required.

Quick Start: Style in the Editor

1. Open SSMS and your script

2. Right‑click inside the editor and choose "Style SQL in Editor" (or click the StyleSQL toolbar button)

3. Confirm the output

   Note: If text is selected, only the selection is formatted; otherwise, the entire document is formatted.

   Use Undo if you want to revert. When you’re comfortable, consider enabling:

   • Auto‑format on Paste
   • Auto‑format on Execute

See details in Format in Editor.

Quick Start: Style Your Entire Database

1. Open StyleSQL in SSMS

   In Object Explorer, right‑click a database → choose "Style Database".

2. Scan your database

   The window opens and begins scanning objects (procedures, views, functions, triggers).

3. Review diffs

   Use side‑by‑side or inline views. Toggle "Ignore whitespace" and "Changes only" to focus on meaningful edits.

4. Generate a script

   Turn on "Script Only" and click "Apply" to generate a T‑SQL script for the selected changes.

5. Apply safely

   Review the generated script in the editor and run it when ready.