(Quick Reference)

1 Introduction - Reference Documentation

Authors: Manuarii Stein, Stephane Maldini, Serge P. Nekoval

Version: 0.18.7.1-SNAPSHOT

Table of Contents

1 Introduction

The ElasticSearch plugin intends to implement a simple integration with Grails of the Open Source Search Engine ElasticSearch, which is based on Lucene and provide distributed capabilities.

The plugin focus on exposing Grails domain classes for the moment. It highly takes the existing Searchable Plugin as reference for its syntax and behavior.

Note that the plugin is still under development, so you may not be able to use all the features of ElasticSearch yet. As for now, you should only use this plugin for testing purpose since you may lack some functionalities in a production environment.

In addition to this document, you may want to read the official ElasticSearch documentation here.

1.1 Features

  • Maps domain classes to their corresponding index in ElasticSearch
  • Provides an ElasticSearch service for cross-domain searching
  • Injects domain class methods for specific domain searching, indexing and unindexing
  • Automatically mirrors any changes made throught Hibernate to the index
  • Allow to use the Groovy Content Builder DSL for search queries
  • Support for term highlighting

1.2 History

History

  • February 01, 2012
    • maintenance release 0.18.7.1-SNAPSHOT
  • October 25, 2011
    • 0.17.8.1 release
  • March 25, 2011
    • 0.15.2.1 release
  • March 8, 2011
    • 0.15.1.1 release
  • December 16, 2010
    • initial 0.13.0a release

Authors and Contributors

Manuarii Stein (doc4web consulting), Stephane Maldini (doc4web consulting), Serge P. Nekoval

Get the full and updated list of contributors on the github repository.

Licence

Doc4web consulting and the contributors provide this plugin without any guarantees under Apache Software Licence 2.

Copyright 2002-2011 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.

Previous work

Graeme Rocher started the first draft which this plugin is based on.