ElasticsearchTemplate (esclientrhl 7.0.0 API)

所有已知实现类:

ElasticsearchTemplateImpl
```
public interface ElasticsearchTemplate<T,M>
```
program: esdemo description: Elasticsearch基础功能组件 author: X-Pacific zhang create: 2019-01-18 16:01

方法概要

所有方法实例方法抽象方法已过时的方法
限定符和类型	方法和说明
`org.elasticsearch.search.aggregations.Aggregations`	`aggs(org.elasticsearch.search.aggregations.AggregationBuilder aggregationBuilder, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz)` 通用（定制）聚合基础方法，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`org.elasticsearch.search.aggregations.Aggregations`	`aggs(org.elasticsearch.search.aggregations.AggregationBuilder aggregationBuilder, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String... indexs)` 通用（定制）聚合基础方法，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`double`	`aggs(String metricName, AggsType aggsType, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz)` 以aggstypes的方式metric度量，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`double`	`aggs(String metricName, AggsType aggsType, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String... indexs)` 以aggstypes的方式metric度量，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`Map`	`aggs(String metricName, AggsType aggsType, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String bucketName)` 普通聚合查询，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用以bucket分组以aggstypes的方式metric度量
`Map`	`aggs(String metricName, AggsType aggsType, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String bucketName, String... indexs)` 普通聚合查询，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`List<Down>`	`aggswith2level(String metricName, AggsType aggsType, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String[] bucketNames)` 下钻聚合查询(无排序默认策略)，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用以bucket分组以aggstypes的方式metric度量
`List<Down>`	`aggswith2level(String metricName, AggsType aggsType, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String[] bucketNames, String... indexs)` 下钻聚合查询(无排序默认策略)，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`org.elasticsearch.action.bulk.BulkResponse`	`batchUpdate(org.elasticsearch.index.query.QueryBuilder queryBuilder, T t, Class clazz, int limitcount, boolean asyn)` 根据queryBuilder所查结果，按照有值字段更新索引
`org.elasticsearch.action.bulk.BulkResponse`	`bulkUpdate(List<T> list)` 更新索引集合
`org.elasticsearch.action.bulk.BulkResponse[]`	`bulkUpdateBatch(List<T> list)` 更新索引集合（分批方式，提升性能，防止es服务内存溢出，每批默认5000条数据）
`long`	`cardinality(String metricName, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz)` 基数查询，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`long`	`cardinality(String metricName, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String... indexs)` 基数查询，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`List<String>`	`completionSuggest(String fieldName, String fieldValue, Class<T> clazz)` 搜索建议Completion Suggester
`List<String>`	`completionSuggest(String fieldName, String fieldValue, Class<T> clazz, String... indexs)` 搜索建议Completion Suggester
`long`	`count(org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz)` 查询数量
`long`	`count(org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String... indexs)` 查询数量(跨索引)
`ScrollResponse<T>`	`createScroll(org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, Long time, Integer size)` scroll方式查询，创建scroll
`ScrollResponse<T>`	`createScroll(org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, Long time, Integer size, String... indexs)` scroll方式查询，创建scroll
`Map`	`dateHistogramAggs(String metricName, AggsType aggsType, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String bucketName, org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval interval)` 日期直方图聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`Map`	`dateHistogramAggs(String metricName, AggsType aggsType, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String bucketName, org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval interval, String... indexs)` 日期直方图聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`boolean`	`delete(T t)` 删除索引
`boolean`	`delete(T t, String routing)` 删除索引（路由方式）
`org.elasticsearch.index.reindex.BulkByScrollResponse`	`deleteByCondition(org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz)` 根据条件删除索引 https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/java-rest-high-document-delete-by-query.html#java-rest-high-document-delete-by-query-response
`boolean`	`deleteById(M id, Class<T> clazz)` 删除索引
`boolean`	`exists(M id, Class<T> clazz)` id数据是否存在
`Map`	`filterAggs(String metricName, AggsType aggsType, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, org.elasticsearch.search.aggregations.bucket.filter.FiltersAggregator.KeyedFilter[] filters)` 过滤器聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用 new FiltersAggregator.KeyedFilter("men", QueryBuilders.termQuery("gender", "male"))
`Map`	`filterAggs(String metricName, AggsType aggsType, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, org.elasticsearch.search.aggregations.bucket.filter.FiltersAggregator.KeyedFilter[] filters, String... indexs)` 过滤器聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用 new FiltersAggregator.KeyedFilter("men", QueryBuilders.termQuery("gender", "male"))
`T`	`getById(M id, Class<T> clazz)` 根据ID查询
`Map`	`histogramAggs(String metricName, AggsType aggsType, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String bucketName, double interval)` 直方图聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`Map`	`histogramAggs(String metricName, AggsType aggsType, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String bucketName, double interval, String... indexs)` 直方图聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`List<T>`	`mgetById(M[] ids, Class<T> clazz)` 根据ID列表批量查询
`Map`	`percentileRanksAggs(String metricName, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, double[] customSegment)` 以百分等级聚合 (统计在多少数值之内占比多少)，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`Map`	`percentileRanksAggs(String metricName, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, double[] customSegment, String... indexs)` 以百分等级聚合 (统计在多少数值之内占比多少)，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`Map`	`percentilesAggs(String metricName, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz)` 百分比聚合默认聚合见Constant.DEFAULT_PERCSEGMENT，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`Map`	`percentilesAggs(String metricName, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, double[] customSegment, String... indexs)` 以百分比聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`List<String>`	`phraseSuggest(String fieldName, String fieldValue, ElasticsearchTemplateImpl.PhraseSuggestParam param, Class<T> clazz)` 搜索建议phrase Suggester https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html
`List<String>`	`phraseSuggest(String fieldName, String fieldValue, ElasticsearchTemplateImpl.PhraseSuggestParam param, Class<T> clazz, String... indexs)` 搜索建议phrase Suggester https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html
`String`	`queryBySQL(String sql, SqlFormat sqlFormat)` 通过sql进行查询
`ScrollResponse<T>`	`queryScroll(Class<T> clazz, Long time, String scrollId)` scroll方式查询
`org.elasticsearch.client.Response`	`request(org.elasticsearch.client.Request request)` 通过Low Level REST Client 查询 https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/java-rest-low-usage-requests.html
`org.elasticsearch.action.bulk.BulkResponse`	`save(List<T> list)` 新增索引集合
`boolean`	`save(T t)` 新增索引
`boolean`	`save(T t, String routing)` 新增索引（路由方式）
`org.elasticsearch.action.bulk.BulkResponse[]`	`saveBatch(List<T> list)` 新增索引集合（分批方式，提升性能，防止es服务内存溢出，每批默认5000条数据）
`org.elasticsearch.client.Response`	`saveTemplate(String templateName, String templateSource)` 保存Template
`List<T>`	`scroll(org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz)` 已过时。
`List<T>`	`scroll(org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, Long time, String... indexs)` 已过时。
`PageList<T>`	`search(org.elasticsearch.index.query.QueryBuilder queryBuilder, Attach attach, Class<T> clazz)` 支持分页、高亮、排序、指定返回字段、路由的查询
`PageList<T>`	`search(org.elasticsearch.index.query.QueryBuilder queryBuilder, Attach attach, Class<T> clazz, String... indexs)` 支持分页、高亮、排序、指定返回字段、路由的查询（跨索引）
`List<T>`	`search(org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz)` 非分页查询
`List<T>`	`search(org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String... indexs)` 非分页查询(跨索引)
`PageList<T>`	`search(org.elasticsearch.index.query.QueryBuilder queryBuilder, PageSortHighLight pageSortHighLight, Class<T> clazz)` 支持分页、高亮、排序的查询
`PageList<T>`	`search(org.elasticsearch.index.query.QueryBuilder queryBuilder, PageSortHighLight pageSortHighLight, Class<T> clazz, String... indexs)` 支持分页、高亮、排序的查询（跨索引）
`org.elasticsearch.action.search.SearchResponse`	`search(org.elasticsearch.action.search.SearchRequest searchRequest)` 原生查询
`List<T>`	`searchMore(org.elasticsearch.index.query.QueryBuilder queryBuilder, int limitSize, Class<T> clazz)` 非分页查询，指定最大返回条数
`List<T>`	`searchMore(org.elasticsearch.index.query.QueryBuilder queryBuilder, int limitSize, Class<T> clazz, String... indexs)` 非分页查询(跨索引)，指定最大返回条数
`List<T>`	`searchTemplate(Map<String,Object> template_params, String templateName, Class<T> clazz)` Template方式搜索，Template已经保存在script目录下
`List<T>`	`searchTemplateBySource(Map<String,Object> template_params, String templateSource, Class<T> clazz)` Template方式搜索，Template内容以参数方式传入
`List<T>`	`searchUri(String uri, Class<T> clazz)` 通过uri querystring进行查询
`org.elasticsearch.search.aggregations.metrics.Stats`	`statsAggs(String metricName, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz)` 统计聚合metric度量，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`org.elasticsearch.search.aggregations.metrics.Stats`	`statsAggs(String metricName, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String... indexs)` 统计聚合metric度量，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`Map<String,org.elasticsearch.search.aggregations.metrics.Stats>`	`statsAggs(String metricName, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String bucketName)` 以bucket分组，统计聚合metric度量，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`Map<String,org.elasticsearch.search.aggregations.metrics.Stats>`	`statsAggs(String metricName, org.elasticsearch.index.query.QueryBuilder queryBuilder, Class<T> clazz, String bucketName, String... indexs)` 以bucket分组，统计聚合metric度量，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用
`boolean`	`update(T t)` 按照有值字段更新索引
`boolean`	`updateCover(T t)` 覆盖更新索引

方法详细资料

request
```
org.elasticsearch.client.Response request(org.elasticsearch.client.Request request)
                                   throws Exception
```
通过Low Level REST Client 查询 https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/java-rest-low-usage-requests.html

参数:

request - 原生查询对象

返回:

抛出:

Exception

save
```
boolean save(T t)
      throws Exception
```
新增索引

参数:

t - 索引pojo

抛出:

Exception

save
```
boolean save(T t,
             String routing)
      throws Exception
```
新增索引（路由方式）

参数:

t - 索引pojo

routing - 路由信息（默认路由为索引数据_id）

返回:

抛出:

Exception

save

org.elasticsearch.action.bulk.BulkResponse save(List<T> list)
                                         throws Exception

新增索引集合

参数:: list - 索引pojo集合
抛出:: Exception

saveBatch
```
org.elasticsearch.action.bulk.BulkResponse[] saveBatch(List<T> list)
                                                throws Exception
```
新增索引集合（分批方式，提升性能，防止es服务内存溢出，每批默认5000条数据）

参数:

list - 索引pojo集合

抛出:

Exception

bulkUpdate

org.elasticsearch.action.bulk.BulkResponse bulkUpdate(List<T> list)
                                               throws Exception

更新索引集合

参数:: list - 索引pojo集合
返回:
抛出:: Exception

bulkUpdateBatch
```
org.elasticsearch.action.bulk.BulkResponse[] bulkUpdateBatch(List<T> list)
                                                      throws Exception
```
更新索引集合（分批方式，提升性能，防止es服务内存溢出，每批默认5000条数据）

参数:

list - 索引pojo集合

返回:

抛出:

Exception

update
```
boolean update(T t)
        throws Exception
```
按照有值字段更新索引

参数:

t - 索引pojo

抛出:

Exception

batchUpdate

org.elasticsearch.action.bulk.BulkResponse batchUpdate(org.elasticsearch.index.query.QueryBuilder queryBuilder,
                                                       T t,
                                                       Class clazz,
                                                       int limitcount,
                                                       boolean asyn)
                                                throws Exception

根据queryBuilder所查结果，按照有值字段更新索引

参数:: queryBuilder - 查询条件（官方）; t - 索引pojo; clazz - 索引pojo类类型; limitcount - 更新字段不能超出limitcount; asyn - true异步处理否则同步处理
返回:
抛出:: Exception

updateCover
```
boolean updateCover(T t)
             throws Exception
```
覆盖更新索引

参数:

t - 索引pojo

抛出:

Exception

delete
```
boolean delete(T t)
        throws Exception
```
删除索引

参数:

t - 索引pojo

抛出:

Exception

delete
```
boolean delete(T t,
               String routing)
        throws Exception
```
删除索引（路由方式）

参数:

t - 索引pojo

routing - 路由信息（默认路由为索引数据_id）

返回:

抛出:

Exception

deleteByCondition

org.elasticsearch.index.reindex.BulkByScrollResponse deleteByCondition(org.elasticsearch.index.query.QueryBuilder queryBuilder,
                                                                       Class<T> clazz)
                                                                throws Exception

根据条件删除索引 https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/java-rest-high-document-delete-by-query.html#java-rest-high-document-delete-by-query-response

参数:: queryBuilder - 查询条件（官方）; clazz - 索引pojo类类型
返回:
抛出:: Exception

deleteById

boolean deleteById(M id,
                   Class<T> clazz)
            throws Exception

删除索引

参数:: id - 索引主键; clazz - 索引pojo类类型
返回:
抛出:: Exception

search

org.elasticsearch.action.search.SearchResponse search(org.elasticsearch.action.search.SearchRequest searchRequest)
                                               throws Exception

原生查询

参数:: searchRequest - 原生查询请求对象
返回:
抛出:: Exception

search

List<T> search(org.elasticsearch.index.query.QueryBuilder queryBuilder,
               Class<T> clazz)
        throws Exception

非分页查询

参数:: queryBuilder - 查询条件; clazz - 索引pojo类类型
返回:
抛出:: Exception

search

List<T> search(org.elasticsearch.index.query.QueryBuilder queryBuilder,
               Class<T> clazz,
               String... indexs)
        throws Exception

非分页查询(跨索引)

参数:: queryBuilder - 查询条件; clazz - 索引pojo类类型; indexs - 索引名称
返回:
抛出:: Exception

searchMore

List<T> searchMore(org.elasticsearch.index.query.QueryBuilder queryBuilder,
                   int limitSize,
                   Class<T> clazz)
            throws Exception

非分页查询，指定最大返回条数

参数:: queryBuilder - 查询条件; limitSize - 最大返回条数; clazz - 索引pojo类类型
返回:
抛出:: Exception

searchMore

List<T> searchMore(org.elasticsearch.index.query.QueryBuilder queryBuilder,
                   int limitSize,
                   Class<T> clazz,
                   String... indexs)
            throws Exception

非分页查询(跨索引)，指定最大返回条数

参数:: queryBuilder - 查询条件; limitSize - 最大返回条数; clazz - 索引pojo类类型; indexs - 索引名称
返回:
抛出:: Exception

searchUri
```
List<T> searchUri(String uri,
                  Class<T> clazz)
           throws Exception
```
通过uri querystring进行查询

参数:

uri - uri查询的查询条件

clazz - 索引pojo类类型

返回:

抛出:

Exception

queryBySQL
```
String queryBySQL(String sql,
                  SqlFormat sqlFormat)
           throws Exception
```
通过sql进行查询

参数:

sql - sql脚本（支持mysql语法）

sqlFormat - sql请求返回类型

返回:

抛出:

Exception

count

long count(org.elasticsearch.index.query.QueryBuilder queryBuilder,
           Class<T> clazz)
    throws Exception

查询数量

参数:: queryBuilder - 查询条件; clazz - 索引pojo类类型
返回:
抛出:: Exception

count

long count(org.elasticsearch.index.query.QueryBuilder queryBuilder,
           Class<T> clazz,
           String... indexs)
    throws Exception

查询数量(跨索引)

参数:: queryBuilder - 查询条件; clazz - 索引pojo类类型; indexs - 索引名称
返回:
抛出:: Exception

search

PageList<T> search(org.elasticsearch.index.query.QueryBuilder queryBuilder,
                   PageSortHighLight pageSortHighLight,
                   Class<T> clazz)
            throws Exception

支持分页、高亮、排序的查询

参数:: queryBuilder - 查询条件; pageSortHighLight - 分页+排序+高亮对象封装; clazz - 索引pojo类类型
返回:
抛出:: Exception

search

PageList<T> search(org.elasticsearch.index.query.QueryBuilder queryBuilder,
                   PageSortHighLight pageSortHighLight,
                   Class<T> clazz,
                   String... indexs)
            throws Exception

支持分页、高亮、排序的查询（跨索引）

参数:: queryBuilder - 查询条件; pageSortHighLight - 分页+排序+高亮对象封装; clazz - 索引pojo类类型; indexs - 索引名称
返回:
抛出:: Exception

search
```
PageList<T> search(org.elasticsearch.index.query.QueryBuilder queryBuilder,
                   Attach attach,
                   Class<T> clazz)
            throws Exception
```
支持分页、高亮、排序、指定返回字段、路由的查询

参数:

queryBuilder - 查询条件

attach - 查询增强对象（可支持分页、高亮、排序、指定返回字段、路由、searchAfter信息的定制）

clazz - 索引pojo类类型

返回:

抛出:

Exception

search
```
PageList<T> search(org.elasticsearch.index.query.QueryBuilder queryBuilder,
                   Attach attach,
                   Class<T> clazz,
                   String... indexs)
            throws Exception
```
支持分页、高亮、排序、指定返回字段、路由的查询（跨索引）

参数:

queryBuilder - 查询条件

attach - 查询增强对象（可支持分页、高亮、排序、指定返回字段、路由、searchAfter信息的定制）

clazz - 索引pojo类类型

indexs - 索引名称

返回:

抛出:

Exception

scroll
```
@Deprecated
List<T> scroll(org.elasticsearch.index.query.QueryBuilder queryBuilder,
                            Class<T> clazz)
                     throws Exception
```
已过时。

scroll方式查询(默认了保留时间为Constant.DEFAULT_SCROLL_TIME)，不推荐使用，数据量大时容易内存溢出

参数:

queryBuilder - 查询条件

clazz - 索引pojo类类型

返回:

抛出:

Exception

scroll

@Deprecated
List<T> scroll(org.elasticsearch.index.query.QueryBuilder queryBuilder,
                            Class<T> clazz,
                            Long time,
                            String... indexs)
                     throws Exception

已过时。

scroll方式查询，不推荐使用，数据量大时容易内存溢出

参数:: queryBuilder - 查询条件; clazz - 索引pojo类类型; time - scroll窗口时间，单位：小时; indexs - 索引名称
返回:
抛出:: Exception

createScroll

ScrollResponse<T> createScroll(org.elasticsearch.index.query.QueryBuilder queryBuilder,
                               Class<T> clazz,
                               Long time,
                               Integer size)
                        throws Exception

scroll方式查询，创建scroll

参数:: queryBuilder - 查询条件; clazz - 索引pojo类类型; time - scroll窗口时间，单位：小时; size - scroll查询每次查询条数
返回:
抛出:: Exception

createScroll

ScrollResponse<T> createScroll(org.elasticsearch.index.query.QueryBuilder queryBuilder,
                               Class<T> clazz,
                               Long time,
                               Integer size,
                               String... indexs)
                        throws Exception

scroll方式查询，创建scroll

参数:: queryBuilder - 查询条件; clazz - 索引pojo类类型; time - scroll窗口时间，单位：小时; size - scroll查询每次查询条数; indexs - 索引名称
返回:
抛出:: Exception

queryScroll

ScrollResponse<T> queryScroll(Class<T> clazz,
                              Long time,
                              String scrollId)
                       throws Exception

scroll方式查询

参数:: clazz - 索引pojo类类型; time - scroll窗口时间，单位：小时; scrollId - scroll查询id，from ScrollResponse
返回:
抛出:: Exception

searchTemplate

List<T> searchTemplate(Map<String,Object> template_params,
                       String templateName,
                       Class<T> clazz)
                throws Exception

Template方式搜索，Template已经保存在script目录下

参数:: template_params - 模版参数; templateName - 模版名称; clazz - 索引pojo类类型
返回:
抛出:: Exception

searchTemplateBySource

List<T> searchTemplateBySource(Map<String,Object> template_params,
                               String templateSource,
                               Class<T> clazz)
                        throws Exception

Template方式搜索，Template内容以参数方式传入

参数:: template_params - 模版参数; templateSource - 模版内容; clazz - 索引pojo类类型
返回:
抛出:: Exception

saveTemplate

org.elasticsearch.client.Response saveTemplate(String templateName,
                                               String templateSource)
                                        throws Exception

保存Template

参数:: templateName - 模版名称; templateSource - 模版内容
返回:
抛出:: Exception

completionSuggest

List<String> completionSuggest(String fieldName,
                               String fieldValue,
                               Class<T> clazz)
                        throws Exception

搜索建议Completion Suggester

参数:: fieldName - 搜索建议对应查询字段; fieldValue - 搜索建议查询条件; clazz - 索引pojo类类型
返回:
抛出:: Exception

completionSuggest

List<String> completionSuggest(String fieldName,
                               String fieldValue,
                               Class<T> clazz,
                               String... indexs)
                        throws Exception

搜索建议Completion Suggester

参数:: fieldName - 搜索建议对应查询字段; fieldValue - 搜索建议查询条件; clazz - 索引pojo类类型; indexs - 索引名称
返回:
抛出:: Exception

phraseSuggest

List<String> phraseSuggest(String fieldName,
                           String fieldValue,
                           ElasticsearchTemplateImpl.PhraseSuggestParam param,
                           Class<T> clazz)
                    throws Exception

搜索建议phrase Suggester https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html

参数:: fieldName - 搜索建议对应查询字段; fieldValue - 搜索建议查询条件; param - 定制Phrace Suggester的参数; clazz - 索引pojo类类型
返回:
抛出:: Exception

phraseSuggest

List<String> phraseSuggest(String fieldName,
                           String fieldValue,
                           ElasticsearchTemplateImpl.PhraseSuggestParam param,
                           Class<T> clazz,
                           String... indexs)
                    throws Exception

搜索建议phrase Suggester https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html

参数:: fieldName - 搜索建议对应查询字段; fieldValue - 搜索建议查询条件; param - 定制Phrace Suggester的参数; clazz - 索引pojo类类型; indexs - 索引名称
返回:
抛出:: Exception

getById
```
T getById(M id,
          Class<T> clazz)
   throws Exception
```
根据ID查询

参数:

id - 索引数据id值

clazz - 索引pojo类类型

返回:

抛出:

Exception

mgetById
```
List<T> mgetById(M[] ids,
                 Class<T> clazz)
          throws Exception
```
根据ID列表批量查询

参数:

ids - 索引数据id值数组

clazz - 索引pojo类类型

返回:

抛出:

Exception

exists
```
boolean exists(M id,
               Class<T> clazz)
        throws Exception
```
id数据是否存在

参数:

id - 索引数据id值

clazz - 索引pojo类类型

返回:

抛出:

Exception

aggs
```
Map aggs(String metricName,
         AggsType aggsType,
         org.elasticsearch.index.query.QueryBuilder queryBuilder,
         Class<T> clazz,
         String bucketName)
  throws Exception
```
普通聚合查询，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用以bucket分组以aggstypes的方式metric度量

参数:

metricName - 度量字段名称

aggsType - 度量类型

queryBuilder - 查询条件

clazz - 索引pojo类类型

bucketName - 分桶字段名称

返回:

抛出:

Exception

aggs
```
Map aggs(String metricName,
         AggsType aggsType,
         org.elasticsearch.index.query.QueryBuilder queryBuilder,
         Class<T> clazz,
         String bucketName,
         String... indexs)
  throws Exception
```
普通聚合查询，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:

metricName - 度量字段名称

aggsType - 度量类型

queryBuilder - 查询条件

clazz - 索引pojo类类型

bucketName - 分桶字段名称

indexs - 索引名称

返回:

抛出:

Exception

aggs
```
double aggs(String metricName,
            AggsType aggsType,
            org.elasticsearch.index.query.QueryBuilder queryBuilder,
            Class<T> clazz)
     throws Exception
```
以aggstypes的方式metric度量，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:

metricName - 度量字段名称

aggsType - 度量类型

queryBuilder - 查询条件

clazz - 索引pojo类类型

返回:

抛出:

Exception

aggs
```
double aggs(String metricName,
            AggsType aggsType,
            org.elasticsearch.index.query.QueryBuilder queryBuilder,
            Class<T> clazz,
            String... indexs)
     throws Exception
```
以aggstypes的方式metric度量，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:

metricName - 度量字段名称

aggsType - 度量类型

queryBuilder - 查询条件

clazz - 索引pojo类类型

indexs - 索引名称

返回:

抛出:

Exception

aggswith2level

List<Down> aggswith2level(String metricName,
                          AggsType aggsType,
                          org.elasticsearch.index.query.QueryBuilder queryBuilder,
                          Class<T> clazz,
                          String[] bucketNames)
                   throws Exception

下钻聚合查询(无排序默认策略)，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用以bucket分组以aggstypes的方式metric度量

参数:: metricName - 度量字段名称; aggsType - 度量类型; queryBuilder - 查询条件; clazz - 索引pojo类类型; bucketNames - 分桶字段名称
返回:
抛出:: Exception

aggswith2level

List<Down> aggswith2level(String metricName,
                          AggsType aggsType,
                          org.elasticsearch.index.query.QueryBuilder queryBuilder,
                          Class<T> clazz,
                          String[] bucketNames,
                          String... indexs)
                   throws Exception

下钻聚合查询(无排序默认策略)，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: metricName - 度量字段名称; aggsType - 度量类型; queryBuilder - 查询条件; clazz - 索引pojo类类型; bucketNames - 分桶字段名称; indexs - 索引名称
返回:
抛出:: Exception

statsAggs

org.elasticsearch.search.aggregations.metrics.Stats statsAggs(String metricName,
                                                              org.elasticsearch.index.query.QueryBuilder queryBuilder,
                                                              Class<T> clazz)
                                                       throws Exception

统计聚合metric度量，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: metricName - 度量字段名称; queryBuilder - 查询条件; clazz - 索引pojo类类型
返回:
抛出:: Exception

statsAggs

org.elasticsearch.search.aggregations.metrics.Stats statsAggs(String metricName,
                                                              org.elasticsearch.index.query.QueryBuilder queryBuilder,
                                                              Class<T> clazz,
                                                              String... indexs)
                                                       throws Exception

统计聚合metric度量，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: metricName - 度量字段名称; queryBuilder - 查询条件; clazz - 索引pojo类类型; indexs - 索引名称
返回:
抛出:: Exception

statsAggs

Map<String,org.elasticsearch.search.aggregations.metrics.Stats> statsAggs(String metricName,
                                                                          org.elasticsearch.index.query.QueryBuilder queryBuilder,
                                                                          Class<T> clazz,
                                                                          String bucketName)
                                                                   throws Exception

以bucket分组，统计聚合metric度量，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: metricName - 度量字段名称; queryBuilder - 查询条件; clazz - 索引pojo类类型; bucketName - 分桶字段名称
返回:
抛出:: Exception

statsAggs

Map<String,org.elasticsearch.search.aggregations.metrics.Stats> statsAggs(String metricName,
                                                                          org.elasticsearch.index.query.QueryBuilder queryBuilder,
                                                                          Class<T> clazz,
                                                                          String bucketName,
                                                                          String... indexs)
                                                                   throws Exception

以bucket分组，统计聚合metric度量，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: metricName - 度量字段名称; queryBuilder - 查询条件; clazz - 索引pojo类类型; bucketName - 分桶字段名称; indexs - 索引名称
返回:
抛出:: Exception

aggs

org.elasticsearch.search.aggregations.Aggregations aggs(org.elasticsearch.search.aggregations.AggregationBuilder aggregationBuilder,
                                                        org.elasticsearch.index.query.QueryBuilder queryBuilder,
                                                        Class<T> clazz)
                                                 throws Exception

通用（定制）聚合基础方法，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: aggregationBuilder - 原生聚合Builder; queryBuilder - 查询条件; clazz - 索引pojo类类型
返回:
抛出:: Exception

aggs

org.elasticsearch.search.aggregations.Aggregations aggs(org.elasticsearch.search.aggregations.AggregationBuilder aggregationBuilder,
                                                        org.elasticsearch.index.query.QueryBuilder queryBuilder,
                                                        Class<T> clazz,
                                                        String... indexs)
                                                 throws Exception

通用（定制）聚合基础方法，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: aggregationBuilder - 原生聚合Builder; queryBuilder - 查询条件; clazz - 索引pojo类类型; indexs - 索引名称
返回:
抛出:: Exception

cardinality
```
long cardinality(String metricName,
                 org.elasticsearch.index.query.QueryBuilder queryBuilder,
                 Class<T> clazz)
          throws Exception
```
基数查询，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:

metricName - 度量字段名称

queryBuilder - 查询条件

clazz - 索引pojo类类型

返回:

抛出:

Exception

cardinality

long cardinality(String metricName,
                 org.elasticsearch.index.query.QueryBuilder queryBuilder,
                 Class<T> clazz,
                 String... indexs)
          throws Exception

基数查询，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: metricName - 度量字段名称; queryBuilder - 查询条件; clazz - 索引pojo类类型; indexs - 索引名称
返回:
抛出:: Exception

percentilesAggs
```
Map percentilesAggs(String metricName,
                    org.elasticsearch.index.query.QueryBuilder queryBuilder,
                    Class<T> clazz)
             throws Exception
```
百分比聚合默认聚合见Constant.DEFAULT_PERCSEGMENT，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:

metricName - 度量字段名称

queryBuilder - 查询条件

clazz - 索引pojo类类型

返回:

抛出:

Exception

percentilesAggs

Map percentilesAggs(String metricName,
                    org.elasticsearch.index.query.QueryBuilder queryBuilder,
                    Class<T> clazz,
                    double[] customSegment,
                    String... indexs)
             throws Exception

以百分比聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: metricName - 度量字段名称; queryBuilder - 查询条件; clazz - 索引pojo类类型; customSegment - 百分比段位; indexs - 索引名称
返回:
抛出:: Exception

percentileRanksAggs
```
Map percentileRanksAggs(String metricName,
                        org.elasticsearch.index.query.QueryBuilder queryBuilder,
                        Class<T> clazz,
                        double[] customSegment)
                 throws Exception
```
以百分等级聚合 (统计在多少数值之内占比多少)，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:

metricName - 度量字段名称

queryBuilder - 查询条件

clazz - 索引pojo类类型

customSegment - 百分比段位

返回:

抛出:

Exception

percentileRanksAggs

Map percentileRanksAggs(String metricName,
                        org.elasticsearch.index.query.QueryBuilder queryBuilder,
                        Class<T> clazz,
                        double[] customSegment,
                        String... indexs)
                 throws Exception

以百分等级聚合 (统计在多少数值之内占比多少)，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: metricName - 度量字段名称; queryBuilder - 查询条件; clazz - 索引pojo类类型; customSegment - 百分比段位; indexs - 索引名称
返回:
抛出:: Exception

