← All recipes
Moderne licensed

Change a SQL function name

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

When migrating between dialects, often one name can be substituted for another. For example, Oracle's NVL function can be replaced with Postgres COALESCE.

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.ChangeFunctionName")
}

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

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.sql.ChangeFunctionName --recipe-option "oldFunctionName=NVL" --recipe-option "newFunctionName=COALESCE"

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

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

Options

NameTypeDescription
oldFunctionNamerequiredStringThe name of the function to find, case insensitive.
e.g. NVL
newFunctionNamerequiredStringThe new name to use. This will match the casing of the original method when a replacement is made.
e.g. COALESCE

Data tables

Structured output this recipe can produce.

  • SQL queriesShows matching SQL queries.org.openrewrite.sql.table.DatabaseQueries
  • SQL functions in useShows matching SQL functions and the queries that contain them.org.openrewrite.sql.table.DatabaseFunctions
  • 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