Elasticsearch Grails plugin - Sample App

A sample app for the Elasticsearch Grails plugin. The plugin homepage is maintained by Noam Y. Tenne and hosted at https://github.com/noamt/elasticsearch-grails-plugin.

Why?

If you're used to grails but have never used Elasticsearch, chances are you'll be a bit lost after installing the plugin. Elasticsearch is as powerful as it is complicated to understand for the newcomers.

This sample app aims to make it easier on users to get what the plugin actually enables in terms of mapping, indexing and searching via ES.

How

In order to fully understand the relationship between the different cases implemented with this project, it is recommended to use it in the following way:

• Experiment with the different available client modes by changing the options in Config.groovy

Domains

The domains in this application try to use as extensiveley the mapping options provided by the plugin. To find a specific mapping, please refer to the following list:

#### Domain class TODO

• Many-to-One mapping (in Musician and Song domains).
• parent / child mapping (in Musician and Song domains).
• geoPoint mapping (in Location domain).
• multi_field mapping (in Song domain's title field).
• converter mapping.
• excludeFromAll mapping.
• index mapping.
• analyzer mapping (in Song domain's title field).

In order to understand the impact of each mapping option, it is strongly recommended that you check the JSON results after launching the app using curl. Your command should look like the following:

  curl -XGET localhost:9200/org.elasticsearch.plugin.sample/_mapping?pretty

Search

There are many different approaches to searching indexed documents using the plugin, as well as many different query, filter and facets options. The following list shows what is currently implemented and what will be in the future:

Search TODO

• queries:
  • has_child (see MusicianService.searchMusicianOrderBySongCount)
  • filtered
  • fuzzy_like_this: see SongService.searchSongFuzzyTitle and songService.searchSongFuzzyTitleAnalyzer.
  • analyzer: see songService.searchSongFuzzyTitleAnalyzer
• filters:
  • geoDistance
• sorts:
  • sortBuilder.fieldSort (see MusicianService.searchMusicianOrderBySongCountMissingLast).
  • field sort via Domain.search([sort: 'foo', order: 'bar'], { ... }) (see MusicianService.searchMusicianOrderBySongCount).
  • multiple fields sorting via multiple sortBuilders (see MusicianService.searchMusicianOrderBySongCountMissingLast).
  • sortBuilders.geoDistanceSort

Integration tests

This is not currently working

Important The integration tests need a filled index to work. If you are using elasticSearch.client.mode as 'local' (which is the default option), make sure you clear the index and run the app before using the test-app command from the project root folder:

rm -r data/
grails run-app
grails stop-app

Here are the integration tests that need to be implemented to insure that the sample works correctly:

• Musician Service
  • searchMusicianOrderBySongCount()
  • searchMusicianOrderBySongCountMissingLast
• Song Service
  • searchSongFuzzyTitle
  • searchSongFuzzyTitleAnalyzer

If you want something implemented, feel free to create an issue on this repository or tweet @MonsieurCelsius and I'll see what I can do..

License

/*
 * Copyright 2013-14 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.
 */

Here, have a donkey

         __
 __   (__`\
(__`\   \\`\
 `\\`\   \\ \
   `\\`\  \\ \
     `\\`\#\\ \#
       \_ ##\_ |##
       (___)(___)##
        (0)  (0)`\##
         |~   ~ , \##
         |      |  \##
         |     /\   \##         __..---'''''-.._.._
         |     | \   `\##  _.--'                _  `.
         Y     |  \    `##'                     \`\  \
        /      |   \                             | `\ \
       /_...___|    \                            |   `\\
      /        `.    |                          /      ##
     |          |    |                         /      ####
     |          |    |                        /       ####
     | () ()    |     \     |          |  _.-'         ##
     `.        .'      `._. |______..| |-'|
       `------'           | | | |    | || |
                          | | | |    | || |
                          | | | |    | || |
                          | | | |    | || |     Joan Stark
                    _____ | | | |____| || |
               jgs /     `` |-`/     ` |` |
                   \________\__\_______\__\
                    """""""""   """""""'"""