Cwikius-Spring/spring-data-elasticsearch
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-data-elasticsearch.git synced 2025-06-23 12:32:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

DATAES-758 - Fix documentation for @Query annotation.

Browse Source 
Original PR: #403
This commit is contained in:
Peter-Josef Meisch 2020-03-06 19:08:49 +01:00 committed by GitHub
parent 251adc1eec
commit ec214a009e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/main/asciidoc/reference/elasticsearch-repository-queries.adoc
View File

@ -274,7 +274,8 @@ Repository methods can be defined to have the following return types for returni
* `Stream<T>`
* `SearchHits<T>`
* `List<SearchHits<T>>`
* `Stream<>>SearchHit<T>>`
* `Stream<SearchHit<T>>`
* `SearchPage<T>`
[[elasticsearch.query-methods.at-query]]
== Using @Query Annotation
@ -284,8 +285,21 @@ Repository methods can be defined to have the following return types for returni
[source,java]
----
interface BookRepository extends ElasticsearchRepository<Book, String> {
@Query("{\"bool\" : {\"must\" : {\"field\" : {\"name\" : \"?0\"}}}}")
@Query("{\"match\": {\"name\": {\"query\": \"?0\"}}}")
Page<Book> findByName(String name,Pageable pageable);
}
----
The String that is set as the annotation argument must be a valid Elasticsearch JSON query. It will be sent to Easticsearch as value of the query element; if for example the function is called with the parameter _John_, it would produce the following query body:
[source,json]
----
{
"query": {
"match": {
"name": {
"query": "John"
}
}
}
}
----
====