README.asciidoc

Elasticsearch Grails plugin

Documentation about the plugin

How can I obtain the plugin?

Just like any other Grails plugin, through the Grails Plugin center. Edit your project’s build.gradle file, by adding the plugin’s dependency declaration:

build.gradle:

dependencies {
    ...
    implementation "org.grails.plugins:elasticsearch:3.0.0-RC1"
    ...
}

Versioning

In order to simply the versioning, with v3.0.0.M1 the Elasticsearch Grails plugin is using Semantic Versioning 2.0.0. To understand what that means, please see the specification documentation

Plugin Version	Grails Version	Elasticsearch Version
3.0.0	4.0.x	7.8.0
2.7.0	3.3.x	7.3.0
2.5.0	3.3.x	5.5.3
2.4.2	3.3.y	5.4.3
2.4.1	3.3.x	5.4.3
2.4.0	3.3.y	5.4.3
1.4.1	3.1.y	5.4.1
1.2.1	3.2.y	2.3.z
1.2.0	3.1.y	2.3.z
1.0.0.x	3.1.y	1.6.z
0.1.0.x	2.y	2.1.z
0.0.4.x	2.y	1.6.z

Example Configuration for Grails 4

In the following we demonstrate two example configurations using Hibernate or MongoDB as a datastore.

Hibernate

Check out the demo application using hibernate and grails4.

Add the following to your grails-app/conf/application.yml:

elasticSearch:
    plugin:
        mapperAttachment:
            enabled: false
    client:
        mode: transport
        hosts:
        - {host: localhost, port: 9200}
    cluster.name: elasticsearch
    bulkIndexOnStartup: true
    datastoreImpl: hibernateDatastore

MongoDB

build.gradle:

dependencies {
  compile 'org.grails.plugins:mongodb:7.0.0'
}

grails-app/conf/application.yml:

elasticSearch:
    plugin:
        mapperAttachment:
            enabled: false
    client:
        mode: transport
        hosts:
        - {host: localhost, port: 9200}
    cluster.name: elasticsearch
    bulkIndexOnStartup: true
    datastoreImpl: mongoDatastore

Memory analysis done with YourKit

YourKit supports open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of YourKit Java Profiler and YourKit .NET Profiler, innovative and intelligent tools for profiling Java and .NET applications.

License

Copyright 2014 the original author or authors.

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.

NOTE

This project is a fork based on the great work done by the guys at:

• https://github.com/mstein/elasticsearch-grails-plugin

• https://github.com/noamt/elasticsearch-grails-plugin

Why would you want to fork the original Elasticsearch plugin?

The original Elasticsearch plugin relies on Hibernate-specific GORM components, thus rendering it unusable if you back your Grails application by any other database.

Here, have a yak:

                            _,,,_
                        .-'`  (  '.
                     .-'    ,_  ;  \___      _,
                 __.'    )   \'.__.'(:;'.__.'/
         __..--""       (     '.__{':');}__.'
       .'         (    ;    (   .-|` '  |-.
      /    (       )     )      '-p     q-'
     (    ;     ;          ;    ; |.---.|
     ) (              (      ;    \ o  o)
     |  )     ;       |    )    ) /'.__/
     )    ;  )    ;   | ;       //
     ( )             _,\    ;  //
     ; ( ,_,,-~""~`""   \ (   //
      \_.'\\_            '.  /<_
       \\_)--\             \ \--\
   jgs )--\""`             )--\"`
       `""`                `""`