何为 painless
ElasticStack 在升级到 5.0 版本之后,带来了一个新的脚本语言,painless。这里说“新的“是相对与已经存在 groove 而言的。还记得 Groove 脚本的漏洞吧,Groove 脚本开启之后,如果被人误用可能带来各种漏洞,为什么呢,主要是这些外部的脚本引擎太过于强大,什么都能做,用不好或者设置不当就会引起安全风险,基于安全和性能方面,所以 elastic.co 开发了一个新的脚本引擎,名字就叫 Painless,顾名思义,简单安全,无痛使用,和 Groove 的沙盒机制不一样,Painless 使用白名单来限制函数与字段的访问,针对 es 的场景来进行优化,只做 es 数据的操作,更加轻量级,速度要快好几倍,并且支持 Java 静态类型,语法保持 Groove 类似,还支持 Java 的 lambda 表达式。
painless 的特性
painless可以用在所有可以使用 script 的场景下,并具有以下特性:
高性能:painless 在 es 的运行速度是其他语言的数倍。
安全:使用白名单来限制函数与字段的访问,避免了可能的安全隐患
可选类型:你可以在脚本当中使用强类型的编程方式或者动态类型的编程方式。
语法:扩展了 java 的基本语法以兼容 groove 风格的脚本语言特性,使得 plainless 易读易写
有针对的优化:这门语言是为 elasticsearch 专门定制的。
简单的例子
要了解这门东西,肯定要先看看它能做到什么才能激发起兴趣。先简单看一下例子,和各种 groove,python,js 们,没有什么区别,但要特别注意,使用强类型编程方式可以极大的加快运行速率
#动态类型的写法
def first = input.doc.first_name.0;def last = input.doc.last_name.0;
return first + ” ” + last;
#强类型(10 倍速度于上面的动态类型)
String first = (String)((List)((Map)input.get(“doc”)).get(“first_name”)).get(0);String last = (String)((List)((Map)input.get(“doc”)).get(“last_name”)).get(0);
return first + ” ” + last;
具体例子
初始化数据
我们先输入一串曲棍球的数据到 ES 当中。
PUT hockey/player/_bulk?refresh
{“index”:{“_id”:1}}
{“first”:”johnny”,”last”:”gaudreau”,”goals”:[9,27,1],”assists”:[17,46,0],”gp”:[26,82,1],”born”:”1993/08/13″}
{“index”:{“_id”:2}}
{“first”:”sean”,”last”:”monohan”,”goals”:[7,54,26],”assists”:[11,26,13],”gp”:[26,82,82],”born”:”1994/10/12″}
{“index”:{“_id”:3}}
{“first”:”jiri”,”last”:”hudler”,”goals”:[5,34,36],”assists”:[11,62,42],”gp”:[24,80,79],”born”:”1984/01/04″}
{“index”:{“_id”:4}}
{“first”:”micheal”,”last”:”frolik”,”goals”:[4,6,15],”assists”:[8,23,15],”gp”:[26,82,82],”born”:”1988/02/17″}
{“index”:{“_id”:5}}
{“first”:”sam”,”last”:”bennett”,”goals”:[5,0,0],”assists”:[8,1,0],”gp”:[26,1,0],”born”:”1996/06/20″}
{“index”:{“_id”:6}}
{“first”:”dennis”,”last”:”wideman”,”goals”:[0,26,15],”assists”:[11,30,24],”gp”:[26,81,82],”born”:”1983/03/20″}
{“index”:{“_id”:7}}
{“first”:”david”,”last”:”jones”,”goals”:[7,19,5],”assists”:[3,17,4],”gp”:[26,45,34],”born”:”1984/08/10″}
{“index”:{“_id”:8}}
{“first”:”tj”,”last”:”brodie”,”goals”:[2,14,7],”assists”:[8,42,30],”gp”:[26,82,82],”born”:”1990/06/07″}
{“index”:{“_id”:39}}
{“first”:”mark”,”last”:”giordano”,”goals”:[6,30,15],”assists”:[3,30,24],”gp”:[26,60,63],”born”:”1983/10/03″}
{“index”:{“_id”:10}}
{“first”:”mikael”,”last”:”backlund”,”goals”:[3,15,13],”assists”:[6,24,18],”gp”:[26,82,82],”born”:”1989/03/17″}
{“index”:{“_id”:11}}
{“first”:”joe”,”last”:”colborne”,”goals”:[3,18,13],”assists”:[6,20,24],”gp”:[26,67,82],”born”:”1990/01/30″}
这里极其建议在练习的时候使用 kibana 上的 Dev Tools,这个东西有多好用谁用谁知道,它可以自动补齐 es 的各种 query 语法,牛不牛?而且就像 markdown 一样,做到左右分屏,所见即所得。
用 painless 获取 doc 的值
下面的例子中,我们通过function_score::script_score
更新每个 document 的 score。其中用到了for
循环,和强类型定义int
。
可以看到运行之后,_score 的值,编程了 goals 值的 sum。
以下是更多的取值的例子:
GET hockey/_search
{
“query”: {
“match_all”: {}
},
“script_fields”: {
“total_goals”: {
“script”: {
“lang”: “painless“,
“inline”: “int total = 0; for (int i = 0; i < doc[‘goals’].length; ++i) { total += doc[‘goals’][i]; } return total;”
}
}
}
}GET hockey/_search
{
“query”: {
“match_all”: {}
},
“sort”: {
“_script”: {
“type”: “string”,
“order”: “asc”,
“script”: {
“lang”: “painless“,
“inline”: “doc[‘first.keyword’].value + ‘ ‘ + doc[‘last.keyword’].value”
}
}
}
}
这里需要注意几点:
这里都是 _search 操作,多个操作之间会形成管道,既 query::match_all 的输出会作为 script_fields 或者 sort 的输入。
_search 操作中所有的返回值,都可以通过一个 map 类型变量 doc 获取。和所有其他脚本语言一样,用[]获取 map 中的值。这里要强调的是,doc 只可以在 _search 中访问到。在下一节的例子中,你将看到,使用的是 ctx。
_search 操作是不会改变 document 的值的,即便是 script_fields,你只能在当次查询是能看到 script 输出的值。
doc[‘first.keyword’]这样的写法是因为 doc[]返回有可能是分词之后的 value,所以你想要某个 field 的完整值时,请使用 keyword
通过 painless 更新对象值
上一节讲了如何读取值,在读取值的时候,query 的 response 虽然能够读到一个新值,但这个值并没有写入 document 当中。要更新值,需要通过_update
API。
单条记录更新
如下图,通过_update
API 的 script,我们可以增加一个新的 field:nick:
可以更改一个值:
这里需要注意的是:我们不再使用 doc 来访问对象,而是用 ctx。
批量更新
在大多数应用场景下,我们是很少用到_update
API 的。(当然,这里不包括你用 python, java 等语言用 for 循环多条更新)。在批量更新的场景,我推荐的是_update_by_query
API。
这里需要注意的是:
虽然 _update_by_queryAPI 在批量更新时,和我们第一个例子很像,先 query,再 update,通过管道修改全部的值。但这里仍然只能用 ctx,而不是 doc。如果用 doc,会抛出 nullpointerException。
另外,在例子中,我用的是 match_all query,但实际上你可以用各种 query,来划定精确的 query 范围,只修改你想修改的值。
Dates
Date 类型的 field 会被解析成ReadableDateTime
。所以它可以支持 getYear
, getDayOfWeek
等方法。 例如,要取 milliseconds,就屌用getMillis
方法。下面的例子,取每个球员是哪年出生的