Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add runtime_mappings support #887

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

### New Features

* [#887](https://github.com/toptal/chewy/pull/887): Add support [runtime_mappings](https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html). ([@TakuyaKurimoto](https://github.com/TakuyaKurimoto))
### Changes

### Bugs Fixed
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1171,6 +1171,16 @@ scope.each do |wrapper|
end
```

#### runtime_mappings

You can define runtime fields in a search request as described [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html):

```ruby
CitiesIndex.runtime_mappings(
field1: {type: 'keyword', :script=>{:lang => "painless", :source => "emit('some script here')"}}
)
```

### Rake tasks

For a Rails application, some index-maintaining rake tasks are defined.
Expand Down
14 changes: 14 additions & 0 deletions lib/chewy/search/parameters/runtime_mappings.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
module Chewy
module Search
class Parameters
# Just a standard hash storage. Nothing to see here.
#
# @see Chewy::Search::Parameters::HashStorage
# @see Chewy::Search::Request#runtime_mappings
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html
class RuntimeMappings < Storage
include HashStorage
end
end
end
end
20 changes: 18 additions & 2 deletions lib/chewy/search/request.rb
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class Request
search_type preference limit offset terminate_after
timeout min_score source stored_fields search_after
load script_fields suggest aggs aggregations collapse none
indices_boost rescore highlight total total_count
indices_boost rescore highlight runtime_mappings total total_count
total_entries indices types delete_all count exists?
exist? find pluck scroll_batches scroll_hits
scroll_results scroll_wrappers ignore_unavailable
Expand Down Expand Up @@ -656,7 +656,23 @@ def load(options = nil)
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/highlighting.html
# @param value [Hash]
# @return [Chewy::Search::Request]
%i[script_fields indices_boost rescore highlight].each do |name|
#
# @!method runtime_mappings(value)
# Add a `runtime_mappings` part to the request. Further
# call values are merged to the storage hash.
#
# @example
# PlacesIndex
# .runtime_mappings(field1: {type: "keyword", :script=>{:lang=>"painless", :source=>"emit('some script here')"}})
# .runtime_mappings(field2: {type: "keyword", :script=>{:lang=>"painless", :source=>"emit('some script here')"}})
# # => <PlacesIndex::Query {..., :body=>{:runtime_mappings=>{
# # "field1"=>{:type=>"keyword", :script=>{:lang=>"painless", :source=>"emit('some script here')"}},
# # "field2"=>{:type=>"keyword", :script=>{:lang=>"painless", :source=>"emit('some script here')"}}}}}>
# @see Chewy::Search::Parameters::ScriptFields
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-search-request.html
# @param value [Hash]
# @return [Chewy::Search::Request]
%i[script_fields indices_boost rescore highlight runtime_mappings].each do |name|
define_method name do |value|
modify(name) { update!(value) }
end
Expand Down
5 changes: 5 additions & 0 deletions spec/chewy/search/parameters/runtime_mappings_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
require 'chewy/search/parameters/hash_storage_examples'

describe Chewy::Search::Parameters::RuntimeMappings do
it_behaves_like :hash_storage, :runtime_mappings
end
2 changes: 1 addition & 1 deletion spec/chewy/search/request_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@
specify { expect { subject.stored_fields(:foo) }.not_to change { subject.render } }
end

%i[script_fields highlight].each do |name|
%i[script_fields highlight runtime_mappings].each do |name|
describe "##{name}" do
specify { expect(subject.send(name, foo: {bar: 42}).render[:body]).to include(name => {'foo' => {bar: 42}}) }
specify do
Expand Down