MVEL language Plugin for elasticsearch (STOPPED)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dev-tools
src
.gitignore
CONTRIBUTING.md
LICENSE.txt
README.md
pom.xml

README.md

MVEL lang Plugin for Elasticsearch (DEPRECATED)

MVEL does not work correctly with Java8. This plugin will only be maintained until Elasticsearch 2.0.0.

The MVEL language plugin allows to have mvel as the language of scripts to execute.

In order to install the plugin, simply run:

bin/plugin install elasticsearch/elasticsearch-lang-mvel/1.7.0

You need to install a version matching your Elasticsearch version:

elasticsearch MVEL Lang Plugin Docs
master Not available
es-1.x 1.7.0 1.7.0
es-1.6 1.6.0 1.6.0
es-1.5 1.5.0 1.5.0
es-1.4 1.4.1 1.4.1

To build a SNAPSHOT version, you need to build it with Maven:

mvn clean install
plugin --install lang-mvel \
       --url file:target/releases/elasticsearch-lang-mvel-X.X.X-SNAPSHOT.zip

User Guide

Using mvel with function_score

Let's say you want to use function_score API using mvel. Here is a way of doing it:

curl -XDELETE "http://localhost:9200/test"

curl -XPUT "http://localhost:9200/test/doc/1" -d '{
  "num": 1.0
}'

curl -XPUT "http://localhost:9200/test/doc/2?refresh" -d '{
  "num": 2.0
}'

curl -XGET "http://localhost:9200/test/_search" -d'
{
  "query": {
    "function_score": {
      "script_score": {
        "script": "Math.pow(doc[\"num\"].value, 2)",
        "lang": "mvel"
      }
    }
  }
}'

gives

{
   // ...
   "hits": {
      "total": 2,
      "max_score": 4,
      "hits": [
         {
            // ...
            "_score": 4
         },
         {
            // ...
            "_score": 1
         }
      ]
   }
}

Using mvel with script_fields

curl -XDELETE "http://localhost:9200/test"

curl -XPUT "http://localhost:9200/test/doc/1?refresh" -d'
{
  "obj1": {
   "test": "something"
  },
  "obj2": {
    "arr2": [ "arr_value1", "arr_value2" ]
  }
}'

curl -XGET "http://localhost:9200/test/_search" -d'
{
  "script_fields": {
    "s_obj1": {
      "script": "_source.obj1", "lang": "mvel"
    },
    "s_obj1_test": {
      "script": "_source.obj1.test", "lang": "mvel"
    },
    "s_obj2": {
      "script": "_source.obj2", "lang": "mvel"
    },
    "s_obj2_arr2": {
      "script": "_source.obj2.arr2", "lang": "mvel"
    }
  }
}'

gives

{
  // ...
  "hits": [
     {
        // ...
        "fields": {
           "s_obj2_arr2": [
              [
                 "arr_value1",
                 "arr_value2"
              ]
           ],
           "s_obj1_test": [
              "something"
           ],
           "s_obj2": [
              {
                 "arr2": [
                    "arr_value1",
                    "arr_value2"
                 ]
              }
           ],
           "s_obj1": [
              {
                 "test": "something"
              }
           ]
        }
     }
  ]
}

License

This software is licensed under the Apache 2 license, quoted below.

Copyright 2009-2014 Elasticsearch <http://www.elasticsearch.org>

Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.