Git Product home page Git Product logo

elasticsearch_autocomplete's Introduction

ElasticsearchAutocomplete

Build Status Dependency Status

Simple autocomplete for rails models using awesome Elasticsearch and tire gem

Example app

Look at ElasticsearchAutocomplete example app

Installation

Add this line to your application's Gemfile:

gem 'elasticsearch_autocomplete'

And then execute:

$ bundle

Or install it yourself as:

$ gem install elasticsearch_autocomplete

Basic Usage

Specify attributes for autocompletion. By default, this is name attribute:

class User < ActiveRecord::Base
  ac_field :full_name
end

Don't forget to rebuild elasticsearch index:

    $ rake environment tire:import CLASS='User' FORCE=true

To find suggestions call ac_search method on your model. It return Tire::Results::Collection instance:

User.ac_search('Alex').map(&:full_name)
=> ['Alex First', 'Alexandr Second']

You can specify fields for suggestions search:

class User < ActiveRecord::Base
  ac_field :full_name, :search_fields => [:full_name, :email]
end

For search on localized fields such as name_en, name_ru:

class Product < ActiveRecord::Base
  ac_field :name, :localized => true
end

If you want to define settings and mapping for elasticsearch index yourselves:

class Product < ActiveRecord::Base
  ac_field :name, :skip_settings => true
end

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

elasticsearch_autocomplete's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.