← All recipes
Moderne licensed

Find SQL function

Recipe IDorg.openrewrite.sql.search.FindFunctionArtifactorg.openrewrite.recipe:rewrite-sql

Find SQL functions by name.

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

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.search.FindFunction --recipe-option "functionName=nvl"

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

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

Options

NameTypeDescription
functionNamerequiredStringThe name of the function to find, case insensitive. Supports glob.
e.g. nvl
markSourceBooleanWhether to mark each occurrence in source with a search marker. Defaults to true; set to false to leave source untouched and report only to the data tables, as an analysis-only pipeline requires.

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