Overrides which column a component of the result row type reads

A component reads the column its own name implies, camelCase read as snake_case. Where the two disagree, aliasing the column in the query is usually the better answer, because it puts the mapping next to the column being renamed. This is for when the query is not yours to change — a view you do not own, or SQL generated elsewhere.

Keys are component paths from the root of the result row type, so a component of a nested record is addressed through the component holding it:

-- resultRowColumns:
--   amount.minorUnits: amount_cents
--   at: created_at

A column override belongs to the type rather than to one query, so every statement naming the same result row type shares one set: overrides declared on any of them apply to all of them, and two statements mapping the same component to different columns fail the build.

Configuration Options

Related Options

• annotations : The additional annotations to be placed on generated methods.

• catchAndRethrow : Catch exceptions during SQL execution and re-throw them as RuntimeExceptions

• createConnection : Controls whether the generated code should create/open connection itself or use a given connection.

• description : The description for the SQL statement

• executeBatch : Generate methods that are executed as batch

• executeBatchPrefix : The method prefix to use for generated methods that execute in a batch.

• executeBatchSuffix : The method suffix to use for generated methods that execute in a batch.

• executeOnce : Generate methods that are executed once with the given parameters

• executeOncePrefix : The method prefix to use for generated methods that execute once.

• executeOnceSuffix : The method suffix to use for generated methods that execute once.

• name : The name of the SQL statement

• parameters : The parameters of the SQL statement.

• repository : The fully qualified name of the target repository class.

• resultRowConverter : The fully-qualified name of the converter class to use

• resultRowType : The fully-qualified name of a record to build each result row into

• returningMode : The returning mode of the SQL statement.

• throwOnMultipleResults : Throw an exception in case a statement using ReturningMode.SINGLE produces more than 1 result.

• type : The type of the SQL statement.

• vendor : The vendor name of the database the SQL statement is intended for

• writesReturnUpdateCount : Writing method which are using ReturningMode.NONE return the number of affected rows instead.

Front Matter

In order to configure this option, place the following code in the front matter of your SQL statement:

-- resultRowColumns: configValue
SELECT  something
FROM    your_database_schema
WHERE   some_column = :some_value