Skip to content

HH-MWB/sqlfmt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commits
 
 
 
 
 
 
 
 

Repository files navigation

SQLFMT

SQLFMT - An uncompromising SQL query formatter.

PyPI Latest Release Package Status Code style: black Imports: isort

SQLFMT is an uncompromising SQL query formatter, which provides one and only one way to format the SQL query. Our goal is to make code reviews faster by producing the smallest diffs possible. You will save time and mental energy on more important matters.

Please note this project is still in the planning stage and everything may be changed in the future.

How to install SQLFMT?

You can install SQLFMT from Python Package Index:

pip install sqlfmt

How to use SQLFMT?

Given a SQL file, you can simply use the following command to format it:

sqlfmt path/to/file.sql

You can install completion for a specfic shell:

sqlfmt --install-completion bash

You can also run the following command to find more other options:

sqlfmt --help

How does SQLFMT work?

It formats your SQL code in place.

For example, if you have a file containing the following SQL code:

SeLEct  1, blah as  fOO  from myTable

after running SQLFMT, the content of that file will become:

SELECT
  1,
  blah AS foo
FROM mytable

About

An uncompromising SQL query formatter.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages