This repository contains the C# port of the popular Java SQL formatter
This does not support:
- Stored procedures.
- Changing of the delimiter type to something else than ;.
To install the Hogimn.Sql.Formatter package with NuGet, you can use the following command in your terminal or command prompt.
dotnet add package Hogimn.Sql.Formatter --version 1.0.0For more details, visit the NuGet Gallery page.
You can easily use SQL.Formatter.SqlFormatter :
SqlFormatter.Format("SELECT * FROM table1")This will output:
SELECT
*
FROM
table1You can also pass FormatConfig object built by builder:
SqlFormatter.Format("SELECT * FROM tbl",
FormatConfig.Builder()
.Indent(" ") // Defaults to two spaces
.Uppercase(true) // Defaults to false (not safe to use when SQL dialect has case-sensitive identifiers)
.LinesBetweenQueries(2) // Defaults to 1
.MaxColumnLength(100) // Defaults to 50
.Params(new List<string>{"a", "b", "c"}) // Dictionary or List. See Placeholders replacement.
.Build());
);You can pass dialect SQL.Formatter.Language.Dialect or String to SqlFormatter.Of :
SqlFormatter
.Of(Dialect.N1ql) // Recommended
//.Of("n1ql") // String can be passed
.Format("SELECT *");SQL formatter supports the following dialects:
- sql - Standard SQL (Default)
- mariadb - MariaDB
- mysql - MySQL
- postgresql - PostgreSQL
- db2 - IBM DB2
- plsql - Oracle PL/SQL
- n1ql - Couchbase N1QL
- redshift - Amazon Redshift
- spark - Spark
- tsql - SQL Server Transact-SQL
Formatters can be extended as below :
SqlFormatter
.Of(Dialect.MySql)
.Extend(cfg => cfg.PlusOperators("=>"))
.Format("SELECT * FROM table WHERE A => 4")Then it results in:
SELECT
*
FROM
table
WHERE
A => 4You can pass List or Dictionary to Format :
// Named placeholders
Dictionary<string, string> namedParams = new Dictionary<string, string>();
namedParams.Add("foo", "'bar'");
SqlFormatter.Of(Dialect.TSql).Format("SELECT * FROM tbl WHERE foo = @foo", namedParams);
// Indexed placeholders
SqlFormatter.Format("SELECT * FROM tbl WHERE foo = ?", new List<string> {"'bar'"});Both result in:
SELECT
*
FROM
tbl
WHERE
foo = 'bar'
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent