Elasticsearch Search Template 搜索模板

Elasticsearch Search Template

所谓 search template 搜索模板其实就是：

  1. 预先定义好查询语句 DSL 的结构并预留参数
  2. 搜索的时再传入参数值
  3. 渲染出完整的 DSL ，最后进行搜索

使用搜索模板可以将 DSL 从应用程序中解耦出来，并且可以更加灵活的更改查询语句。

例如：

GET _search/template
{"source" : {"query": {"match" : {"{{my_field}}" : "{{my_value}}"}}},"params" : {"my_field" : "message","my_value" : "foo"}
}

构造出来的 DSL 就是：

{"query": {"match": {"message": "foo"}}
}

在模板中通过 {{ }} 的方式预留参数，然后查询时再指定对应的参数值，最后填充成具体的查询语句进行搜索。

搜索模板 API

为了实现搜索模板和查询分离，我们首先需要单独保存和管理搜索模板。

保存搜索模板

使用 scripts API 保存搜索模板（不存在则创建，存在则覆盖）。示例：

POST _scripts/<templateid>
{"script": {"lang": "mustache","source": {"query": {"match": {"title": "{{query_string}}"}}}}
}
查询搜索模板
GET _scripts/<templateid>
删除搜索模板
DELETE _scripts/<templateid>
使用搜索模板

示例：

GET _search/template
{"id": "<templateid>","params": {"query_string": "search words"}
}

params 中的参数与搜索模板中定义的一致，上文保存搜索模板的示例是 {{query_string}}，所以这里进行搜索时对应的参数就是 query_string 。

检验搜索模板

有时候我们想看看搜索模板输入了参数之后渲染成的 DSL 到底长啥样。

示例：

GET _render/template
{"source": "{ \"query\": { \"terms\": {{#toJson}}statuses{{/toJson}} }}","params": {"statuses" : {"status": [ "pending", "published" ]}}
}

返回的结果就是：

{"template_output": {"query": {"terms": {"status": ["pending","published"]}}}
}

