searchkick 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf57aedd7e85672dd9bc5f60f22719af2f5cb1797e1afa8f16c426ea291dd4db
-  data.tar.gz: 54542375eb2cb3c5b7917304cd7e68530a826641c8f1a556af551083964a8849
+  metadata.gz: cb0777c063adddb2c339761f92c7ffaf3646daf869b7360dafe662ce0b38056b
+  data.tar.gz: '062070815d5b78a2cb3b7c4f0dc9408730e8facd72ce223d25a6bafe9bd46d12'
 SHA512:
-  metadata.gz: 5029c0fc16c139f4358786400aad6c36751c6335221e9985f66e5ac308152817db9cd41e709ff6f2b18e731842c85b1a17b9aaeb649b7895393e7001aad8426d
-  data.tar.gz: 63bd24be4b7b41c539c0acd0c0c8bc6502095707539d235f8ddc9fc49aa2634c2fb602e40ce77e771d151945118d2c4da73d26bcda8c4290d61eae4b6c44b468
+  metadata.gz: b3c08562e9a52dc950ff74ebb532beac936367e75c3a2e794079217caed899c566df50265e602c75d13e44eafd03c09821cfb10a88398d0897e5b0a85c76cf7d
+  data.tar.gz: c211a672924cec7627d0bf9b1e700c8ef6d037a745a7867e39b3cf8302f8f84d163d6911a893b0f8adf4073bf3f624cb517224e96522d0b5e209b081300a12f7

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 4.0.2
+
+- Added block form of `scroll`
+- Added `clear_scroll` method
+- Fixed custom mappings
+
 ## 4.0.1
 
 - Added support for scroll API

data/README.md

@@ -37,6 +37,7 @@ Plus:
 - [Performance](#performance)
 - [Elasticsearch DSL](#advanced)
 - [Reference](#reference)
+- [Testing](#testing)
 
 ## Getting Started
 
@@ -1479,18 +1480,26 @@ indices_boost: {Category => 2, Product => 1}
 
 ## Scroll API
 
-To retrieve a very large number of results, use the [scroll API](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html).
+Searchkick also supports the [scroll API](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html). Scrolling is not intended for real time user requests, but rather for processing large amounts of data.
+
+```ruby
+Product.search("*", scroll: "1m").scroll do |batch|
+  # process batch ...
+end
+```
+
+You can also scroll batches manually.
 
 ```ruby
 products = Product.search "*", scroll: "1m"
 while products.any?
-  # do something ...
+  # process batch ...
 
   products = products.scroll
 end
-```
 
-You should call `scroll` on each new set of results, not the original result.
+products.clear_scroll
+```
 
 ## Nested Data
 

data/lib/searchkick/index_options.rb

@@ -13,7 +13,7 @@ module Searchkick
         index_type = index_type.call if index_type.respond_to?(:call)
       end
 
-      custom_mapping = options[:mapping] || {}
+      custom_mapping = options[:mappings] || {}
       if below70 && custom_mapping.keys.map(&:to_sym).include?(:properties)
         # add type
         custom_mapping = {index_type => custom_mapping}
@@ -23,7 +23,6 @@ module Searchkick
         settings = options[:settings] || {}
         mappings = custom_mapping
       else
-
         default_type = "text"
         default_analyzer = :searchkick_index
         keyword_mapping = {type: "keyword"}

data/lib/searchkick/query.rb

@@ -435,6 +435,7 @@ module Searchkick
           warn "[searchkick] WARNING: Passing child models to models option throws off hits and pagination - use type option instead"
 
           # uncomment once aliases are supported with _index
+          # see https://github.com/elastic/elasticsearch/issues/23306
           # index_type_or =
           #   models.map do |m|
           #     v = {_index: m.searchkick_index.name}

data/lib/searchkick/results.rb

@@ -228,22 +228,44 @@ module Searchkick
     def scroll
       raise Searchkick::Error, "Pass `scroll` option to the search method for scrolling" unless scroll_id
 
-      params = {
-        scroll: options[:scroll],
-        scroll_id: scroll_id
-      }
+      if block_given?
+        records = self
+        while records.any?
+          yield records
+          records = records.scroll
+        end
 
-      begin
-        Searchkick::Results.new(@klass, Searchkick.client.scroll(params), @options)
-      rescue Elasticsearch::Transport::Transport::Errors::NotFound => e
-        if e.class.to_s =~ /NotFound/ && e.message =~ /search_context_missing_exception/i
-          raise Searchkick::Error, "Scroll id has expired"
-        else
-          raise e
+        records.clear_scroll
+      else
+        params = {
+          scroll: options[:scroll],
+          scroll_id: scroll_id
+        }
+
+        begin
+          # TODO Active Support notifications for this scroll call
+          Searchkick::Results.new(@klass, Searchkick.client.scroll(params), @options)
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound => e
+          if e.class.to_s =~ /NotFound/ && e.message =~ /search_context_missing_exception/i
+            raise Searchkick::Error, "Scroll id has expired"
+          else
+            raise e
+          end
         end
       end
     end
 
+    def clear_scroll
+      begin
+        # try to clear scroll
+        # not required as scroll will expire
+        # but there is a cost to open scrolls
+        Searchkick.client.clear_scroll(scroll_id: scroll_id)
+      rescue Elasticsearch::Transport::Transport::Error
+        # do nothing
+      end
+    end
+
     private
 
     def results_query(records, hits)

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "4.0.1"
+  VERSION = "4.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-30 00:00:00.000000000 Z
+date: 2019-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel