===================
This module provides an easy Elasticsearch(v0.90.12) integration in a Playframework 2 application
For Playframework version 2.0.x, see README-2.0.x.md
Module | Playframework | Elasticsearch | Comments | Diff |
---|---|---|---|---|
0.5.0 | 2.1-RC1 | 0.19.10 | Compatibility with play 2.1-RC1 | |
0.5.1 | 2.1-RC3 | 0.20.4 | upgrade to ES 0.20.4 - works correctly with play 2.1-RC3 | |
0.5.2 | 2.1.0 | 0.20.4 | Upgrade to play 2.1.0 - includes scala helpers | |
0.5.3 | 2.1.0 | 0.20.5 | Upgrade to ES 0.20.5 - moving artifact's organization from "com.github.cleverage - elasticsearch" to "com.clever-age - play2-elasticsearch" | |
0.5.4 | 2.1.0 | 0.20.5 | API Async, Bulk, manage multi-index | v0.5.3 -> v0.5.4 |
0.5.5 | 2.1.0 | 0.20.5 | Disabled plugin, use multiple index for an objet | v0.5.4 -> v0.5.5 |
0.5-SNAPSHOT | 2.1.1 | 0.90.0 | Upgrade to ES 0.90.0 | |
0.6-SNAPSHOT | 2.1.1 | 0.90.2 | Upgrade to ES 0.90.2 | |
0.7-SNAPSHOT | 2.1.3 | 0.90.3 | Upgrade to ES 0.90.3 & play 2.1.3 | |
0.8-SNAPSHOT | 2.2.1 | 0.90.12 | Upgrade to ES 0.90.12 & play 2.2.1 | |
0.8.1 | 2.2.1 | 0.90.12 | Upgrade to ES 0.90.12 & play 2.2.1 | |
0.8.2 | 2.2.1 | 0.90.12 | Small fixes | |
1.1.0 | 2.2.1 | 1.1.0 | Upgrading the ES 1.1.0 (#47) | |
1.4-SNAPSHOT | 2.2.1 | 1.4.1 | Upgrading the ES 1.4.1 (#59) |
The dependency declaration is :
"com.clever-age" % "play2-elasticsearch" % "1.4-SNAPSHOT"
Since v0.8.1, releases are published on maven-central, so you don't have to define any specific resolvers.
If you want to use a snapshot version, you will have to register the Sonatype OSS snapshot repository :
resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"
Your build.sbt
should look like :
name := "test-play2-elasticsearch"
version := "1.0-SNAPSHOT"
libraryDependencies ++= Seq(
jdbc,
cache,
"com.clever-age" % "play2-elasticsearch" % "0.8.2"
)
play.Project.playScalaSettings
// Uncomment this line if you use a snapshot version
// resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"
The Play2-elasticsearch module requires its plugin class to be declared in the conf/play.plugins file. If this file doesn't exist (it's not created by default when you create a new project), just create it in the conf directory first, and then add
9000:com.github.cleverage.elasticsearch.plugin.IndexPlugin
You can configure the module in conf/application.conf (or in any configuration file included in your application.conf)
## ElasticSearch Configuration
##############################
## define local mode or not
elasticsearch.local=false
## Coma-separated list of clients
elasticsearch.client="192.168.0.46:9300"
# ex : elasticsearch.client="192.168.0.46:9300,192.168.0.47:9300"
## Name of the index
elasticsearch.index.name="play2-elasticsearch"
## Custom settings to apply when creating the index (optional)
elasticsearch.index.settings="{ analysis: { analyzer: { my_analyzer: { type: \"custom\", tokenizer: \"standard\" } } } }"
## define package or class separate by commas for loading @IndexType and @IndexMapping information
elasticsearch.index.clazzs="indexing.*"
## show request & result json of search request in log (it will be logged using Logger.debug())
elasticsearch.index.show_request=true
Create a Class extending "com.github.cleverage.elasticsearch.Index"
Example : IndexTest.java
IndexTest indexTest = new IndexTest();
indexTest.name = "hello World";
indexTest.index();
IndexTest byId = IndexTest.find.byId("1");
IndexResults<IndexTest> all = IndexTest.find.all();
IndexQuery<IndexTest> indexQuery = IndexTest.find.query();
indexQuery.setBuilder(QueryBuilders.queryString("hello"));
IndexResults<IndexTest> results = IndexTest.find.search(indexQuery);
See samples/elasticsearch-java application for more sample
Starting from version 0.5.2, Scala helpers are available (see module com.github.cleverage.elasticsearch.ScalaHelpers).
See samples/elasticsearch-scala application for a basic example
http://twitter.com/nboire & http://twitter.com/mguillermin
This code is released under the MIT License