此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Data Elasticsearch 5.3.4spring-doc.cn

此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Data Elasticsearch 5.3.4spring-doc.cn

查询查找策略

Elasticsearch 模块支持所有基本的查询构建功能,如字符串查询、原生搜索查询、基于条件的查询,或者从方法名称派生。spring-doc.cn

声明的查询

从方法名称派生查询并不总是足够的,并且/或可能导致方法名称不可读。 在这种情况下,可以使用注释(请参阅 使用 @Query Comments )。@Queryspring-doc.cn

查询创建

通常,Elasticsearch 的查询创建机制的工作方式如 定义查询方法. 下面是一个简短的示例,说明了 Elasticsearch 查询方法的转换方式:spring-doc.cn

示例 1.从方法名称创建查询
interface BookRepository extends Repository<Book, String> {
  List<Book> findByNameAndPrice(String name, Integer price);
}

上面的方法名称将转换为以下 Elasticsearch json 查询spring-doc.cn

{
    "query": {
        "bool" : {
            "must" : [
                { "query_string" : { "query" : "?", "fields" : [ "name" ] } },
                { "query_string" : { "query" : "?", "fields" : [ "price" ] } }
            ]
        }
    }
}

Elasticsearch 支持的关键字列表如下所示。spring-doc.cn

表 1.方法名称内支持的关键字
关键词 样本 Elasticsearch 查询字符串

Andspring-doc.cn

findByNameAndPricespring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "?", "fields" : [ "name" ] } }, { "query_string" : { "query" : "?", "fields" : [ "price" ] } } ] } }}spring-doc.cn

Orspring-doc.cn

findByNameOrPricespring-doc.cn

{ "query" : { "bool" : { "should" : [ { "query_string" : { "query" : "?", "fields" : [ "name" ] } }, { "query_string" : { "query" : "?", "fields" : [ "price" ] } } ] } }}spring-doc.cn

Isspring-doc.cn

findByNamespring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "?", "fields" : [ "name" ] } } ] } }}spring-doc.cn

Notspring-doc.cn

findByNameNotspring-doc.cn

{ "query" : { "bool" : { "must_not" : [ { "query_string" : { "query" : "?", "fields" : [ "name" ] } } ] } }}spring-doc.cn

Betweenspring-doc.cn

findByPriceBetweenspring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : ?, "to" : ?, "include_lower" : true, "include_upper" : true } } } ] } }}spring-doc.cn

LessThanspring-doc.cn

findByPriceLessThanspring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : null, "to" : ?, "include_lower" : true, "include_upper" : false } } } ] } }}spring-doc.cn

LessThanEqualspring-doc.cn

findByPriceLessThanEqualspring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : null, "to" : ?, "include_lower" : true, "include_upper" : true } } } ] } }}spring-doc.cn

GreaterThanspring-doc.cn

findByPriceGreaterThanspring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : ?, "to" : null, "include_lower" : false, "include_upper" : true } } } ] } }}spring-doc.cn

GreaterThanEqualspring-doc.cn

findByPriceGreaterThanEqualspring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : ?, "to" : null, "include_lower" : true, "include_upper" : true } } } ] } }}spring-doc.cn

Beforespring-doc.cn

findByPriceBeforespring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : null, "to" : ?, "include_lower" : true, "include_upper" : true } } } ] } }}spring-doc.cn

Afterspring-doc.cn

findByPriceAfterspring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : ?, "to" : null, "include_lower" : true, "include_upper" : true } } } ] } }}spring-doc.cn

Likespring-doc.cn

findByNameLikespring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "?*", "fields" : [ "name" ] }, "analyze_wildcard": true } ] } }}spring-doc.cn

StartingWithspring-doc.cn

findByNameStartingWithspring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "?*", "fields" : [ "name" ] }, "analyze_wildcard": true } ] } }}spring-doc.cn

EndingWithspring-doc.cn

findByNameEndingWithspring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "*?", "fields" : [ "name" ] }, "analyze_wildcard": true } ] } }}spring-doc.cn

Contains/Containingspring-doc.cn

findByNameContainingspring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "*?*", "fields" : [ "name" ] }, "analyze_wildcard": true } ] } }}spring-doc.cn

In(当批注为 FieldType.Keyword 时)spring-doc.cn

findByNameIn(Collection<String>names)spring-doc.cn

{ "query" : { "bool" : { "must" : [ {"bool" : {"must" : [ {"terms" : {"name" : ["?","?"]}} ] } } ] } }}spring-doc.cn

Inspring-doc.cn

findByNameIn(Collection<String>names)spring-doc.cn

{ "query": {"bool": {"must": [{"query_string":{"query": "\"?\" \"?\"", "fields": ["name"]}}]}}}spring-doc.cn

NotIn(当批注为 FieldType.Keyword 时)spring-doc.cn

