Format SQL in string text blocks
Recipe ID
org.openrewrite.sql.FormatSqlArtifact
org.openrewrite.recipe:rewrite-sqlChecks whether a text block may contain SQL, and if so, formats the text accordingly.
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.FormatSqlIf the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite.recipe:rewrite-sql:2.14.1Options
| 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