ElasticSearch 使用说明
本章,我们主要讲解在.Net 中对Quick.ElasticSearch.Furion的使用进行介绍!
ElasticSearch 的官方客户端 API 文档地址:https://www.elastic.co/guide/en/elasticsearch/client/index.html
ElasticSearch 的官方客户端 API 文档地址(.Net,ElasticSearch8.x):https://www.elastic.co/guide/en/elasticsearch/client/net-api/current/index.html
ElasticSearch 的官方客户端 API 文档地址(.Net,ElasticSearch7.x):https://www.elastic.co/guide/en/elasticsearch/client/net-api/7.17/index.html
我们知道,在.Net 中有Elasticsearch.Net和NEST等组件可以对 ElasticSearch 服务端进行各种操作。
但是
,但是
,但是
,由于 ElasticSearch 提供的是各类 API 接口,并且查询参数(JSON)条件会有很深的嵌套,这就导致了Elasticsearch.Net和NEST等组件在使用的时候也有很深的内嵌条件,包括各种链式操作等,如果不是老手
使用难度非常大,为了降低使用难度,Quick.ElasticSearch.Furion组件由此诞生了。
为了更好更简单的在.Net Core 中使用 ElasticSearch,特此基于NEST封装了Quick.ElasticSearch.Furion组件。
- Quick.ElasticSearch.Furion:依赖于.Net6+、Furion
Quick.ElasticSearch.Furion 包地址为:https://www.nuget.org/packages/Quick.ElasticSearch.Furion
关于 Quick.ElasticSearch.Furion 的详细使用说明,如下所示:
1、🍹 更新日志
- 1.0.3
- 调整(简化)了方法
GetModelsAll
、GetModelsAllAsync
、GetModels
、GetModelsAsync
、GetModelsFields
和GetModelsFieldsAsync
的排序参数传入方式; - 调整了
InsertModels
和InsertModelsAsync
方法的内部实现,判断是否有添加失败采用了Errors
属性以及ItemsWithErrors
错误对象集合; - 增加了
InsertModelsBatch
方法,分批添加数据,适用于大批量添加数据的情况; - 调整了
GetGroupValues
、GetGroupValuesAsync
、GetGroupCount
、GetGroupCountAsync
、GetGroupCountSmma
、GetGroupCountSmmaAsync
、GetGroupsCount
、GetGroupsCountAsync
、GetGroupsDate
、GetGroupsDateAsync
、GetGroupsDateSmma
、GetGroupsDateSmmaAsync
、GetGroupsDateSub
、GetGroupsDateSubAsync
、GetStatiCount
、GetStatiCountAsync
、GetStatiSumMulti
和GetStatiSumMultiAsync
方法的内部实现; - 调整了
AddLike
扩展方式的实现方式为 Wildcard; - 增加了
AddIn
条件查询扩展方法,类似 SQL 的 IN 条件; - 对
GetStatiSumMulti
和GetStatiSumMultiAsync
方法进行了性能优化,减少了 Http 请求次数。
- 1.0.2
- 方法
GetGroupsCount
和GetGroupsCountAsync
增加了第三个参数,以便于用户自定义返回统计数量的 Key 名称,默认为:GroupCount; - 增加了获取
ElasticClient
客户端对象方法:GetClient
; - 增加获取所有索引的方法
GetIndexs
和GetIndexsAsync
; - 增加了根据主键 Id 修改一个或多个字段值的方法
UpdateModelFieldsById
和UpdateModelFieldsByIdAsync
; - 增加了根据查询条件修改一个或多个字段值的方法
UpdateModelFieldsByCon
和UpdateModelFieldsByConAsync
; - 增加了根据 Id 字段获取一条数据的方法
GetModel
和GetModelAsync
; - 调整了
InsertModels
和InsertModelsAsync
方法的实现,由原来的Bulk(BulkAsync)
调整为了IndexMany(IndexManyAsync)
方式。
- 1.0.1
- 增加了扩展方法 CreateEsQueryModel 和 AddEsQueryModel;
- 重写了查询条件的使用方式;
- 将所有涉及到查询条件的方法都进行了调整;
- 简化了
GetStatiSumMulti
和GetStatiSumMultiAsync
方法所需参数的传入方式; - 方法
GetStatiSumMulti
和GetStatiSumMultiAsync
增加了第三个参数,错误回调方法。
- 1.0.0
- 全新组件重磅发布;
- 支持切换连接功能;
- 支持检查创建删除索引;
- 支持获取索引健康状态;
- 支持添加数据;
- 支持修改数据;
- 支持删除数据;
- 支持获取数据;
- 支持分组统计查询;
- 支持获取总条数、最大、最小、求和或平均值等。
2、🍟 Quick.ElasticSearch.Furion 使用说明
该组件是基于NEST
和Furion
组件进行封装使用的,目的在于结合.Net Core 更快、更简单和更灵活的使用 ElasticSearch!!!
组件使用对比:
假设我们要实现如下数据格式的统计:
使用 Quick.ElasticSearch.Furion 组件的代码如下:
使用 NEST 组件的代码如下:
由此可见,NEST 使用的复杂程度,更不用说 ElasticSearch.Net 了。
功能说明:
- 根据配置文件读取 ElasticSearch 连接的各个配置(如:ElasticSearch 服务地址、账号和密码等);
- 支持配置多个 ElasticSearch 的连接配置;
- 支持动态切换 ElasticSearch 的连接配置;
- 支持检查创建删除索引;
- 支持获取索引健康状态;
- 支持添加数据(单条、多条);
- 支持修改数据(单条、多条);
- 支持删除数据(根据 Id 删除、根据条件删除);
- 支持获取数据(获取所有数据、获取所有满足条件的数据、获取所有满足条件并返回指定字段的数据、根据 Id 获取一条数据、获取分页的数据、获取分页并返回指定字段的数据);
- 支持分组统计查询(统计单字段并返回该字段所有统计值、统计单字段并返回该字段所有统计值及对应的数量、统计单段并返回另一个字段的总和最大值最小值和平均值、统计多个字段并返回多个字段对应的值以及对应分组的数据数量、按月统计并返回每个月及其数量、获取分组统计数据【日期字段分组,支持按年、季度、月份、星期、天、小时、分、秒等维度进行统计】、获取分组统计数据【日期字段分组,按月统计,并返回另一个字段的总和、最大值、最小值和平均值】、获取分组统计数据【日期字段分组,并返回另一个字段的总和、最大值、最小值和平均值】、获取分组统计数据【日期字段分组,按某年 1~12 月统计每个月的某个字段每个月的总和以及这一年的总和】、获取分组统计数据【日期字段分组,按月统计,并按照另一个字段进行分组,统计其条数、总和、最大值、最小值和平均值】、获取分组统计数据【日期字段分组,并按照另一个字段进行分组,统计其条数、总和、最大值、最小值和平均值】);
- 支持获取总条数、最大、最小、求和或平均值等(获取符合条件的数据总条数、获取某字段的最大值最小值求和平均值和总数等、获取某些字段相加的多个总和)。
3、🍖 安装
安装命令如下所示:
该组件的命名空间为:Quick.ElasticSearch
。
4、🧀 配置
4.1、🥞 配置appsettings.json
在appsettings.json
配置文件中创建节点QuickElasticSearch
>MaxQueryCount
和QuickElasticSearchConfigs
,MaxQueryCount 为 ElasticSearch 索引查询的最大条数(ElasticSearch 内部默认为 10000),QuickElasticSearchConfigs 为数组类型(即可配置多个 ElasticSearch 服务地址),具体配置如下所示:
配置说明:
属性名称 | 属性说明 | 是否必填 | 备注 |
MaxQueryCount | 全局设置 ElasticSearch 索引查询的最大条数,ElasticSearch 默认为 10000 | 注意:此处我们最好设置为 2000000000,原因是 ElasticSearch 内部默认一次性最多返回 10000 条数据 | |
Default | 是否为默认连接 | 默认为 false | |
ConnId | 连接 Id(请确保该 Id 的唯一性) | √ | 如果要动态切换连接配置,请确保该 Id 有值并且唯一 |
DefaultIndex | 默认索引 | ||
UserName | 连接账户 | √ | |
Password | 连接密码 | √ | |
Uri | 连接地址集合,数据类型为 List<string> | √ |
4.2、🍞 实体特性
我们为实体提供了QuickElasticSearchConfig
特性,起作用是设置该实体的索引名称
和主键字段
,如下所示就是我们定义的一个实体对象:
说明:
- indexName:索引名称;
- primaryKey:主键名称。
4.3、🥐 配置 Program.cs
由于我们使用的是Furion,因此,我们可在程序启动文件中配置如下代码(具体可参考Furion 入门指南),目的是注册ElasticSearch 服务。
说明:上述的关键点就在于调用.AddElasticSearch()或者.AddElasticSearch<T>()方法对服务进行注册。
4.4、🍝 获取依赖注入对象
定义IQuickElasticSearch
对象(依赖注入方式):
5、🥪 具体使用
5.1、📮 获取 ElasticSearch 客户端
使用示例:
5.2、🌮 切换连接
使用示例:
5.3、🌯 获取检查创建删除索引
使用示例(获取所有索引):
使用示例(检查索引是否存在):
使用示例(创建索引):
使用示例(删除索引):
5.4、🥙 获取索引健康状态
使用示例(获取索引健康状态):
5.5、🧆 添加数据
使用示例(添加数据-单条):
使用示例(添加数据-多条):
使用示例(添加数据-多条,分批次):
5.6、🥗 修改数据
使用示例(修改数据-根据主键 Id 修改一个或多个字段的值):
使用示例(修改数据-根据查询条件修改一个或多个字段的值):
使用示例(修改数据-单条):
使用示例(修改数据-多条):
5.7、🥘 删除数据
使用示例(删除数据-根据 Id):
使用示例(删除数据-根据条件):
5.8、🍲 获取数据
使用示例(获取所有数据):
使用示例(获取匹配条件的所有数据):
使用示例(获取匹配条件的所有数据(返回指定字段的值)):
使用示例(获取一条数据-根据主键 Id 查询):
使用示例(获取一条数据-根据某字段查询):
使用示例(获取分页数据):
使用示例(获取分页数据-返回指定字段的值):
5.9、🥣 分组统计查询
使用示例(单个字段分组,并返回该字段的所有值集合):
使用示例(单个字段分组,并返回该字段的所有值和数量集合):
使用示例(单个字段分组,并返回另一个字段的总和、最大值、最小值和平均值):
使用示例(多个字段分组,并返回多个字段对应的值以及对应分组的数据数量):
使用示例(日期字段分组,按月统计):
使用示例(日期字段分组,支持按年、季度、月份、星期、天、小时、分、秒等维度进行统计):
使用示例(日期字段分组,按月统计,并返回另一个字段的总和、最大值、最小值和平均值):
使用示例(日期字段分组,并返回另一个字段的总和、最大值、最小值和平均值):
使用示例(日期字段分组,按某年 1~12 月统计每个月的某个字段每个月的总和以及这一年的总和):
使用示例(日期字段分组,按月统计,并按照另一个字段进行分组,统计其条数、总和、最大值、最小值和平均值):
使用示例(日期字段分组,并按照另一个字段进行分组,统计其条数、总和、最大值、最小值和平均值):
5.10、🍝 获取总条数、最大、最小、求和或平均值等
使用示例(获取符合条件的数据总条数):
使用示例(获取某字段的最大值、最小值、求和、平均值和总数等):
使用示例(获取某些字段相加的多个总和):
6、💎 Quick.ElasticSearch.Furion 方法
首先通过依赖注入在构造函数中得到IQuickElasticSearch
的实例,具体可参照上述文档中的相关示例。
6.1、📔 依赖注入方法
方法名称 | 方法说明 | 方法参数 | 备注 |
AddElasticSearch | 添加依赖注入服务 | 重载 1:() 重载 2:<T>() | 该方法为IServiceCollection的扩展方法,目的是实现 重载 1 代表注册的是IQuickElasticSearch服务; 重载 2 传入了泛型 T,代表的是注册了IQuickElasticSearch服务的同时,也注册了 T 这个服务(T这个泛型类中,在构造函数中实现了IQuickElasticSearch接口服务,该方法可能在控制台程序使用的情况较多)。 |
GetInstance | 获取某接口服务的实例 | 重载 1:() 重载 2:() | 该方法为IServiceProvider或IHost的扩展方法,目的是获取某接口或类的实例。 重载 1 是基于IServiceProvider的扩展; 重载 2 是基于IHost的扩展。 |
6.2、💸 获取 ElasticSearch 客户端
方法名称 | 方法说明 | 方法参数 | 返回值 | 备注 |
GetClient | 获取 ElasticSearch 客户端 | () | 返回 ElasticClient 对象 |
6.3、📕 切换连接方法
方法名称 | 方法说明 | 方法参数 | 返回值 | 备注 |
ChangeConn | 切换连接 | (int connId) | 无 | 切换配置文件中某个连接配置,connId 为连接 Id |
6.4、📗 获取检查创建删除索引方法
方法名称 | 方法说明 | 方法参数 | 返回值 | 备注 |
GetIndexs | 获取所有索引 | (bool isIncludeSystemIndex = false) | List<CatIndicesRecord> | isIncludeSystemIndex:是否包含系统索引 |
GetIndexsAsync | 获取所有索引(异步) | (bool isIncludeSystemIndex = false) | List<CatIndicesRecord> | isIncludeSystemIndex:是否包含系统索引 |
IndexIsExist | 检查索引是否存在 | (string indexName) | 返回 bool 类型 | indexName:索引名称 |
IndexIsExistAsync | 检查索引是否存在(异步) | (string indexName) | 返回 bool 类型 | indexName:索引名称 |
CreateIndex | 如果同名索引不存在则创建索引 | <T>(int numberOfReplicas = 0, int numberOfShards = 5) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | numberOfReplicas:默认副本数量,如果是单实例,注意改成 0 numberOfShards:默认分片数量 |
CreateIndexAsync | 如果同名索引不存在则创建索引(异步) | <T>(int numberOfReplicas = 0, int numberOfShards = 5) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | |
DeleteIndex | 删除索引 | (string indexName) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | indexName:索引名称 |
DeleteIndexAsync | 删除索引(异步) | (string indexName) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | indexName:索引名称 |
6.5、📘 获取索引健康状态方法
方法名称 | 方法说明 | 方法参数 | 返回值 | 备注 |
GetHealthStatus | 获取索引健康状态 | (string indexName) | 返回 Health 枚举对象(Green:0、Yellow:1、Red:2) | indexName:索引名称 |
GetHealthStatusAsync | 获取索引健康状态 | (string indexName) | 返回 Health 枚举对象(Green:0、Yellow:1、Red:2) | indexName:索引名称 |
6.6、📙 添加数据方法
方法名称 | 方法说明 | 方法参数 | 返回值 | 备注 |
InsertModel | 添加一条数据 | <T>(T docData) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 docData:数据 |
InsertModelAsync | 添加一条数据(异步) | <T>(T docData) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 docData:数据 |
InsertModels | 添加多条数据 | <T>(List<T> docDatas, Action<List<T>, string, List<T>>? insertError = null) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 docDatas:数据 insertError:错误回调方法(参数 1 为出错的数据集合,参数 2 为出错的提示信息,参数 3 为修改的所有数据集合) |
InsertModelsAsync | 添加多条数据(异步) | <T>(List<T> docDatas, Action<List<T>, string, List<T>>? insertError = null) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 docDatas:数据 insertError:错误回调方法(参数 1 为出错的数据集合,参数 2 为出错的提示信息,参数 3 为修改的所有数据集合) |
InsertModelsBatch | 添加多条数据(分批次) | <T>(List<T> docDatas, Action<List<T>, string, List<T>>? insertError = null, int? batchCount = 1000, string backOffTime = "30s", int? backOffRetries = 5) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 docDatas:数据 insertError:错误回调方法(参数 1 为出错的数据集合,参数 2 为出错的提示信息,参数 3 为修改的所有数据集合) batchCount:每批次添加的数据条数 backOffTime:集群繁忙,报 429 错误码的时候,等待多久进行重试,默认为:30s backOffRetries:重试次数,默认为:5 次 |
6.7、📚 修改数据方法
方法名称 | 方法说明 | 方法参数 | 返回值 | 备注 |
UpdateModelFieldsById | 根据主键 Id 修改一个或多个字段的值 | <T>(object id, object updateObj) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 id:主键 Id 值 updateObj:修改的动态对象,格式如:new { col1 = 123, col2 = 456},需要注意的是,填写的字段一定要和实体一致,如果修改的字段在数据中不存在,会自动增加这个字段的 |
UpdateModelFieldsByIdAsync | 根据主键 Id 修改一个或多个字段的值(异步) | <T>(object id, object updateObj) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 id:主键 Id 值 updateObj:修改的动态对象,格式如:new { col1 = 123, col2 = 456},需要注意的是,填写的字段一定要和实体一致,如果修改的字段在数据中不存在,会自动增加这个字段的 |
UpdateModelFieldsByCon | 根据查询条件修改一个或多个字段的值 | <T>(List<EsQueryModel<T>> esQueryList, object updateObj) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 esQueryList:动态查询条件 updateObj:修改的动态对象,格式如:new { col1 = 123, col2 = 456},需要注意的是,填写的字段一定要和实体一致,如果修改的字段在数据中不存在,会自动增加这个字段的 |
UpdateModelFieldsByConAsync | 根据查询条件修改一个或多个字段的值(异步) | <T>(List<EsQueryModel<T>> esQueryList, object updateObj) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 esQueryList:动态查询条件 updateObj:修改的动态对象,格式如:new { col1 = 123, col2 = 456},需要注意的是,填写的字段一定要和实体一致,如果修改的字段在数据中不存在,会自动增加这个字段的 |
UpdateModel | 修改一条数据 | <T>(T docData) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 docData:数据 |
UpdateModelAsync | 修改一条数据(异步) | <T>(T docData) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 docData:数据 |
UpdateModels | 修改多条数据 | <T>(List<T> docDatas, Action<List<T>, string, List<T>>? updateError = null) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 docDatas:数据 updateError:错误回调方法(参数 1 为出错的数据集合,参数 2 为出错的提示信息,参数 3 为修改的所有数据集合) |
UpdateModelsAsync | 修改多条数据(异步) | <T>(List<T> docDatas, Action<List<T>, string, List<T>>? updateError = null) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 docDatas:数据 updateError:错误回调方法(参数 1 为出错的数据集合,参数 2 为出错的提示信息,参数 3 为修改的所有数据集合) |
6.8、📓 删除数据方法
方法名称 | 方法说明 | 方法参数 | 返回值 | 备注 |
DeleteModel | 删除数据(根据 Id 字段) | <T>(object dataId) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 dataId:要删除的数据 ID |
DeleteModelAsync | 删除数据(根据 Id 字段,异步) | <T>(object dataId) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | T:泛型对象 dataId:要删除的数据 ID |
DeleteModelBy | 删除符合条件的所有数据 | <T>(List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | params:动态查询条件 |
DeleteModelByAsync | 删除符合条件的所有数据(异步) | <T>(List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 2 个值,第一个为是否成功,第二个为失败的提示信息 | params:动态查询条件 |
6.9、📒 获取数据方法
方法名称 | 方法说明 | 方法参数 | 返回值 | 备注 |
GetModelsAll | 获取所有数据 | <T>(Expression<Func<T, object>>? field = null, bool isDesc = true) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<T>的集合 | T:泛型对象 field:排序字段,格式如:m => m.OptTime isDesc:是否为降序(默认为降序) |
GetModelsAllAsync | 获取所有数据(异步) | <T>(Expression<Func<T, object>>? field = null, bool isDesc = true) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<T>的集合 | T:泛型对象 field:排序字段,格式如:m => m.OptTime isDesc:是否为降序(默认为降序) |
GetModels | 获取匹配条件的所有数据 | <T>(Expression<Func<T, object>>? field = null, bool isDesc = true, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<T>的集合 | T:泛型对象 field:排序字段,格式如:m => m.OptTime isDesc:是否为降序(默认为降序) esQueryList:动态查询条件 |
GetModelsAsync | 获取匹配条件的所有数据(异步) | <T>(Expression<Func<T, object>>? field = null, bool isDesc = true, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<T>的集合 | T:泛型对象 field:排序字段,格式如:m => m.OptTime isDesc:是否为降序(默认为降序) esQueryList:动态查询条件 |
GetModelsFields | 获取匹配条件的所有数据(返回指定字段的值) | <T>(List<string> speFields, Expression<Func<T, object>>? field = null, bool isDesc = true, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合 | T:泛型对象 speFields:只返回设置字段的值,如:new List<string> { "SampleId", "SampleName" } field:排序字段,格式如:m => m.OptTime isDesc:是否为降序(默认为降序) esQueryList:动态查询条件 |
GetModelsFieldsAsync | 获取匹配条件的所有数据(返回指定字段的值,异步) | <T>(List<string> speFields, Expression<Func<T, object>>? field = null, bool isDesc = true, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合 | T:泛型对象 speFields:只返回设置字段的值,如:new List<string> { "SampleId", "SampleName" } field:排序字段,格式如:m => m.OptTime isDesc:是否为降序(默认为降序) esQueryList:动态查询条件 |
GetModel | 获取一条数据(根据某字段执行等于查询) | <T>(Expression<Func<T, object>> field, object fieldVal) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 T 的数据对象 | T:泛型对象 field:查询的字段 fieldVal:查询的字段对应的值 |
GetModelAsync | 获取一条数据(根据某字段执行等于查询,异步) | <T>(Expression<Func<T, object>> field, object fieldVal) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 T 的数据对象 | T:泛型对象 field:查询的字段 fieldVal:查询的字段对应的值 |
GetPagerAsync | 获取分页数据 | <T>(EsPagerConModel esPagerCon, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 EsPagerModel<T>的数据对象 | T:泛型对象 esPagerCon:分页条件 esQueryList:动态查询条件 |
GetPagerAsync | 获取分页数据(异步) | <T>(EsPagerConModel esPagerCon, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 EsPagerModel<T>的数据对象 | T:泛型对象 esPagerCon:分页条件 esQueryList:动态查询条件 |
GetPagerFields | 获取分页数据(返回指定字段的值) | <T>(EsPagerConModel esPagerCon, List<string> speFields, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 EsPagerDicModel 的数据对象 | T:泛型对象 esPagerCon:分页条件 speFields:只返回设置字段的值,如:new List<string> { "SampleId", "SampleName" } esQueryList:动态查询条件 |
GetPagerFieldsAsync | 获取分页数据(返回指定字段的值,异步) | <T>(EsPagerConModel esPagerCon, List<string> speFields, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 EsPagerDicModel 的数据对象 | T:泛型对象 esPagerCon:分页条件 speFields:只返回设置字段的值,如:new List<string> { "SampleId", "SampleName" } esQueryList:动态查询条件 |
6.10、📋 分组统计查询方法
方法名称 | 方法说明 | 方法参数 | 返回值 | 备注 |
GetGroupValues | 单个字段分组,并返回该字段的所有值集合 | <T>(Expression<Func<T, object>> field, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<string>的集合,格式如:["分类 1","分类 2"] | T:泛型对象 field:要分组的字段,格式如:m=>m.col1 esQueryList:动态查询条件 |
GetGroupValuesAsync | 单个字段分组,并返回该字段的所有值集合,异步 | <T>(Expression<Func<T, object>> field, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<string>的集合,格式如:["分类 1","分类 2"] | T:泛型对象 field:要分组的字段,格式如:m=>m.col1 esQueryList:动态查询条件 |
GetGroupCount | 单个字段分组,并返回该字段的所有值和数量集合 | <T>(Expression<Func<T, object>> field, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"分类 1","Count":100}] | T:泛型对象 field:要分组的字段,格式如:m=>m.col1 esQueryList:动态查询条件 |
GetGroupCountAsync | 单个字段分组,并返回该字段的所有值和数量集合,异步 | <T>(Expression<Func<T, object>> field, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"分类 1","Count":100}] | T:泛型对象 field:要分组的字段,格式如:m=>m.col1 esQueryList:动态查询条件 |
GetGroupCountSmma | 单个字段分组,并返回另一个字段的总和、最大值、最小值和平均值 | <T>(Expression<Func<T, object>> field, Expression<Func<T, object>> fieldStati, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"分类 1","Count":100,"Sum":999,"Max":200,"Min":10,"Avg":105}] | T:泛型对象 field:要分组的字段,格式如:m=>m.col1 fieldStati:要统计总和、最大值、最小值和平均值的字段,格式如:m=>m.col2 esQueryList:动态查询条件 |
GetGroupCountSmmaAsync | 单个字段分组,并返回另一个字段的总和、最大值、最小值和平均值,异步 | <T>(Expression<Func<T, object>> field, Expression<Func<T, object>> fieldStati, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"分类 1","Count":100,"Sum":999,"Max":200,"Min":10,"Avg":105}] | T:泛型对象 field:要分组的字段,格式如:m=>m.col1 fieldStati:要统计总和、最大值、最小值和平均值的字段,格式如:m=>m.col2 esQueryList:动态查询条件 |
GetGroupsCount | 多个字段分组 | <T>(List<string> groupFields, List<EsQueryModel<T>>? esQueryList = null, string countKeyName = "GroupCount") | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"col1":"val1","col2":"val2","GroupCount":100}] | T:泛型对象 groupFields:要分组的字段集合,如:new List<string> { "col1", "col2" } esQueryList:动态查询条 countKeyName:返回统计数量的 Key 名称,默认为:GroupCount 件 |
GetGroupsCountAsync | 多个字段分组,异步 | <T>(List<string> groupFields, List<EsQueryModel<T>>? esQueryList = null, string countKeyName = "GroupCount") | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"col1":"val1","col2":"val2","GroupCount":100}] | T:泛型对象 groupFields:要分组的字段集合,如:new List<string> { "col1", "col2" } esQueryList:动态查询条 countKeyName:返回统计数量的 Key 名称,默认为:GroupCount 件 |
GetGroupsDateMonth | 日期字段分组,按月统计 | <T>(Expression<Func<T, object>> field, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"2021-01","Count":100}] | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime esQueryList:动态查询条件 |
GetGroupsDateMonthAsync | 日期字段分组,按月统计,异步 | <T>(Expression<Func<T, object>> field, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"2021-01","Count":100}] | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime esQueryList:动态查询条件 |
GetGroupsDate | 日期字段分组,支持按年、季度、月份、星期、天、小时、分、秒等维度进行统计 | <T>(Expression<Func<T, object>> field, string dateInterval = "1M", string dateFormat = "yyyy-MM", List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"2021-01","Count":100}] | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime dateInterval:统计的日期间隔,默认为 1M(支持的表达式有 1y:1 年、1q:1 季度、1M:1 个月、1w:1 星期、1d:1 天、1h:1 小时、1m:1 分钟、1s:1 秒钟) dateFormat:统计的日期格式化方式,默认为 yyyy-MM(注意大小写,完整的格式化格式为 yyyy-MM-dd HH:mm:ss) esQueryList:动态查询条件 |
GetGroupsDateAsync | 日期字段分组,支持按年、季度、月份、星期、天、小时、分、秒等维度进行统计,异步 | <T>(Expression<Func<T, object>> field, string dateInterval = "1M", string dateFormat = "yyyy-MM", List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"2021-01","Count":100}] | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime dateInterval:统计的日期间隔,默认为 1M(支持的表达式有 1y:1 年、1q:1 季度、1M:1 个月、1w:1 星期、1d:1 天、1h:1 小时、1m:1 分钟、1s:1 秒钟) dateFormat:统计的日期格式化方式,默认为 yyyy-MM(注意大小写,完整的格式化格式为 yyyy-MM-dd HH:mm:ss) esQueryList:动态查询条件 |
GetGroupsDateMonthSmma | 日期字段分组,按月统计,并返回另一个字段的总和、最大值、最小值和平均值 | <T>(Expression<Func<T, object>> field, Expression<Func<T, object>> fieldGroupStati, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"2021-01","Count":100,"Sum":999,"Max":200,"Min":10,"Avg":105}] | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime fieldGroupStati:要统计总和、最大值、最小值和平均值的字段,格式如:m=>m.Price esQueryList:动态查询条件 |
GetGroupsDateMonthSmmaAsync | 日期字段分组,按月统计,并返回另一个字段的总和、最大值、最小值和平均值,异步 | <T>(Expression<Func<T, object>> field, Expression<Func<T, object>> fieldGroupStati, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"2021-01","Count":100,"Sum":999,"Max":200,"Min":10,"Avg":105}] | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime fieldGroupStati:要统计总和、最大值、最小值和平均值的字段,格式如:m=>m.Price esQueryList:动态查询条件 |
GetGroupsDateSmma | 日期字段分组,并返回另一个字段的总和、最大值、最小值和平均值 | <T>(Expression<Func<T, object>> field, Expression<Func<T, object>> fieldGroupStati, string dateInterval = "1M", string dateFormat = "yyyy-MM", List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"2021-01","Count":100,"Sum":999,"Max":200,"Min":10,"Avg":105}] | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime fieldGroupStati:要统计总和、最大值、最小值和平均值的字段,格式如:m=>m.Price dateInterval:统计的日期间隔,默认为 1M(支持的表达式有 1y:1 年、1q:1 季度、1M:1 个月、1w:1 星期、1d:1 天、1h:1 小时、1m:1 分钟、1s:1 秒钟) dateFormat:统计的日期格式化方式,默认为 yyyy-MM(注意大小写,完整的格式化格式为 yyyy-MM-dd HH:mm:ss) esQueryList:动态查询条件 |
GetGroupsDateSmmaAsync | 日期字段分组,并返回另一个字段的总和、最大值、最小值和平均值,异步 | <T>(Expression<Func<T, object>> field, Expression<Func<T, object>> fieldGroupStati, string dateInterval = "1M", string dateFormat = "yyyy-MM", List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"2021-01","Count":100,"Sum":999,"Max":200,"Min":10,"Avg":105}] | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime fieldGroupStati:要统计总和、最大值、最小值和平均值的字段,格式如:m=>m.Price dateInterval:统计的日期间隔,默认为 1M(支持的表达式有 1y:1 年、1q:1 季度、1M:1 个月、1w:1 星期、1d:1 天、1h:1 小时、1m:1 分钟、1s:1 秒钟) dateFormat:统计的日期格式化方式,默认为 yyyy-MM(注意大小写,完整的格式化格式为 yyyy-MM-dd HH:mm:ss) esQueryList:动态查询条件 |
GetGroupsDateMonthOneYear | 日期字段分组,按某年 1~12 月统计每个月的某个字段每个月的总和以及这一年的总和 | <T>(Expression<Func<T, object>> field, Expression<Func<T, object>> fieldGroup, Expression<Func<T, object>> fieldGroupStati, int year, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为分组统计数组,格式如:[["小米",3006,0,0,0,1100,0,0,0,1200,0,0,0,5306]],其中第一个值为 fieldGroup 的分组名称;后面第二个到第十三个值为 1~12 月份的总和;第十四个值为 1~12 月份的总和 | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime fieldGroup:另一个要分组的字段,格式如:m=>m.TypeName fieldGroupStati:要统计总和、最大值、最小值和平均值的字段,格式如:m=>m.Price year:统计的年份,如 2021 esQueryList:动态查询条件 |
GetGroupsDateMonthOneYearAsync | 日期字段分组,按某年 1~12 月统计每个月的某个字段每个月的总和以及这一年的总和,异步 | <T>(Expression<Func<T, object>> field, Expression<Func<T, object>> fieldGroup, Expression<Func<T, object>> fieldGroupStati, int year, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为分组统计数组,格式如:[["小米",3006,0,0,0,1100,0,0,0,1200,0,0,0,5306]],其中第一个值为 fieldGroup 的分组名称;后面第二个到第十三个值为 1~12 月份的总和;第十四个值为 1~12 月份的总和 | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime fieldGroup:另一个要分组的字段,格式如:m=>m.TypeName fieldGroupStati:要统计总和、最大值、最小值和平均值的字段,格式如:m=>m.Price year:统计的年份,如 2021 esQueryList:动态查询条件 |
GetGroupsDateMonth | 日期字段分组,按月统计,并按照另一个字段进行分组,统计其条数、总和、最大值、最小值和平均值 | <T>(Expression<Func<T, object>> field, Expression<Func<T, object>> fieldGroup, Expression<Func<T, object>> fieldGroupStati, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"2021-01","Count":100,"Group":[{"Name":"碎石","Count":3,"Sum":1000,"Max":100,"Min":10,"Avg":50}]}] | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime fieldGroup:另一个要分组的字段,格式如:m=>m.TypeName fieldGroupStati:要统计总和、最大值、最小值和平均值的字段,格式如:m=>m.Price esQueryList:动态查询条件 |
GetGroupsDateMonthAsync | 日期字段分组,按月统计,并按照另一个字段进行分组,统计其条数、总和、最大值、最小值和平均值,异步 | <T>(Expression<Func<T, object>> field, Expression<Func<T, object>> fieldGroup, Expression<Func<T, object>> fieldGroupStati, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"2021-01","Count":100,"Group":[{"Name":"碎石","Count":3,"Sum":1000,"Max":100,"Min":10,"Avg":50}]}] | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime fieldGroup:另一个要分组的字段,格式如:m=>m.TypeName fieldGroupStati:要统计总和、最大值、最小值和平均值的字段,格式如:m=>m.Price esQueryList:动态查询条件 |
GetGroupsDateSub | 日期字段分组,并按照另一个字段进行分组,统计其条数、总和、最大值、最小值和平均值 | <T>(Expression<Func<T, object>> field, Expression<Func<T, object>> fieldGroup, Expression<Func<T, object>> fieldGroupStati, string dateInterval = "1M", string dateFormat = "yyyy-MM", List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"2021-01","Count":100,"Group":[{"Name":"碎石","Count":3,"Sum":1000,"Max":100,"Min":10,"Avg":50}]}] | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime fieldGroup:另一个要分组的字段,格式如:m=>m.TypeName fieldGroupStati:要统计总和、最大值、最小值和平均值的字段,格式如:m=>m.Price dateInterval:统计的日期间隔,默认为 1M(支持的表达式有 1y:1 年、1q:1 季度、1M:1 个月、1w:1 星期、1d:1 天、1h:1 小时、1m:1 分钟、1s:1 秒钟) dateFormat:统计的日期格式化方式,默认为 yyyy-MM(注意大小写,完整的格式化格式为 yyyy-MM-dd HH:mm:ss) esQueryList:动态查询条件 |
GetGroupsDateSubAsync | 日期字段分组,并按照另一个字段进行分组,统计其条数、总和、最大值、最小值和平均值,异步 | <T>(Expression<Func<T, object>> field, Expression<Func<T, object>> fieldGroup, Expression<Func<T, object>> fieldGroupStati, string dateInterval = "1M", string dateFormat = "yyyy-MM", List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为 List<Dictionary<string, object>>的集合,格式如:[{"Name":"2021-01","Count":100,"Group":[{"Name":"碎石","Count":3,"Sum":1000,"Max":100,"Min":10,"Avg":50}]}] | T:泛型对象 field:要分组的字段(日期字段),格式如:m=>m.CreateTime fieldGroup:另一个要分组的字段,格式如:m=>m.TypeName fieldGroupStati:要统计总和、最大值、最小值和平均值的字段,格式如:m=>m.Price dateInterval:统计的日期间隔,默认为 1M(支持的表达式有 1y:1 年、1q:1 季度、1M:1 个月、1w:1 星期、1d:1 天、1h:1 小时、1m:1 分钟、1s:1 秒钟) dateFormat:统计的日期格式化方式,默认为 yyyy-MM(注意大小写,完整的格式化格式为 yyyy-MM-dd HH:mm:ss) esQueryList:动态查询条件 |
6.11、📜 获取总条数、最大、最小、求和或平均值等方法
方法名称 | 方法说明 | 方法参数 | 返回值 | 备注 |
GetCount | 获取符合条件的数据总条数 | <T>(Expression<Func<T, object>> field, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为总条数 | T:泛型对象 esQueryList:动态查询条件 |
GetCountAsync | 获取符合条件的数据总条数(异步) | <T>(Expression<Func<T, object>> field, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为总条数 | T:泛型对象 esQueryList:动态查询条件 |
GetStatiCount | 获取某字段的最大值、最小值、求和、平均值和总数等 | <T>(Expression<Func<T, object>> field, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为统计数据,格式为{"Count":100,"Sum":999,"Max":150,"Min":10,"Avg":200} | T:泛型对象 field:要求和、最大值、最小值和平均值的字段 B,格式如:m=>m.col1 esQueryList:动态查询条件 |
GetStatiCountAsync | 获取某字段的最大值、最小值、求和、平均值和总数等(异步) | <T>(Expression<Func<T, object>> field, List<EsQueryModel<T>>? esQueryList = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为统计数据,格式为{"Count":100,"Sum":999,"Max":150,"Min":10,"Avg":200} | T:泛型对象 field:要求和、最大值、最小值和平均值的字段 B,格式如:m=>m.col1 esQueryList:动态查询条件 |
GetStatiSumMulti | 获取某些字段相加的多个总和 | <T>(List<EsStatisticalSumMultiModel> fieldCons, bool is2Dec, List<EsQueryModel<T>>? esQueryList = null, Action<string>? error = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为统计数据,格式为{"分类 1":100,"分类 2":200} | T:泛型对象 fieldCons:统计的某些字段多个总和的条件集合 is2Dec:是否将总和结果保留 2 为小数,false 则将保持原小数返回 esQueryList:动态查询条件 error:错误回调方法(参数 1 为出错的提示信息) |
GetStatiSumMultiAsync | 获取某些字段相加的多个总和(异步) | <T>(List<EsStatisticalSumMultiModel> fieldCons, bool is2Dec, List<EsQueryModel<T>>? esQueryList = null, Func<string, Task>? error = null) | 返回元组对象,包含 3 个值,第一个为是否成功,第二个为失败的提示信息,第三个为统计数据,格式为{"分类 1":100,"分类 2":200} | T:泛型对象 fieldCons:统计的某些字段多个总和的条件集合 is2Dec:是否将总和结果保留 2 为小数,false 则将保持原小数返回 esQueryList:动态查询条件 error:错误回调方法(参数 1 为出错的提示信息) |
6.12、💰 查询条件
在上面的方法中,基本都涉及到了关于查询条件(List<EsQueryModel<T>>? esQueryList = null)的参数,在此专门对查询条件的使用进行说明。
创建查询条件:
我们使用QuickElasticSearchExtension.CreateEsQueryModel<T>
静态方法来创建一个查询条件集合对象,如下所示:
组合条件:
上述的例子,我们只声明了一个组合条件,如果需要多个组合条件一起使用,则直接调用AddEsQueryModel
方法继续添加组合条件即可(该方法为上述创建的条件集合对象queryCon
的扩展方法【链式操作】),该方法的参数和CreateEsQueryModel
一模一样,如下所示的代码代表(Id 大于或等于 340506710462542 并且 UserAge 小于或等于 60) 或者(Id 等于 340506710462539 或者 Id 等于 340506710462538)
:
更多条件:
如果我们想添加更多条件,直接使用方法AddEsQueryModel
追加即可,如下所示:
EsQueryModel 说明:
- PrevConType:和上一个 EsQueryModel 之间的连接类型(AND 或 OR 操作,默认为 AND 操作);
- QueryType:查询条件集合的连接类型,针对 QueryCon 而言(AND 或 OR 操作,默认为 AND 操作);
- QueryCon:查询条件集合。
查询条件扩展方法:
方法名称 | 方法说明 | 方法参数 | 返回值 | 备注 |
CreateEsQueryModel | 创建查询条件集合对象 | (EsQueryType prevConType = EsQueryType.And, EsQueryType queryType = EsQueryType.And, Action<List<Func<QueryContainerDescriptor<T>, QueryContainer>>>? queryConAction = null) | List<EsQueryModel<T>> | T:泛型对象 prevConType:和上一个 EsQueryModel 之间的连接类型(AND 或 OR 操作,默认为 AND 操作) queryType:当前组合查询条件集合的连接类型,针对 QueryCon 而言(AND 或 OR 操作,默认为 AND 操作) queryConAction:当前组合查询条件的回调函数,用于添加具体条件 |
AddEsQueryModel | 添加查询条件 | <T>(this List<EsQueryModel<T>> queryModels, EsQueryType prevConType = EsQueryType.And, EsQueryType queryType = EsQueryType.And, Action<List<Func<QueryContainerDescriptor<T>, QueryContainer>>>? queryConAction = null) | List<EsQueryModel<T>> | T:泛型对象 prevConType:和上一个 EsQueryModel 之间的连接类型(AND 或 OR 操作,默认为 AND 操作) queryType:当前组合查询条件集合的连接类型,针对 QueryCon 而言(AND 或 OR 操作,默认为 AND 操作) queryConAction:当前组合查询条件的回调函数,用于添加具体条件 |
GetSort | 获取排序条件 | <T>(string field, bool isDesc = true) | Func<SortDescriptor<T>, SortDescriptor<T>> | T:泛型对象 field:排序字段 isDesc:是否为降序(默认为降序) |
GetSort | 获取排序条件 | <T>(string field, bool isDesc = true) | Func<SortDescriptor<T>, SortDescriptor<T>> | T:泛型对象 field:排序字段 isDesc:是否为降序(默认为降序) |
CreateAndOrs | 创建 AND 或 OR 条件集合 | <T>() | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 使用示例:var queryCon = QuickElasticSearchExtension.CreateAndOrs<T>(); |
AddEqu | 添加等于查询条件= | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> field, object value) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 field:字段表达式,如:m => m.Id value:查询的具体值 使用示例:queryCon.AddEqu(m => m.Id, "7"); |
AddIn | 添加 IN 查询条件 | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> field, List<object> values) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 field:字段表达式,如:m => m.Id values:查询的具体值 使用示例:queryCon.AddNotEqu(m => m.Id, new List<object>{"7","21","28"}); |
AddNotEqu | 添加不等于查询条件= | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> field, object value) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 field:字段表达式,如:m => m.Id value:查询的具体值 使用示例:queryCon.AddNotEqu(m => m.Id, "7"); |
AddNotEqu | 添加不等于查询条件= | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> field, List<object> values) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 field:字段表达式,如:m => m.Id values:查询的具体值 使用示例:queryCon.AddNotEqu(m => m.Id, new List<object>{"7","21","28"}); |
AddLike | 添加模糊查询条件 LIKE | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> fields, string value) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 fields:字段表达式,如:m => m.Id 或 m=>new [] {m.EngPart, m.TestType} value:查询的关键字 使用示例:queryCon.AddLike(m => m.EngPart, "测试的关键字"); |
AddGt | 添加大于查询条件> | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> field, double value) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 field:字段表达式,如:m => m.Id value:查询的具体值 使用示例:queryCon.AddGt(m => m.Id, 28); |
AddGt | 添加大于查询条件> | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> field, DateTime value) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 field:字段表达式,如:m => m.CreateTime value:查询的具体值 使用示例:queryCon.AddGt(m => m.CreateTime, "2022-10-12 14:10:26"); |
AddGte | 添加大于或等于查询条件>= | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> field, double value) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 field:字段表达式,如:m => m.Id value:查询的具体值 使用示例:queryCon.AddGte(m => m.Id, 28); |
AddGte | 添加大于或等于查询条件>= | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> field, DateTime value) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 field:字段表达式,如:m => m.CreateTime value:查询的具体值 使用示例:queryCon.AddGte(m => m.CreateTime, "2022-10-12 14:10:26"); |
AddLt | 添加小于查询条件< | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> field, double value) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 field:字段表达式,如:m => m.Id value:查询的具体值 使用示例:queryCon.AddLt(m => m.Id, 28); |
AddLt | 添加小于查询条件< | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> field, DateTime value) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 field:字段表达式,如:m => m.CreateTime value:查询的具体值 使用示例:queryCon.AddLt(m => m.CreateTime, "2022-10-12 14:10:26"); |
AddLte | 添加小于或等于查询条件<= | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> field, double value) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 field:字段表达式,如:m => m.Id value:查询的具体值 使用示例:queryCon.AddLte(m => m.Id, 28); |
AddLte | 添加小于或等于查询条件<= | <T>(this List<Func<QueryContainerDescriptor<T>, QueryContainer>> andOrCons, Expression<Func<T, object>> field, DateTime value) | List<Func<QueryContainerDescriptor<T>, QueryContainer>> | T:泛型对象 field:字段表达式,如:m => m.CreateTime value:查询的具体值 使用示例:queryCon.AddLte(m => m.CreateTime, "2022-10-12 14:10:26"); |
分页查询条件:
我们在使用分页方法的时候,第一个参数需要传入分页查询参数EsPagerConModel
,如下所示:
EsPagerConModel 说明:
- PageIndex:当前页码(默认为 1);
- PageSize:当前页数量(默认为 15);
- OrderField:排序字段;
- OrderType:排序方式(默认为 desc)。
统计查询条件:
我们在使用GetStatiSumMulti
或GetStatiSumMultiAsync
方法获取某些字段相加的多个总和的统计的时候,第一个参数需要传入EsStatisticalSumMultiModel
,如下所示:
EsStatisticalSumMultiModel 说明:
- AsName(string):某几个字段相加总和最后返回的 Key 名称;
- Fields(List<string>):某几个字段相加的字段集合。