{{#toJson}} {{/toJson}} 就是转换成 json 格式。

已经保存的搜索模板可以通过以下方式查看渲染结果：

GET _render/template/<template_name>
{"params": {"..."}
}
使用 explain 和 profile 参数

示例：

GET _search/template
{"id": "my_template","params": {"status": [ "pending", "published" ]},"explain": true
}

GET _search/template
{"id": "my_template","params": {"status": [ "pending", "published" ]},"profile": true
}

模板渲染

填充简单值
GET _search/template
{"source": {"query": {"term": {"message": "{{query_string}}"}}},"params": {"query_string": "search words"}
}

渲染出来的 DSL 就是：

{"query": {"term": {"message": "search words"}}
}
将参数转换为 JSON

使用 {{#toJson}}parameter{{/toJson}} 会将参数转换为 JSON。

GET _search/template
{"source": "{ \"query\": { \"terms\": {{#toJson}}statuses{{/toJson}} }}","params": {"statuses" : {"status": [ "pending", "published" ]}}
}

渲染出来的 DSL 就是：

{"query": {"terms": {"status": ["pending","published"]}}
}

对象数组的渲染示例：

GET _search/template
{"source": "{\"query\":{\"bool\":{\"must\": {{#toJson}}clauses{{/toJson}} }}}","params": {"clauses": [{ "term": { "user" : "foo" } },{ "term": { "user" : "bar" } }]}
}

渲染结果就是：

{"query": {"bool": {"must": [{ "term": { "user" : "foo" } },{ "term": { "user" : "bar" } }]}}
}
将数组 join 成字符串

使用 {{#join}}array{{/join}} 可以将数组 join 成字符串。

示例：

GET _search/template
{"source": {"query": {"match": {"emails": "{{#join}}emails{{/join}}"}}},"params": {"emails": [ "aaa", "bbb" ]}
}

渲染结果：

{"query" : {"match" : {"emails" : "aaa,bbb"}}
}

除了默认以 , 分隔外，还可以自定义分隔符，示例：

{"source": {"query": {"range": {"born": {"gte": "{{date.min}}","lte": "{{date.max}}","format": "{{#join delimiter='||'}}date.formats{{/join delimiter='||'}}"}}}},"params": {"date": {"min": "2016","max": "31/12/2017","formats": [ "dd/MM/yyyy", "yyyy" ]}}
}

例子中的 {{#join delimiter='||'}} {{/join delimiter='||'}} 意思就是进行 join 操作，分隔符设置为 || ，渲染结果就是：

{"query": {"range": {"born": {"gte": "2016","lte": "31/12/2017","format": "dd/MM/yyyy||yyyy"}}}
}
默认值

使用 {{var}}{{^var}}default{{/var}} 的方式设置默认值。

示例：

{"source": {"query": {"range": {"line_no": {"gte": "{{start}}","lte": "{{end}}{{^end}}20{{/end}}"}}}},"params": { ... }
}

{{end}}{{^end}}20{{/end}} 就是给 end 设置了默认值为 20 。

当 params 是 { "start": 10, "end": 15 } 时，渲染结果是：

{"range": {"line_no": {"gte": "10","lte": "15"}}
}

当 params 是 { "start": 10 } 时，end 就会使用默认值，渲染结果就是：

{"range": {"line_no": {"gte": "10","lte": "20"}}
}
条件子句

有时候我们的参数是可选的，这时候就可以使用 {{#key}} {{/key}}的语法。

示例，假设参数 line_no, start, end 都是可选的，使用 {{#key}} {{/key}} 形如：

{"query": {"bool": {"must": {"match": {"line": "{{text}}"}},"filter": {{{#line_no}}"range": {"line_no": {{{#start}}"gte": "{{start}}"{{#end}},{{/end}}{{/start}}{{#end}}"lte": "{{end}}"{{/end}}}}{{/line_no}}}}}
}

1、 当参数为：

{"params": {"text": "words to search for","line_no": {"start": 10,"end": 20}}
}

渲染结果是：

{"query": {"bool": {"must": {"match": {"line": "words to search for"}},"filter": {"range": {"line_no": {"gte": "10","lte": "20"}}}}}
}

2、 当参数为：

{"params": {"text": "words to search for"}
}

渲染结果为：

{"query": {"bool": {"must": {"match": {"line": "words to search for"}},"filter": {}}}
}

3、当参数为：

{"params": {"text": "words to search for","line_no": {"start": 10}}
}

渲染结果为：

{"query": {"bool": {"must": {"match": {"line": "words to search for"}},"filter": {"range": {"line_no": {"gte": 10}}}}}
}

4、当参数为：

{"params": {"text": "words to search for","line_no": {"end": 20}}
}

渲染结果为：

{"query": {"bool": {"must": {"match": {"line": "words to search for"}},"filter": {"range": {"line_no": {"lte": 20}}}}}
}

需要注意的是在 JSON 对象中，

{"filter": {{{#line_no}}...{{/line_no}}}
}

这样直接写 {{#line_no}} 肯定是非法的JSON格式，你必须转换为 JSON 字符串。

URLs 编码

使用 {{#url}}value{{/url}} 的方式可以进行 HTML 编码转义。

示例：

GET _render/template
{"source": {"query": {"term": {"http_access_log": "{{#url}}{{host}}/{{page}}{{/url}}"}}},"params": {"host": "https://www.elastic.co/","page": "learn"}
}

渲染结果：

{"template_output": {"query": {"term": {"http_access_log": "https%3A%2F%2Fwww.elastic.co%2F%2Flearn"}}}
}

Mustache 基本语法

上文中的 {{ }} 语法其实就是 mustache language ，补充介绍下基本的语法规则。

使用 {{key}}

模板：Hello {{name}}

输入：

{"name": "Chris"
}

输出：Hello Chris

使用 {{{key}}} 避免转义

所有变量都会默认进行 HTML 转义。

模板：{{company}}

输入：

{"company": "<b>GitHub</b>"
}

输出：&lt;b&gt;GitHub&lt;/b&gt;

使用 {{{ }}} 避免转义。

模板：{{{company}}}

输入：

{"company": "<b>GitHub</b>"
}

输出：<b>GitHub</b>

使用 {{#key}} {{/key}} 构造区块

1、 当 key 是 false 或者空列表将会忽略
模板：

    Shown.{{#person}}Never shown!{{/person}}

输入：

{"person": false
}

输出：

    Shown.

2、 当 key 非空值则渲染填充
模板：

    {{#repo}}<b>{{name}}</b>{{/repo}}

输入：

{"repo": [{ "name": "resque" },{ "name": "hub" },{ "name": "rip" }]
}

输出：

    <b>resque</b><b>hub</b><b>rip</b>

3、当 key 是函数则调用后渲染
模板：

    {{#wrapped}}{{name}} is awesome.{{/wrapped}}

输入：

{"name": "Willy","wrapped": function() {return function(text, render) {return "<b>" + render(text) + "</b>"}}
}

输出：

    <b>Willy is awesome.</b>

4、当 key 是非 false 且非列表
模板：

    {{#person?}}Hi {{name}}!{{/person?}}

输入：

{"person?": { "name": "Jon" }
}

输出：

    Hi Jon!
使用 {{^key}} {{/key}} 构造反区块

{{^key}} {{/key}} 的语法与 {{#key}} {{/key}} 类似，不同的是，当 key 不存在，或者是 false ，又或者是空列表时才渲染输出区块内容。

模板：

    {{#repo}}<b>{{name}}</b>{{/repo}}{{^repo}}No repos :({{/repo}}

输入：

{"repo": []
}

输出：

    No repos :(
使用 {{! }} 添加注释

{{! }} 注释内容将会被忽略。

模板：

<h1>Today{{! ignore me }}.</h1>

输出：

<h1>Today.</h1>
使用 {{> }} 子模块

模板：

base.mustache:
<h2>Names</h2>
{{#names}}{{> user}}
{{/names}}user.mustache:
<strong>{{name}}</strong>

其实也就等价于：

<h2>Names</h2>
{{#names}}<strong>{{name}}</strong>
{{/names}}
使用 {{= =}} 自定义定界符

有时候我们需要改变默认的定界符 {{ }} ，那么就可以使用 {{= =}} 的方式自定义定界符。

例如：

{{=<% %>=}}

定界符被定义为了 <% %>，这样原先 {{key}} 的使用方式就变成了 <%key%>。
再使用：

<%={{ }}=%>

就重新把定界符改回了 {{ }}。

更多语法详情请查阅官方文档 mustache language 。

结语

使用 search template 可以对搜索进行有效的解耦，即应用程序只需要关注搜索参数与返回结果，而不用关注具体使用的 DSL 查询语句，到底使用哪种 DSL 则由搜索模板进行单独管理。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/diannao/58402.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Tensor做为索引

Tensor做为索引

文章目录 1、tensor作为行索引2、tensor作为列索引3、切片作为索引4、布尔张量作为索引 1、tensor作为行索引 假设我们有一个二维张量 A&#xff0c;它的形状是 44&#xff1a; A torch.tensor([[1, 2, 3, 4],[5, 6, 7, 8],[9, 10, 11, 12],[13, 14, 15, 16] ])如果我们想用…
阅读更多...
OpenSSL

OpenSSL

OpenSSL 概述 OpenSSL 是一个开源的、安全传输协议实现工具&#xff0c;广泛应用于数据加密与解密、证书生成与管理以及其他安全性相关的任务。在现代网络安全中&#xff0c;OpenSSL 被用于构建和维护 SSL/TLS 通信&#xff0c;确保数据在传输过程中的机密性和完整性。 简单来…
阅读更多...
「C/C++」C/C++预处理 之 X宏（X Macro）

「C/C++」C/C++预处理 之 X宏（X Macro）

✨博客主页何曾参静谧的博客&#x1f4cc;文章专栏「C/C」C/C程序设计&#x1f4da;全部专栏「VS」Visual Studio「C/C」C/C程序设计「UG/NX」BlockUI集合「Win」Windows程序设计「DSA」数据结构与算法「UG/NX」NX二次开发「QT」QT5程序设计「File」数据文件格式「PK」Parasoli…
阅读更多...
WPF+MVVM案例实战（四）- 自定义GroupBox边框样式实现

WPF+MVVM案例实战（四）- 自定义GroupBox边框样式实现

文章目录 1、项目准备2、功能实现1、EnviromentModel.cs 代码2、GroubBoxViewModel.cs 代码实现3、ViewModelLocator.cs 依赖注入4、GroubBoxWindow.xaml 样式布局5、数据绑定3、效果展示4、资源获取1、项目准备 打开项目 Wpf_Examples，新建 GroubBoxWindow.xaml 界面、Groub…
阅读更多...
第十六章 Vue组件化开发及组件局部/全局注册

第十六章 Vue组件化开发及组件局部/全局注册

目录 一、组件化 1.1. 组件概述 1.2. 语法高亮插件 ​编辑 1.3. 组件内部组成 1.4. 让组件支持 less 1.5. 组件注册的两种方式 二、局部注册 2.1. 使用描述 2.2. 脚手架工程变动的核心代码 2.2.1. 工程结构图 2.2.2. App.vue 2.2.3. WzxHeader.vue 2.2.4. WzxMain…
阅读更多...
excel斜线表头

excel斜线表头

检验数据验证对象 鼠标放在检验数据 验证对象中间&#xff0c;altenter 之后空格 选中格子&#xff0c;右键单元格格式&#xff0c; 完成 如果是需要多分割&#xff0c;操作一样&#xff0c;在画斜线的时候会有区别&#xff0c;在插入里面用直线画斜线即可 在表格插入的时…
阅读更多...
HTML5 应用程序缓存

HTML5 应用程序缓存

HTML5 应用程序缓存 HTML5 应用程序缓存（Application Cache）是一种离线缓存机制，允许Web应用程序在用户设备上存储资源副本，以便在没有网络连接时仍然可以访问。这种机制提高了Web应用的可靠性和用户体验，尤其适用于移动设备和低带宽环境。 工作原理 HTML5 应用程序缓存…
阅读更多...
中阳智能投资系统：量化科技引领未来投资之路

中阳智能投资系统：量化科技引领未来投资之路

在全球金融市场竞争激烈的大背景下&#xff0c;量化科技逐渐成为机构投资者和个人投资者的核心工具。中阳智能投资系统以数据驱动策略为核心&#xff0c;通过精准的模型算法与自动化交易技术&#xff0c;为用户提供全方位的智能投资服务。本文将探讨中阳智能投资系统的独特优势…
阅读更多...
【Mac】安装 F5-TTS

【Mac】安装 F5-TTS

1、下载项目 项目地址&#xff1a;【GitHub】 SWivid F5-TTS 2、创建并激活 Python 虚拟环境 # 创建 Python 虚拟环境 userMac F5-TTS-main % python3 -m venv f5-tts# 激活进入 Python 虚拟环境 userMac F5-TTS-main % source f5-tts/bin/activate (f5-tts) userrMac F5-TT…
阅读更多...
【python】OpenCV—Connected Components

【python】OpenCV—Connected Components

文章目录 1、任务描述2、代码实现3、完整代码4、结果展示5、涉及到的库函数6、参考 1、任务描述 基于 python opencv 的连通分量标记和分析函数&#xff0c;分割车牌中的数字、号码、分隔符 cv2.connectedComponentscv2.connectedComponentsWithStatscv2.connectedComponents…
阅读更多...
日期选择简化版今日、本周、本月、本季度、本年

日期选择简化版今日、本周、本月、本季度、本年

function 未来之窗_时间_现在() {let date new Date(),year date.getFullYear(), //获取完整的年份(4位)month date.getMonth() 1, //获取当前月份(0-11,0代表1月)strDate date.getDate() // 获取当前日(1-31),小时 date.getHours(),分钟 date.getMinutes();if (month &…
阅读更多...
基于安卓Android的健康饮食系统APP（源码+文档+部署+讲解）

基于安卓Android的健康饮食系统APP（源码+文档+部署+讲解）

&#xff01;&#xff01;&#xff01;&#xff01;&#xff01;&#xff01;&#xff01;&#xff01;&#xff01; 会持续一直更新下去 有问必答 一键收藏关注不迷路 源码获取&#xff1a;https://pan.baidu.com/s/1aRpOv3f2sdtVYOogQjb8jg?pwdjf1d 提取码: jf1d &#…
阅读更多...
【Unity基础】初识UI Toolkit - 编辑器UI

【Unity基础】初识UI Toolkit - 编辑器UI

&#xff08;本文所需图片在文章上面的资源中&#xff0c;点击“立即下载”。&#xff09; 本文介绍了如何通过UI工具包&#xff08;UI Toolkit&#xff09;来创建一个编辑器UI。 一、创建项目 1. 打开Unity创建一个空项目&#xff08;任意模板&#xff09;&#xff0c;这里我…
阅读更多...
【网络】传输层协议TCP

【网络】传输层协议TCP

目录 四位首部长度 序号 捎带应答 标记位 超时重传机制 连接管理机制&#xff08;RST标记位&#xff09; 三次握手及四次挥手的原因 TCP的全称是传输控制协议&#xff08;Transmission Control Protocol&#xff09;&#xff0c;也就是说&#xff0c;对于放到TCP发送缓冲…
阅读更多...
docker基础篇（尚硅谷）

docker基础篇（尚硅谷）

学习链接 docker1️⃣基础篇&#xff08;零基小白&#xff09; - 语雀文档 (即本篇) Docker与微服务实战&#xff08;基础篇&#xff09; Docker与微服务实战&#xff08;高级篇&#xff09;- 【上】 Docker与微服务实战&#xff08;高级篇&#xff09;- 【下】 文章目录 学习…
阅读更多...
Spark RDD

Spark RDD

概念 RDD是一种抽象&#xff0c;是Spark对于分布式数据集的抽象&#xff0c;它用于囊括所有内存中和磁盘中的分布式数据实体 RDD 与 数组对比 对比项数组RDD概念类型数据结构实体数据模型抽象数据跨度单机进程内跨进程、跨计算节点数据构成数组元素数据分片(Partitions)数据…
阅读更多...
算法训练（leetcode）二刷第十一天 | 144. 二叉树的前序遍历、145. 二叉树的后序遍历、94. 二叉树的中序遍历、102. 二叉树的层序遍历

算法训练（leetcode）二刷第十一天 | 144. 二叉树的前序遍历、145. 二叉树的后序遍历、94. 二叉树的中序遍历、102. 二叉树的层序遍历

刷题记录 144. 二叉树的前序遍历思路一&#xff1a;递归前序遍历思路二&#xff1a;迭代前序遍历思路三&#xff1a;统一迭代法 145. 二叉树的后序遍历思路一&#xff1a;递归后序遍历思路二&#xff1a;迭代后序遍历思路三&#xff1a;统一迭代法 94. 二叉树的中序遍历思路一&…
阅读更多...
OmicsTools软件和R语言分析环境安装配置答疑汇总最新版

OmicsTools软件和R语言分析环境安装配置答疑汇总最新版

OmicsTools软件和R语言分析环境安装配置答疑汇总 前言提示 我开发了一款本地电脑无限使用的零代码生信数据分析作图神器电脑软件OmicsTools&#xff0c;欢迎大家使用进行生物医学科研数据分析和作图&#xff0c;不需要学编程写代码&#xff0c;分析次数没有限制&#xff0c;可…
阅读更多...
java web调试时清理当前网址的缓存

java web调试时清理当前网址的缓存

java web调试时清理当前网址的缓存 背景 开发后端接口的时候&#xff0c;出现页面已经重新部署启动。但页面报错404的问题。询问前端同学后&#xff0c;发现是因为没有清理页面缓存导致的。特别在此记录。 清理页面缓存 操作方式 chrome浏览器 F12 > 应用 > 存储 &g…
阅读更多...
PyTorch的基础教程

PyTorch的基础教程

以下是PyTorch的基础教程&#xff0c;包括安装步骤以及一个简单的入门Demo。 一、PyTorch安装 安装Anaconda Anaconda是一个流行的Python发行版&#xff0c;包含了大量的科学计算库。访问Anaconda官网&#xff0c;选择适合操作系统的版本进行下载和安装。在安装过程中&#xf…
阅读更多...
最新文章

Copyright @ 2022~2023