findByNameNotIn(Collection<String>names)spring-doc.cn

{ "query" : { "bool" : { "must" : [ {"bool" : {"must_not" : [ {"terms" : {"name" : ["?","?"]}} ] } } ] } }}spring-doc.cn

NotInspring-doc.cn

findByNameNotIn(Collection<String>names)spring-doc.cn

{"query": {"bool": {"must": [{"query_string": {"query": "NOT(\"?\" \"?\")", "fields": ["name"]}}]}}}spring-doc.cn

Truespring-doc.cn

findByAvailableTruespring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "true", "fields" : [ "available" ] } } ] } }}spring-doc.cn

Falsespring-doc.cn

findByAvailableFalsespring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "false", "fields" : [ "available" ] } } ] } }}spring-doc.cn

OrderByspring-doc.cn

findByAvailableTrueOrderByNameDescspring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "true", "fields" : [ "available" ] } } ] } }, "sort":[{"name":{"order":"desc"}}] }spring-doc.cn

Existsspring-doc.cn

findByNameExistsspring-doc.cn

{"query":{"bool":{"must":[{"exists":{"field":"name"}}]}}}spring-doc.cn

IsNullspring-doc.cn

findByNameIsNullspring-doc.cn

{"query":{"bool":{"must_not":[{"exists":{"field":"name"}}]}}}spring-doc.cn

IsNotNullspring-doc.cn

findByNameIsNotNullspring-doc.cn

{"query":{"bool":{"must":[{"exists":{"field":"name"}}]}}}spring-doc.cn

IsEmptyspring-doc.cn

findByNameIsEmptyspring-doc.cn

{"query":{"bool":{"must":[{"bool":{"must":[{"exists":{"field":"name"}}],"must_not":[{"wildcard":{"name":{"wildcard":"*"}}}]}}]}}}spring-doc.cn

IsNotEmptyspring-doc.cn

findByNameIsNotEmptyspring-doc.cn

{"query":{"bool":{"must":[{"wildcard":{"name":{"wildcard":"*"}}}]}}}spring-doc.cn

不支持用于构建采用参数的 Geo-shape 查询的方法名称。 如果您需要在存储库中使用此类函数,请在自定义存储库实现中使用 with。GeoJsonElasticsearchOperationsCriteriaQuery
表 1.方法名称内支持的关键字
关键词 样本 Elasticsearch 查询字符串

Andspring-doc.cn

findByNameAndPricespring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "?", "fields" : [ "name" ] } }, { "query_string" : { "query" : "?", "fields" : [ "price" ] } } ] } }}spring-doc.cn

Orspring-doc.cn

findByNameOrPricespring-doc.cn

{ "query" : { "bool" : { "should" : [ { "query_string" : { "query" : "?", "fields" : [ "name" ] } }, { "query_string" : { "query" : "?", "fields" : [ "price" ] } } ] } }}spring-doc.cn

Isspring-doc.cn

findByNamespring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "?", "fields" : [ "name" ] } } ] } }}spring-doc.cn

Notspring-doc.cn

findByNameNotspring-doc.cn

{ "query" : { "bool" : { "must_not" : [ { "query_string" : { "query" : "?", "fields" : [ "name" ] } } ] } }}spring-doc.cn

Betweenspring-doc.cn

findByPriceBetweenspring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : ?, "to" : ?, "include_lower" : true, "include_upper" : true } } } ] } }}spring-doc.cn

LessThanspring-doc.cn

findByPriceLessThanspring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : null, "to" : ?, "include_lower" : true, "include_upper" : false } } } ] } }}spring-doc.cn

LessThanEqualspring-doc.cn

findByPriceLessThanEqualspring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : null, "to" : ?, "include_lower" : true, "include_upper" : true } } } ] } }}spring-doc.cn

GreaterThanspring-doc.cn

findByPriceGreaterThanspring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : ?, "to" : null, "include_lower" : false, "include_upper" : true } } } ] } }}spring-doc.cn

GreaterThanEqualspring-doc.cn

findByPriceGreaterThanEqualspring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : ?, "to" : null, "include_lower" : true, "include_upper" : true } } } ] } }}spring-doc.cn

Beforespring-doc.cn

findByPriceBeforespring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : null, "to" : ?, "include_lower" : true, "include_upper" : true } } } ] } }}spring-doc.cn

Afterspring-doc.cn

findByPriceAfterspring-doc.cn

{ "query" : { "bool" : { "must" : [ {"range" : {"price" : {"from" : ?, "to" : null, "include_lower" : true, "include_upper" : true } } } ] } }}spring-doc.cn

Likespring-doc.cn

findByNameLikespring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "?*", "fields" : [ "name" ] }, "analyze_wildcard": true } ] } }}spring-doc.cn

StartingWithspring-doc.cn

findByNameStartingWithspring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "?*", "fields" : [ "name" ] }, "analyze_wildcard": true } ] } }}spring-doc.cn

