通过脚本,您可以在 Elasticsearch 中评估自定义表达式。例如,您可以使用脚本将计算值作为字段返回或评估查询的自定义分数。默认脚本语言是Painless。
无痛脚本 Painless Script
Painless是一种专为 Elasticsearch 设计的高性能、安全的脚本语言。在 Elasticsearch 支持脚本的任何地方,您都可以使用 Painless 安全地编写内联和存储脚本。语法都遵循相同的模式:
"script": {
"lang": "...",
"source" | "id": "...",
"params": { ... }
}
lang
:指定编写脚本的语言。默认为painless.
source,id
:source为脚本本身,id为已存储的脚本
params
:指定作为变量传递到脚本中的任何命名参数。
GET my-index-000001/_search
{
"script_fields": {
"my_doubled_field": {
"script": {
"source": "doc['my_field'].value * params['multiplier']",
"params": {
"multiplier": 2
}
}
}
}
}
script_fields
: 用于构建脚本字段的关键词
doc['my_field']
: 脚本中引用文档中的字段
params['multiplier']
:脚本中引用params参数
访问文档中的字段
- 使用
doc map
访问文档字段:doc['my_field'].value
以这种方式访问文档字段不会处理缺失值或缺失映射,这意味着要编写健壮的 Painless 脚本,您需要包含检查字段和值是否存在的逻辑。
- 使用fieldAPI 访问文档字段:
field('my_field').get(<default_value>)
->快捷方式:$(‘field’, <default_value>)
fieldAPI 返回一个对象,该Field对象遍历具有多个值的字段,通过该 get(<default_value>)方法以及类型转换和辅助方法提供对基础值的访问。
API 返回您指定的field默认值,无论该字段是否存在或是否具有当前文档的任何值。这意味着fieldAPI 可以处理缺失值而不需要额外的逻辑。
脚本简化
GET my-index-000001/_search
{
"script_fields": {
"my_doubled_field": {
"script": {
"source": "field('my_field').get(null) * params['multiplier']",
"params": {
"multiplier": 2
}
}
}
}
}
lang
: 因为 Painless 是默认语言,所以如果您正在编写 Painless 脚本,则无需指定语言。
return
: Painless 自动使用脚本中的最终语句生成返回值。
get
: get方法可被替换为括号[]。
source
: Painless 块的最后语句不需要分号。
存储和检索脚本
请求创建了一个名为 calculate-score 的存储脚本。
POST _scripts/calculate-score
{
"script": {
"lang": "painless",
"source": "Math.log(_score * 2) + params['my_modifier']"
}
}
检索脚本
GET _scripts/calculate-score
使用脚本
GET my-index-000001/_search
{
"query": {
"script_score": {
"query": {
"match": {
"message": "some message"
}
},
"script": {
"id": "calculate-score",
"params": {
"my_modifier": 2
}
}
}
}
}
删除脚本
DELETE _scripts/calculate-score
使用脚本更新字段值
POST my-index-000001/_update/1
{
"script" : {
"source": "ctx._source.counter += params.count",
"lang": "painless",
"params" : {
"count" : 4
}
}
}
使用脚本新增、删除字段
POST my-index-000001/_update/1
{
"script" : "ctx._source.new_field = 'value_of_new_field'"
}
POST my-index-000001/_update/1
{
"script" : "ctx._source.remove('new_field')"
}