Usage
Run this recipe
This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe FindSqlUsage
If the recipe is not available locally, then you can install it using:
RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.
- RELEASE
- LATEST
- Pinned version
mod config recipes jar install io.moderne.recipe:rewrite-prethink:RELEASE
mod config recipes jar install io.moderne.recipe:rewrite-prethink:LATEST
mod config recipes jar install io.moderne.recipe:rewrite-prethink:0.12.0
Data tables
SQL usage
io.moderne.prethink.table.SqlUsagePhysical tables and columns each SQL statement touches, attributed to the class and method that issues it.
| Column | Description |
|---|---|
| Source path | The path to the source file containing the SQL. |
| Line number | The line the SQL statement begins on. Together with the source path this joins a row in sql-anti-patterns.csv to the method that issues the query. |
| Class name | The fully qualified name of the class issuing the statement, or of the MyBatis mapper interface a mapper XML declares as its namespace. Empty for a .sql file or any other resource that names no class. |
| Method name | The simple name of the method issuing the statement, or the id of the MyBatis statement, which is the mapper interface method it implements. Empty for SQL outside any method. |
| Method signature | The full method signature including parameter types, joining method-quality-metrics.csv and test-gaps.csv. Empty where the SQL is not inside a method, including in mapper XML, where the method is named but its parameter types are not known. |
| Language | The language of the file the statement is written in, e.g. java, kotlin, csharp, python, xml, or sql for a plain .sql file. |
| Embedded in | How the statement is written: literal for a single string literal, concatenation for one assembled with + or StringBuilder.append, interpolation for an interpolated or template string, or file, xml, yaml or json for a statement carried by a resource. |
| Table | The physical table this row reports on. A statement touching several tables contributes one row per table. |
| Operations | The operations the statement performs on this table, comma-separated in SELECT,UPDATE,INSERT,DELETE,CREATE,ALTER order. A write that also reads the table, as an UPDATE ... WHERE does, reports both. |
| Columns | The columns of this table the statement names, comma-separated, or * where it selects them all. Empty where no column can be attributed to the table with certainty, which a DELETE or an ambiguous join produces. |
| Dynamic | Whether the statement is assembled at runtime, from an interpolated string, from a concatenation with a non-constant operand, or from a mapper XML statement with conditional elements nested in it, in which case the query below is only the static part of what actually runs. |
| Query | The SQL statement, truncated to 200 characters. Read the source at the path and line above for the whole of a longer statement. |
Source files that had results
org.openrewrite.table.SourcesFileResultsSource files that were modified by the recipe run.
| Column | Description |
|---|---|
| Source path before the run | The source path of the file before the run. null when a source file was created during the run. |
| Source path after the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
| Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
| Recipe that made changes | The specific recipe that made a change. |
| Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
| Cycle | The recipe cycle in which the change was made. |
Source files that had search results
org.openrewrite.table.SearchResultsSearch results that were found during the recipe run.
| Column | Description |
|---|---|
| Source path of search result before the run | The source path of the file with the search result markers present. |
| Source path of search result after run the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
| Result | The trimmed printed tree of the LST element that the marker is attached to. |
| Description | The content of the description of the marker. |
| Recipe that added the search marker | The specific recipe that added the Search marker. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrorsThe details of all errors produced by a recipe run.
| Column | Description |
|---|---|
| Source path | The file that failed to parse. |
| Recipe that made changes | The specific recipe that made a change. |
| Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStatsStatistics used in analyzing the performance of recipes.
| Column | Description |
|---|---|
| The recipe | The recipe whose stats are being measured both individually and cumulatively. |
| Source file count | The number of source files the recipe ran over. |
| Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
| Cumulative scanning time (ns) | The total time spent across the scanning phase of this recipe. |
| Max scanning time (ns) | The max time scanning any one source file. |
| Cumulative edit time (ns) | The total time spent across the editing phase of this recipe. |
| Max edit time (ns) | The max time editing any one source file. |