EndingWithspring-doc.cn

findByNameEndingWithspring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "*?", "fields" : [ "name" ] }, "analyze_wildcard": true } ] } }}spring-doc.cn

Contains/Containingspring-doc.cn

findByNameContainingspring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "*?*", "fields" : [ "name" ] }, "analyze_wildcard": true } ] } }}spring-doc.cn

In(当批注为 FieldType.Keyword 时)spring-doc.cn

findByNameIn(Collection<String>names)spring-doc.cn

{ "query" : { "bool" : { "must" : [ {"bool" : {"must" : [ {"terms" : {"name" : ["?","?"]}} ] } } ] } }}spring-doc.cn

Inspring-doc.cn

findByNameIn(Collection<String>names)spring-doc.cn

{ "query": {"bool": {"must": [{"query_string":{"query": "\"?\" \"?\"", "fields": ["name"]}}]}}}spring-doc.cn

NotIn(当批注为 FieldType.Keyword 时)spring-doc.cn

findByNameNotIn(Collection<String>names)spring-doc.cn

{ "query" : { "bool" : { "must" : [ {"bool" : {"must_not" : [ {"terms" : {"name" : ["?","?"]}} ] } } ] } }}spring-doc.cn

NotInspring-doc.cn

findByNameNotIn(Collection<String>names)spring-doc.cn

{"query": {"bool": {"must": [{"query_string": {"query": "NOT(\"?\" \"?\")", "fields": ["name"]}}]}}}spring-doc.cn

Truespring-doc.cn

findByAvailableTruespring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "true", "fields" : [ "available" ] } } ] } }}spring-doc.cn

Falsespring-doc.cn

findByAvailableFalsespring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "false", "fields" : [ "available" ] } } ] } }}spring-doc.cn

OrderByspring-doc.cn

findByAvailableTrueOrderByNameDescspring-doc.cn

{ "query" : { "bool" : { "must" : [ { "query_string" : { "query" : "true", "fields" : [ "available" ] } } ] } }, "sort":[{"name":{"order":"desc"}}] }spring-doc.cn

Existsspring-doc.cn

findByNameExistsspring-doc.cn

{"query":{"bool":{"must":[{"exists":{"field":"name"}}]}}}spring-doc.cn

IsNullspring-doc.cn

findByNameIsNullspring-doc.cn

{"query":{"bool":{"must_not":[{"exists":{"field":"name"}}]}}}spring-doc.cn

IsNotNullspring-doc.cn

findByNameIsNotNullspring-doc.cn

{"query":{"bool":{"must":[{"exists":{"field":"name"}}]}}}spring-doc.cn

IsEmptyspring-doc.cn

findByNameIsEmptyspring-doc.cn

{"query":{"bool":{"must":[{"bool":{"must":[{"exists":{"field":"name"}}],"must_not":[{"wildcard":{"name":{"wildcard":"*"}}}]}}]}}}spring-doc.cn

IsNotEmptyspring-doc.cn

findByNameIsNotEmptyspring-doc.cn

{"query":{"bool":{"must":[{"wildcard":{"name":{"wildcard":"*"}}}]}}}spring-doc.cn

不支持用于构建采用参数的 Geo-shape 查询的方法名称。 如果您需要在存储库中使用此类函数,请在自定义存储库实现中使用 with。GeoJsonElasticsearchOperationsCriteriaQuery

方法返回类型

可以将存储库方法定义为具有以下返回类型,用于返回多个 Element:spring-doc.cn

使用 @Query 注释

示例 2.使用注释在方法上声明 query。@Query

传递给该方法的参数可以插入到查询字符串的占位符中。占位符的格式为 , , 等,用于第一个、第二个、第三个参数等。?0?1?2spring-doc.cn

interface BookRepository extends ElasticsearchRepository<Book, String> {
    @Query("{\"match\": {\"name\": {\"query\": \"?0\"}}}")
    Page<Book> findByName(String name,Pageable pageable);
}

设置为 annotation 参数的 String 必须是有效的 Elasticsearch JSON 查询。 它将作为 query 元素的值发送到 Easticsearch;例如,如果使用参数 John 调用函数,它将生成以下查询正文:spring-doc.cn

{
  "query": {
    "match": {
      "name": {
        "query": "John"
      }
    }
  }
}
例 3. 对采用 Collection 参数的方法的注释@Query

存储库方法(如spring-doc.cn

@Query("{\"ids\": {\"values\": ?0 }}")
List<SampleEntity> getByIds(Collection<String> ids);

将进行 IDs 查询以返回所有匹配的文档。因此,使用 of 调用该方法将生成查询正文List["id1", "id2", "id3"]spring-doc.cn

{
  "query": {
    "ids": {
      "values": ["id1", "id2", "id3"]
    }
  }
}