Moderne licensed

Format SQL in string text blocks

Recipe IDorg.openrewrite.sql.FormatSqlArtifactorg.openrewrite.recipe:rewrite-sql

Checks whether a text block may contain SQL, and if so, formats the text accordingly.

Single recipeProprietary

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.sql.FormatSql")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-sql:2.17.0")
}

Then run

./gradlew rewriteRun

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.sql.FormatSql

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-sql:RELEASE

Options

Name	Type	Description
`sqlDialect`	`String`	Check out https://github.com/vertical-blank/sql-formatter#dialect for supported dialects. e.g. `postgresql`
`indent`	`String`	Defaults to two spaces. e.g.
`maxColumnLength`	`Integer`	Defaults to 50. e.g. `100`
`uppercase`	`Boolean`	Defaults to false (not safe to use when SQL dialect has case-sensitive identifiers). e.g. `true`

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats