Package org.springframework.data.jdbc.repository.query

Annotation Interface Query

@Retention(RUNTIME) @Target(METHOD) @Documented public @interface Query
Annotation to provide SQL statements that will get used for executing the method. The SQL statement may contain named parameters as supported by NamedParameterJdbcTemplate. Those parameters will get bound to the arguments of the annotated method.

You can also specify the way to extract data from ResultSet. There are 4 attribute of this annotation you can set to do that:

  1. resultSetExtractorRef()
  2. resultSetExtractorClass()
  3. rowMapperRef()
  4. rowMapperClass()
The annotation attributes above are listed in their preference order, that is - the resultSetExtractorRef(), has the highest privilege and, will suppress any other 3 attribute from above, and consequently rowMapperClass() has the lowest privilege and will be used if any of three above are not specified.
Author:
Jens Schauder, Moises Cisneros, Hebert Coelho, Mikhail Polivakha

  • Element Details

    • value

      String value
      The SQL statement to execute when the annotated method gets invoked.
      Default:
      ""

    • name

      String name
      The named query to be used. If not defined, the name of ${domainClass}.${queryMethodName} will be used.
      Default:
      ""

    • rowMapperClass

      Class<? extends RowMapper> rowMapperClass
      Optional RowMapper to use to convert the result of the query to domain class instances.
      Default:
      org.springframework.jdbc.core.RowMapper.class

    • rowMapperRef

      String rowMapperRef
      Optional name of a bean of type RowMapper to use to convert the result of the query to domain class instances.
      Since:
      2.1
      Default:
      ""

    • resultSetExtractorClass

      Class<? extends ResultSetExtractor> resultSetExtractorClass
      Optional ResultSetExtractor to use to convert the result of the query to domain class instances.
      Default:
      org.springframework.jdbc.core.ResultSetExtractor.class

    • resultSetExtractorRef

      String resultSetExtractorRef
      Optional name of a bean of type ResultSetExtractor to use to convert the result of the query to domain class instances.
      Since:
      2.1
      Default:
      ""