annotations
Talks about:
<a class="post-tag post-tag-frontmatter" href="/tags/frontmatter">frontmatter</a>, and <a class="post-tag post-tag-sql" href="/tags/sql">sql</a>
The additional annotations to be placed on generated methods.
This list is empty by default and thus no annotations are added to generated methods.
Configuration Options
Option: ‘your.own.Annotation’
In order to add an annotation to the generated methods, specify its fully-qualified name.
package com.example.persistence;
import your.own.Annotation;
public class SomeRepository {
@Annotation
public void someMethod() {
// ... some code
}
// ... rest of generated code
}
Option: ‘your.other.Annotation’
In order to add an annotation with some member, specify name of the annotation member, its value, and its type. The type defaults to java.lang.String
.
package com.example.persistence;
import your.other.Annotation;
public class SomeRepository {
@Annotation(member = "value")
public void someMethod() {
// ... some code
}
// ... rest of generated code
}
Related Options
- 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 alias or fully-qualified name of the converter to use
- 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:
-- annotations:
-- - type: your.own.Annotation
-- members:
-- - key: someMember
-- value: this is your value
-- type: java.lang.String
-- - key: another
-- value: 5
-- type: int
-- - type: your.other.Annotation
-- members:
-- - key: value
-- value: yep
-- - type: some.annotation.WithoutMembers
SELECT something
FROM your_database_schema
WHERE some_column = :some_value