Two free tools to format SQL queries

I originally published an extended version of this post on my blog.

---

Do you need to format your SQL queries? Are you doing it by hand? Stop! There is a better way!

Instead of formatting SQL queries to follow code conventions by hand, you can use online tools or plugins inside Visual Studio, SQL Server Management Studio or any other editors.

These are two free tools you can use to format your SQL queries and store procedures. Inside Notepad++, you can use Poor Man's T-SQL Formatter. And, ApexSQL Refactor for Visual Studio and SQL Server Management Studio (SSMS).

Before

Before using Poor Man's T-SQL Formatter and ApexSQL Refactor, I spent too much time formatting queries by hand. It means making keywords uppercase, aligning columns and arranging spaces.

I tried to use "Find and Replace" inside an editor. But, it only worked for making keywords uppercase. Sometimes I ended up messing with variables, parameters or any other thing inside my queries.

Photo by Kelly Sikkema on Unsplash

Things were worse with long store procedures. I changed two lines and I ended up formatting thousand of lines. "Once you touch it, you're the owner".

A sample query from StackOverflow

Let's format the query to find StackOverflow posts with many "thank you" answers.

select
   ParentId as [Post Link],
   count(id)
from posts
where posttypeid = 2 and len(body) <= 200
  and (body like '%hank%')
group by parentid
having count(id) > 1
order by count(id) desc;

After formatting the query to follow Simon Holywell SQL Style Guide, it should like this

SELECT ParentId AS [Post Link]
     , COUNT(id)
  FROM posts
 WHERE posttypeid = 2
   AND LEN(body) <= 200
   AND (body LIKE '%hank%')
 GROUP BY parentid
HAVING COUNT(id) > 1
 ORDER BY COUNT(id) DESC;

Let's see how these two tools format our sample query.

1. Poor Man's T-SQL Formatter

Poor Man's T-SQL Formatter is a free and open source .NET and JavaScript library to format your SQL queries. It's available for Notepad++, Visual Studio, SQL Server Management Studio and others. You can try its formatting options online too.

This is how Poor Man's T-SQL format our sample query.

Sample query formatted by Poor Man's T-SQL inside Notepad++

It doesn't make function names uppercase. It indents AND's clauses. But, it's a good starting point. Sometimes, it need a bit of help if the query has single-line comments in it.

ApexSQL Refactor

ApexSQL Refactor is a free query formatter for Visual Studio and SQL Server Management Studio. It has over 160 formatting options. We can create our own formatting profiles and preview them. It comes with four built-in profiles. Also, we can try it online.

UPDATE: ApexSQL Refactor isn't freely available online anymore.

This is how ApexSQL Refactor format our sample query.

Sample query formatted by ApexSQL Refactor inside Visual Studio

It isn't perfect either. It indents AND clauses too. I couldn't find an option to change it. But, there is an option to indent ON in SELECT statements with JOIN, but it affects ON for index creation too.

Voilà! Please, save you some time formatting your SQL queries with any of these two free tools.

We can take a step further and call a formatter inside a Git hook to automatically format SQL files when committing our files. I did it with Poor Man’s T-SQL formatter.

---

Starting out or already on the software engineering journey? Join my free 7-day email course to refactor your coding career and save years and thousands of dollars' worth of career mistakes.