Elasticsearch integrations for ActiveModel/Record and Ruby on Rails
Pull request Compare This branch is 249 commits behind elastic:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
elasticsearch-model
elasticsearch-rails
.gitignore
.travis.yml
CONTRIBUTING.md
Gemfile
README.md
Rakefile

README.md

Elasticsearch

This repository contains ActiveModel, ActiveRecord and Ruby on Rails integrations for Elasticsearch:

  • ActiveModel integration with adapters for ActiveRecord and Mongoid
  • Enumerable-based wrapper for search results
  • ActiveRecord::Relation-based wrapper for returning search results as records
  • Convenience model methods such as search, mapping, import, etc
  • Rake tasks for importing the data
  • Kaminari-based pagination support
  • Integration with Rails's instrumentation framework
  • Templates for generating example Rails application

Elasticsearch client and Ruby API is provided by the elasticsearch-ruby project.

Installation

The libraries are compatible with Ruby 1.9.3 and higher.

Install the elasticsearch-model and/or elasticsearch-rails package from Rubygems:

gem install elasticsearch-model elasticsearch-rails

To use an unreleased version, either add it to your Gemfile for Bundler:

gem 'elasticsearch-model', git: 'git://github.com/elasticsearch/elasticsearch-rails.git'
gem 'elasticsearch-rails', git: 'git://github.com/elasticsearch/elasticsearch-rails.git'

or install it from a source code checkout:

git clone https://github.com/elasticsearch/elasticsearch-rails.git
cd elasticsearch-model
bundle install
rake install
cd elasticsearch-rails
bundle install
rake install

Usage

This project is split into two separate gems:

  • elasticsearch-model, which contains model-related features such as setting up indices, search method, pagination, etc

  • elasticsearch-rails, which contains features for Ruby on Rails applications

Example of a basic integration into an ActiveRecord-based model:

require 'elasticsearch/model'

class Article < ActiveRecord::Base
  include Elasticsearch::Model
  include Elasticsearch::Model::Callbacks
end

Article.import

@articles = Article.search('foobar').records

You can generate a fully working Ruby on Rails application with a single command:

rails new searchapp --skip --skip-bundle --template https://raw.github.com/elasticsearch/elasticsearch-rails/master/elasticsearch-rails/lib/rails/templates/01-basic.rb

Please refer to each library documentation for detailed information and examples.

Model

Rails

License

This software is licensed under the Apache 2 license, quoted below.

Copyright (c) 2014 Elasticsearch <http://www.elasticsearch.org>

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.