Mastico
Make common queries simple, and make some complex queries possible.
Why does this exists?
Creating Elasticsearch queries requires a specialist or hours of comparing Stack Overflow posts.
Chewy makes managing and updating indexes simple, but the query interface remains the same.
Example 1:
Mastico creates queries based on a list of fields:
query = FooIndex.query
query = Mastico::Query.new(fields: [:title, description], query: "ciao").apply(query)
This creates a series of queries: word, prefix, infix and fuzzy match of the word ciao
against the supplied fields.
Example 2:
What if I want to block some words ("Stop words") of give ore weight to others?
def weight(word)
case word
when "I"
0
else
1.0
end
end
query = Mastico::Query.new(fields: [:title, description], word_weight: method(:weight), query: "I like cheese").apply(query)
Example 3:
What if I don't want all the different types of matching?
query = Mastico::Query.new(fields: {title: {boost: 4.0, types: [:term]} }, query: "Simple").apply(query)
This will return only the term
type search for the attribute title
.
Installation
Add this line to your application's Gemfile:
gem 'mastico'
And then execute:
$ bundle
Or install it yourself as:
$ gem install mastico
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/cantierecreativo/mastico. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.