filterAggs
```
Map filterAggs(String metricName,
               AggsType aggsType,
               org.elasticsearch.index.query.QueryBuilder queryBuilder,
               Class<T> clazz,
               org.elasticsearch.search.aggregations.bucket.filter.FiltersAggregator.KeyedFilter[] filters)
        throws Exception
```
过滤器聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用 new FiltersAggregator.KeyedFilter("men", QueryBuilders.termQuery("gender", "male"))

参数:

metricName - 度量字段名称

aggsType - 度量类型

clazz - 索引pojo类类型

queryBuilder - 查询条件

filters - 分桶过滤器数组

返回:

抛出:

Exception

filterAggs

Map filterAggs(String metricName,
               AggsType aggsType,
               org.elasticsearch.index.query.QueryBuilder queryBuilder,
               Class<T> clazz,
               org.elasticsearch.search.aggregations.bucket.filter.FiltersAggregator.KeyedFilter[] filters,
               String... indexs)
        throws Exception

过滤器聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用 new FiltersAggregator.KeyedFilter("men", QueryBuilders.termQuery("gender", "male"))

参数:: metricName - 度量字段名称; aggsType - 度量类型; clazz - 索引pojo类类型; queryBuilder - 查询条件; filters - 分桶过滤器数组; indexs - 索引名称
返回:
抛出:: Exception

histogramAggs

Map histogramAggs(String metricName,
                  AggsType aggsType,
                  org.elasticsearch.index.query.QueryBuilder queryBuilder,
                  Class<T> clazz,
                  String bucketName,
                  double interval)
           throws Exception

直方图聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: metricName - 度量字段名称; aggsType - 度量类型; queryBuilder - 查询条件; clazz - 索引pojo类类型; bucketName - 分桶字段名称; interval - 分桶字段值的间隔
返回:
抛出:: Exception

histogramAggs

Map histogramAggs(String metricName,
                  AggsType aggsType,
                  org.elasticsearch.index.query.QueryBuilder queryBuilder,
                  Class<T> clazz,
                  String bucketName,
                  double interval,
                  String... indexs)
           throws Exception

直方图聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: metricName - 度量字段名称; aggsType - 度量类型; queryBuilder - 查询条件; clazz - 索引pojo类类型; bucketName - 分桶字段名称; interval - 分桶字段值的间隔; indexs - 索引名称
返回:
抛出:: Exception

dateHistogramAggs

Map dateHistogramAggs(String metricName,
                      AggsType aggsType,
                      org.elasticsearch.index.query.QueryBuilder queryBuilder,
                      Class<T> clazz,
                      String bucketName,
                      org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval interval)
               throws Exception

日期直方图聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: metricName - 度量字段名称; aggsType - 度量类型; queryBuilder - 查询条件; clazz - 索引pojo类类型; bucketName - 分桶字段名称; interval - 分桶日期字段值的间隔
返回:
抛出:: Exception

dateHistogramAggs

Map dateHistogramAggs(String metricName,
                      AggsType aggsType,
                      org.elasticsearch.index.query.QueryBuilder queryBuilder,
                      Class<T> clazz,
                      String bucketName,
                      org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval interval,
                      String... indexs)
               throws Exception

日期直方图聚合，请结合 https://gitee.com/zxporz/ESClientRHL/wikis/Elasticsearch-ESClientRHL 使用

参数:: metricName - 度量字段名称; aggsType - 度量类型; queryBuilder - 查询条件; clazz - 索引pojo类类型; bucketName - 分桶字段名称; interval - 分桶日期字段值的间隔; indexs - 索引名称
返回:
抛出:: Exception

接口 ElasticsearchTemplate<T,M>

方法概要

方法详细资料

request

save

save

save

saveBatch

bulkUpdate

bulkUpdateBatch

update

batchUpdate

updateCover

delete

delete

deleteByCondition

deleteById

search

search

search

searchMore

searchMore

searchUri

queryBySQL

count

count

search

search

search

search

scroll

scroll

createScroll

createScroll

queryScroll

searchTemplate

searchTemplateBySource

saveTemplate

completionSuggest

completionSuggest

phraseSuggest

phraseSuggest

getById

mgetById

exists

aggs

aggs

aggs

aggs

aggswith2level

aggswith2level

statsAggs

statsAggs

statsAggs

statsAggs

aggs

aggs

cardinality

cardinality

percentilesAggs

percentilesAggs

percentileRanksAggs

percentileRanksAggs

filterAggs

filterAggs

histogramAggs

histogramAggs

dateHistogramAggs

dateHistogramAggs