scala-sql-formatter

SQL Formatter for Scala.

This is a bridge to these libraries.

• Running on jvm, calls https://github.com/vertical-blank/sql-formatter
• Running on js, calls https://github.com/zeroturnaround/sql-formatter

Usage

Scala (on JVM)

libraryDependencies += "com.github.vertical-blank" %% "scala-sql-formatter" % "1.0.1"

Scala.js

libraryDependencies += "com.github.vertical-blank" %%% "scala-sql-formatter" % "1.0.1"

scalaJSLinkerConfig ~= { _.withModuleKind(ModuleKind.CommonJSModule) }

Examples

You can easily use com.github.vertical_blank.sqlformatter.scala.SqlFormatter :

SqlFormatter.format("SELECT * FROM table1")

This will output:

SELECT
  *
FROM
  table1

Dialect

You can pass dialect with FormatConfig :

SqlFormatter.format(
  "SELECT *",
  FormatConfig(dialect = SqlDialect.CouchbaseN1QL))

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 with FormatConfig to format :

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

This will output:

SELECT
    *
FROM
    table1

Placeholders replacement

You can pass Seq to formatWithIndexedParams, or Map to formatWithNamedParams :

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

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

Both result in:

SELECT
  *
FROM
  tbl
WHERE
  foo = 'bar'

Same as the format method, both formatWithNamedParams and formatWithIndexedParams accept FormatConfig.