DATAJDBC-234 - Adds documentation.

Original pull request: #180.
This commit is contained in:
Jens Schauder
2020-01-08 15:37:45 +01:00
parent 09fd0fcbd6
commit 8420a564e7

View File

@@ -388,7 +388,7 @@ This section offers some specific information about the implementation and use o
[[jdbc.query-methods.strategies]]
=== Query Lookup Strategies
The JDBC module supports defining a query manually only as a String in a `@Query` annotation.
The JDBC module supports defining a query manually as a String in a `@Query` annotation or as named query in a property file.
Deriving a query from the name of the method is currently not supported.
[[jdbc.query-methods.at-query]]
@@ -413,6 +413,19 @@ NOTE: Spring fully supports Java 8s parameter name discovery based on the `-p
NOTE: Spring Data JDBC supports only named parameters.
[[jdbc.query-methods.named-query]]
=== Named Queries
If no query is given in an annotation as described in the previous section Spring Data JDBC will try to locate a named query.
There are two ways how the name of the query can be determined.
The default is to take the _domain class_ of the query, i.e. the aggregate root of the repository, take its simple name and append the name of the method separated by a `.`.
Alternatively the `@Query` annotation has a `name` attribute which can be used to specify the name of a query to be looked up.
Named queries are expected to be provided in the property file `META-INF/jdbc-named-queries.properties` on the classpath.
The location of that file may be changed by setting a value to `@EnableJdbcRepositories.namedQueriesLocation`.
[[jdbc.query-methods.at-query.custom-rowmapper]]
==== Custom `RowMapper`