Play ElasticSearchPlugin

This is a simple Play 2 plugin, for Elasticsearch.

I got the idea from https://github.com/tuxBurner/play-neo4jplugin ! THANKS A LOT Seppel (@tuxBurner) for your awesome plugin and skeleteon !

You can use Play 2.4 with spring-data-elasticsearch without this plugin, see my example: https://github.com/unterstein/play-spring-data-elasticsearch-example

What i didn't liked that i can't call elasticsearch in the static way, like Ebean etc...

So here we go, i created this plugin :)

Current Version

0.6.0

• Fixed bug in RemoteElasticConfiguration, thanks @raunak again :-)

Installation (using sbt)

You will need to add the following resolver in your build.sbt file:

resolvers += "unterstein.github.io" at "http://unterstein.github.io/repo"

resolvers += "Spring milestones" at "http://repo.spring.io/milestone"

Add a dependency on the following artifact:

libraryDependencies += "com.github.unterstein" %% "play-elasticplugin" % "0.5.0"

Settings for the plugin go into the conf/application.conf:

elastic.serviceProviderClass="elastic.services.ElasticServiceProvider" # the provider class which holds the annotated elasticsearch beans

elastic.mode="embedded" # mode to run embedded or remote

# activate module
play.modules.enabled += "elasticplugin.ElasticModule"

embedded elastic config

elastic.mode="embedded"
elastic.embeddedTarget="target/elastic" # where to put the embedded target
elastic.clusterName="myCluster"
elastic.serviceProviderClass="elastic.services.ElasticServiceProviderImpl"
elastic.httpPort=9200 # define port where embedded ElasticSearch can be addressed via HTTP

Please note, that you need to start play with more memory, if you want to use elasticsearch as embedded database.

activator -J-Xmx2048m run

remote elastic config

elastic.mode="remote"
elastic.clusterName="myCluster"
elastic.serviceProviderClass="elastic.services.ElasticServiceProviderImpl"
elastic.remoteHost="localhost"
elastic.remotePort=9300

own elastic config

elastic.mode="own"
elastic.ownConfigurationClass="elastic.ExampleOwnConfiguration"

Usage

All elasticsearch relevant stuff must go to app/elastic/

All elasticsearch repositories go to app/elastic/repositories/

You need a class which must extend from elasticplugin.ElasticServiceProvider and must be configured in the application.conf under the key elastic.serviceProviderClass:

Example:

    @Component
    public class ElasticServiceProviderImpl extends ElasticServiceProvider {

      @Autowired
      public ElasticUserRepository elasticUserRepository;

      public static ElasticServiceProvider get() {
        return ElasticPlugin.get();
      }
    }

To access your repository you can call: ElasticServiceProviderImpl.get().elasticUserRepository.<do magic elastic stuff>

Take a look into the examples

TODO

• TBD

Old Versions

0.5.0 Introduced play module to initialize play-elasticplugin, thanks @raunak

0.4.0 spring-data-elasticsearch 1.4.0.BUILD-SNAPSHOT (is still snapshot, but works perfectly :)) and elasticsearch 2.2.0

0.3.0 enhanced plugin to handle custom configurations

0.2.0 Bugfix: Problems with spring-context when reloading during re-compile through play

0.1.0 Initial working version