sql-formatter

SQL Formatter for Scala

License	MIT
Categories	ORM Data
GroupId	com.github.takayahilton
ArtifactId	sql-formatter_2.12
Last Version	1.2.1
Release Date	Jul 21, 2020
Type	jar
Description	sql-formatter SQL Formatter for Scala
Project URL	https://github.com/takayahilton/sql-formatter
Project Organization	com.github.takayahilton
Source Code Management	https://github.com/takayahilton/sql-formatter

Download sql-formatter_2.12

Filename	Size
sql-formatter_2.12-1.2.1.pom
sql-formatter_2.12-1.2.1.jar	128 KB
sql-formatter_2.12-1.2.1-sources.jar	20 KB
sql-formatter_2.12-1.2.1-javadoc.jar	1 MB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.takayahilton/sql-formatter_2.12/ -->
<dependency>
    <groupId>com.github.takayahilton</groupId>
    <artifactId>sql-formatter_2.12</artifactId>
    <version>1.2.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.takayahilton/sql-formatter_2.12/
implementation 'com.github.takayahilton:sql-formatter_2.12:1.2.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.takayahilton/sql-formatter_2.12/
implementation ("com.github.takayahilton:sql-formatter_2.12:1.2.1")

Apache Buildr

'com.github.takayahilton:sql-formatter_2.12:jar:1.2.1'

Apache Ivy

<dependency org="com.github.takayahilton" name="sql-formatter_2.12" rev="1.2.1">
  <artifact name="sql-formatter_2.12" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.takayahilton', module='sql-formatter_2.12', version='1.2.1')
)

Scala SBT

libraryDependencies += "com.github.takayahilton" % "sql-formatter_2.12" % "1.2.1"

Leiningen

[com.github.takayahilton/sql-formatter_2.12 "1.2.1"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.scala-lang : scala-library	jar	2.12.11

test (1)

Group / Artifact	Type	Version
org.scalatest : scalatest_2.12	jar	3.2.0

Project Modules

There are no modules declared in this project.

sql-formatter

Scala port of great SQL formatter https://github.com/zeroturnaround/sql-formatter, https://github.com/vertical-blank/sql-formatter.

Written with only Scala Standard Library, without dependencies.

Demo

Usage

Scala (on JVM)

libraryDependencies += "com.github.takayahilton" %% "sql-formatter" % "1.2.1"

Scala.js

libraryDependencies += "com.github.takayahilton" %%% "sql-formatter" % "1.2.1"

Scala Native

libraryDependencies += "com.github.takayahilton" %%% "sql-formatter" % "1.2.1"

Examples

You can easily use com.github.takayahilton.sqlformatter.SqlFormatter :

import com.github.takayahilton.sqlformatter._

SqlFormatter.format("SELECT * FROM table1")

This will output:

SELECT
  *
FROM
  table1

Dialect

You can pass dialect name to SqlFormatter.of :

import com.github.takayahilton.sqlformatter._

SqlFormatter.of(SqlDialect.CouchbaseN1QL).format("SELECT *")

Currently just four SQL dialects are supported:

• StandardSQL - Standard SQL
• CouchbaseN1QL - Couchbase N1QL
• DB2 - IBM DB2
• PLSQL - Oracle PL/SQL

Format

Defaults to two spaces. You can pass indent string to format :

import com.github.takayahilton.sqlformatter._

SqlFormatter.format(
  "SELECT * FROM table1",
  indent = "    ")

This will output:

SELECT
    *
FROM
    table1

Placeholders replacement

You can pass Seq or Map to format :

import com.github.takayahilton.sqlformatter._

// Named placeholders
SqlFormatter.format("SELECT * FROM tbl WHERE foo = @foo", params = Map("foo" -> "'bar'"))

// Indexed placeholders
SqlFormatter.format("SELECT * FROM tbl WHERE foo = ?", params = Seq("'bar'"))

Both result in:

SELECT
  *
FROM
  tbl
WHERE
  foo = 'bar'

Versions

Version
1.2.1 Jul 21, 2020
1.2.0 Jun 1, 2020
1.1.0 Jun 1, 2020
1.0.0 Mar 25, 2020
0.1.0 Mar 25, 2020