esse 0.4.0.rc2 → 0.4.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 378f933ddf41a9d403121e9272b87814a01ee9e462eea5b9ad556d1ba593e46a
-  data.tar.gz: b3551d3361c380b750ca4e52c065d3372e6ec0c5762526f0f65894c097c79163
+  metadata.gz: 1b78836cea90af6c95e5bad1fec44c734733e21dab660cbb338a79546f2539d5
+  data.tar.gz: 0d1e073bbcc3ab1576d134ab4c70e2231767b836f59652f2f41b56e5943cc585
 SHA512:
-  metadata.gz: f70d6495c34e176226a16e22da5e04b3ac74cce0d3469a3fa3ddf61c133a402d5577113839b0f4a52935cc71564be08930b529e25abb610c6bee1fcdadad77bb
-  data.tar.gz: 1cd02580736bb222d0a6e3e7a26fbdc17e925dafbc8cda97eb87fb911c85f1dac4c32543ffdde3418fade6a632722492147278f6c293184d42cae6ccc2a3ee28
+  metadata.gz: 4118d2d6d2d163456f09c487b391abfb7522d4c1900e1517d94a8414b3f14587abf7e3fbb8292321933c767cb21b981c03f829ec2bd12f4cbc7327aa34cbe3e4
+  data.tar.gz: 80cdb7b8ccdb6ca158ca95207b0f9363b3edd19edddc6e9d29c168cb03ae04d520f110c752dd604b19665891cde2ce787db9eb18ca0119d155b90f1150527d38

data/lib/esse/cli/event_listener.rb

@@ -102,6 +102,32 @@ module Esse
           to: colorize(event[:request].dig(:body, :dest, :index), :bold),
           runtime: formatted_runtime(event[:runtime])
       end
+
+      def elasticsearch_task(event)
+        running_time_in_nanos = event[:response].dig('task', 'running_time_in_nanos')
+        runtime = running_time_in_nanos ? "#{running_time_in_nanos / 1_000_000} ms" : 'unknown'
+
+        case event[:response]['completed']
+        when true
+          print_message '[%<runtime>s] Task %<task_id>s successfuly completed. %<total_runtime>s',
+            task_id: colorize(event[:request][:id], :bold),
+            runtime: formatted_runtime(event[:runtime]),
+            total_runtime: colorize("Elapsed time: #{runtime}", :bold)
+        when false
+          description = event[:response].dig('task', 'description')
+          print_message '[%<runtime>s] Task %<task_id>s still in progress: %<description>s. %<total_runtime>s',
+            task_id: colorize(event[:request][:id], :bold),
+            description: description,
+            runtime: formatted_runtime(event[:runtime]),
+            total_runtime: colorize("Elapsed time: #{runtime}", :bold)
+        end
+      end
+
+      def elasticsearch_cancel_task(event)
+        print_message '[%<runtime>s] Task %<task_id>s successfuly canceled',
+          task_id: colorize(event[:request][:id], :bold),
+          runtime: formatted_runtime(event[:runtime])
+      end
     end
   end
 end

data/lib/esse/cli/index.rb

@@ -15,13 +15,15 @@ module Esse
         * Delete the old index.
       DESC
       option :suffix, type: :string, default: nil, aliases: '-s', desc: 'Suffix to append to index name'
-      option :import, type: :boolean, default: true, desc: 'Import documents before point alias to the new index'
-      option :reindex, type: :boolean, default: false, desc: 'Use _reindex API to import documents from the old index to the new index'
+      option :import, desc: 'Import documents before point alias to the new index'
+      option :reindex, desc: 'Use _reindex API to import documents from the old index to the new index'
       option :optimize, type: :boolean, default: true, desc: 'Optimize index before import documents by disabling refresh_interval and setting number_of_replicas to 0'
       option :settings, type: :hash, default: nil, desc: 'List of settings to pass to the index class. Example: --settings=refresh_interval:1s,number_of_replicas:0'
       def reset(*index_classes)
         require_relative 'index/reset'
         opts = HashUtils.deep_transform_keys(options.to_h, &:to_sym)
+        opts[:reindex] = Parser::BoolOrHash.new(:reindex, default: false).parse(opts[:reindex])
+        opts[:import] = Parser::BoolOrHash.new(:import, default: true).parse(opts[:import])
         if opts[:import] && opts[:reindex]
           raise ArgumentError, 'You cannot use --import and --reindex together'
         end
@@ -100,7 +102,6 @@ module Esse
       option :preload_lazy_attributes, type: :string, default: nil, desc: 'Command separated list of lazy document attributes to preload using search API before the bulk import. Or pass `true` to preload all lazy attributes'
       option :eager_load_lazy_attributes, type: :string, default: nil, desc: 'Comma separated list of lazy document attributes to include to the bulk index request. Or pass `true` to include all lazy attributes'
       option :update_lazy_attributes, type: :string, default: nil, desc: 'Comma separated list of lazy document attributes to bulk update after the bulk index request Or pass `true` to include all lazy attributes'
-
       def import(*index_classes)
         require_relative 'index/import'
         opts = HashUtils.deep_transform_keys(options.to_h, &:to_sym)

data/lib/esse/cli/parser/bool_or_hash.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Esse
+  module CLI
+    module Parser
+      FALSEY = [false, 'false', 'FALSE', 'f', 'F'].freeze
+      TRUTHY = [true, 'true', 'TRUE', 't', 'T'].freeze
+      HASH_MATCHER = /([\w\.\-]+)\:([^\s]+)/.freeze
+      HASH_SEPARATOR = /[\s]+/.freeze
+      ARRAY_SEPARATOR = /[\,]+/.freeze
+
+      class BoolOrHash
+        def initialize(key, default: nil)
+          @key = key
+          @default = default
+        end
+
+        def parse(input)
+          return true if TRUTHY.include?(input)
+          return false if FALSEY.include?(input)
+          return input if input.is_a?(Hash)
+          return @default if input.nil?
+          return true if @key.to_s == input
+          return @default unless HASH_MATCHER.match?(input)
+
+          compact_hash = input.to_s.split(HASH_SEPARATOR).each_with_object({}) do |pair, hash|
+            key, val = pair.match(HASH_MATCHER).captures
+            hash[key.to_sym] = may_array(val)
+          end
+          return @default if compact_hash.empty?
+
+          Esse::HashUtils.explode_keys(compact_hash)
+        end
+
+        private
+
+        def may_array(value)
+          return cast(value) unless ARRAY_SEPARATOR.match?(value)
+
+          value.split(ARRAY_SEPARATOR).map { |v| cast(v) }
+        end
+
+        def cast(value)
+          case value
+          when *TRUTHY then true
+          when *FALSEY then false
+          when /\A\d+\z/ then value.to_i
+          when /\A\d+\.\d+\z/ then value.to_f
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/esse/cli.rb

@@ -3,6 +3,7 @@
 require 'thor'
 
 require_relative 'primitives/output'
+require_relative 'cli/parser/bool_or_hash'
 require_relative 'cli/index'
 require_relative 'cli/generate'
 require_relative 'cli/event_listener'

data/lib/esse/events.rb

@@ -58,5 +58,9 @@ module Esse
     register_event 'elasticsearch.get'
     register_event 'elasticsearch.reindex'
     register_event 'elasticsearch.update_by_query'
+    register_event 'elasticsearch.delete_by_query'
+    register_event 'elasticsearch.tasks'
+    register_event 'elasticsearch.task'
+    register_event 'elasticsearch.cancel_task'
   end
 end

data/lib/esse/index/documents.rb

@@ -315,6 +315,20 @@ module Esse
         cluster.api.update_by_query(**definition)
       end
 
+      # Delete documents by query
+      #
+      # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+      # @option [String, nil] :suffix The index suffix. Defaults to the nil.
+      #
+      # @return [Hash] The elasticsearch response hash
+      def delete_by_query(suffix: nil, **options)
+        definition = {
+          index: index_name(suffix: suffix),
+        }.merge(options)
+        cluster.may_update_type!(definition)
+        cluster.api.delete_by_query(**definition)
+      end
+
       protected
 
       def document?(doc)

data/lib/esse/index/indices.rb

@@ -53,8 +53,11 @@ module Esse
 
         suffix ||= Esse.timestamp
         suffix = Esse.timestamp while index_exist?(suffix: suffix)
+        syncronous_import = true
+        syncronous_import = false if reindex.is_a?(Hash) && reindex[:wait_for_completion] == false
 
-        if optimize && import
+        optimized_creation = optimize && syncronous_import && (import || reindex)
+        if optimized_creation
           definition = [settings_hash(settings: settings), mappings_hash].reduce(&:merge)
           number_of_replicas = definition.dig(Esse::SETTING_ROOT_KEY, :index, :number_of_replicas)
           refresh_interval = definition.dig(Esse::SETTING_ROOT_KEY, :index, :refresh_interval)
@@ -68,28 +71,55 @@ module Esse
         if index_exist? && aliases.none?
           cluster.api.delete_index(index: index_name)
         end
+
         if import
           import_kwargs = import.is_a?(Hash) ? import : {}
-          import_kwargs[:refresh] ||= refresh if refresh
+          import_kwargs[:refresh] ||= refresh unless refresh.nil?
           import(**options, **import_kwargs, suffix: suffix)
         elsif reindex && (source_indexes = indices_pointing_to_alias).any?
           reindex_kwargs = reindex.is_a?(Hash) ? reindex : {}
-          reindex_kwargs[:wait_for_completion] = true unless reindex_kwargs.key?(:wait_for_completion)
+          reindex_kwargs[:refresh] ||= refresh unless refresh.nil?
           source_indexes.each do |from|
-            cluster.api.reindex(**options, body: { source: { index: from }, dest: { index: index_name(suffix: suffix) } }, refresh: refresh)
+            reindex(**reindex_kwargs, body: {
+              source: { index: from },
+              dest: { index: index_name(suffix: suffix) }
+            })
           end
         end
 
-        if optimize && import && number_of_replicas != new_number_of_replicas || refresh_interval != new_refresh_interval
+        if optimized_creation && number_of_replicas != new_number_of_replicas || refresh_interval != new_refresh_interval
           update_settings(suffix: suffix, settings: settings)
           refresh(suffix: suffix)
         end
 
-        update_aliases(suffix: suffix)
+        update_aliases(suffix: suffix) if syncronous_import
 
         true
       end
 
+      # Copies documents from a source to a destination.
+      #
+      # To avoid http timeout, we are sending the request with `wait_for_completion: false` and polling the task
+      # until it is completed.
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
+      def reindex(body:, wait_for_completion: true, scroll: '30m', poll_interval: 5, **options)
+        resp = cluster.api.reindex(**options, body: body, scroll: scroll, wait_for_completion: false)
+        return resp unless wait_for_completion
+
+        task_id = resp['task']
+        task = nil
+        begin
+          while (task = cluster.api.task(id: task_id))['completed'] == false
+            sleep poll_interval.to_i
+          end
+        rescue Interrupt => e
+          cluster.api.cancel_task(id: task_id)
+          raise e
+        end
+        task
+      end
+
       # Checks the index existance. Returns true or false
       #
       #   UsersIndex.index_exist? #=> true

data/lib/esse/transport/cluster.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Esse
+  class Transport
+    module InstanceMethods
+      # Returns basic information about the health of the cluster.
+      #
+      # @option [List] :index Limit the information returned to a specific index
+      # @option [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+      # @option [String] :level Specify the level of detail for returned information (options: cluster, indices, shards)
+      # @option [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+      # @option [Time] :master_timeout Explicit operation timeout for connection to master node
+      # @option [Time] :timeout Explicit operation timeout
+      # @option [String] :wait_for_active_shards Wait until the specified number of shards is active
+      # @option [String] :wait_for_nodes Wait until the specified number of nodes is available
+      # @option [String] :wait_for_events Wait until all currently queued events with the given priority are processed (options: immediate, urgent, high, normal, low, languid)
+      # @option [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating shards in the cluster
+      # @option [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no initializing shards in the cluster
+      # @option [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red)
+      # @option [Hash] :headers Custom HTTP headers
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html
+      def health(**options)
+        coerce_exception { client.cluster.health(**options) }
+      end
+
+      # Returns information about the tasks currently executing on one or more nodes in the cluster.
+      #
+      # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+      # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+      # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
+      # @option arguments [Boolean] :detailed Return detailed task information (default: false)
+      # @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
+      # @option arguments [List] :h Comma-separated list of column names to display
+      # @option arguments [Boolean] :help Return help information
+      # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
+      # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
+      # @option arguments [Boolean] :v Verbose mode. Display column headers
+      # @option arguments [Hash] :headers Custom HTTP headers
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
+      def tasks(**options)
+        Esse::Events.instrument('elasticsearch.tasks') do |payload|
+          payload[:request] = options
+          payload[:response] = coerce_exception { client.tasks.list(**options) }
+        end
+      end
+
+      def task(id:, **options)
+        Esse::Events.instrument('elasticsearch.task') do |payload|
+          payload[:request] = { id: id }.merge(options)
+          payload[:response] = coerce_exception { client.tasks.get(task_id: id, **options) }
+        end
+      end
+
+      def cancel_task(id:, **options)
+        Esse::Events.instrument('elasticsearch.cancel_task') do |payload|
+          payload[:request] = { id: id }.merge(options)
+          payload[:response] = coerce_exception { client.tasks.cancel(task_id: id, **options) }
+        end
+      end
+    end
+
+    include InstanceMethods
+  end
+end

data/lib/esse/transport/documents.rb

@@ -192,6 +192,104 @@ module Esse
           response
         end
       end
+
+
+      # Performs an update on every document in the index without changing the source,
+      # for example to pick up a mapping change.
+      #
+      # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (*Required*)
+      # @option arguments [String] :analyzer The analyzer to use for the query string
+      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
+      # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
+      # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
+      # @option arguments [Number] :from Starting offset (default: 0)
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
+      # @option arguments [String] :conflicts What to do when the update by query hits version conflicts? (options: abort, proceed)
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+      # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
+      # @option arguments [String] :pipeline Ingest pipeline to set on index requests made by this action. (default: none)
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
+      # @option arguments [String] :q Query in the Lucene query string syntax
+      # @option arguments [List] :routing A comma-separated list of specific routing values
+      # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
+      # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
+      # @option arguments [Number] :size Deprecated, please use `max_docs` instead
+      # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
+      # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
+      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
+      # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
+      # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
+      # @option arguments [Boolean] :version_type Should the document increment the version number (internal) on hit or not (reindex)
+      # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting
+      # @option arguments [Boolean] :refresh Should the affected indexes be refreshed?
+      # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
+      # @option arguments [Number] :scroll_size Size on the scroll request powering the update by query
+      # @option arguments [Boolean] :wait_for_completion Should the request should block until the update by query operation is complete.
+      # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
+      # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The search definition using the Query DSL
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html
+      def update_by_query(index:, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.update_by_query') do |payload|
+          payload[:request] = opts = options.merge(index: index)
+          payload[:response] = coerce_exception { client.update_by_query(**opts) }
+        end
+      end
+
+      # Deletes documents matching the provided query.
+      #
+      # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
+      # @option arguments [String] :analyzer The analyzer to use for the query string
+      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
+      # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
+      # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
+      # @option arguments [Number] :from Starting offset (default: 0)
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
+      # @option arguments [String] :conflicts What to do when the delete by query hits version conflicts? (options: abort, proceed)
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+      # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
+      # @option arguments [String] :q Query in the Lucene query string syntax
+      # @option arguments [List] :routing A comma-separated list of specific routing values
+      # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
+      # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
+      # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
+      # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
+      # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
+      # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
+      # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
+      # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting
+      # @option arguments [Boolean] :refresh Should the affected indexes be refreshed?
+      # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
+      # @option arguments [Number] :scroll_size Size on the scroll request powering the delete by query
+      # @option arguments [Boolean] :wait_for_completion Should the request should block until the delete by query is complete.
+      # @option arguments [Number] :requests_per_second The throttle for this request in sub-requests per second. -1 means no throttle.
+      # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body The search definition using the Query DSL (*Required*)
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
+      def delete_by_query(index:, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.delete_by_query') do |payload|
+          payload[:request] = opts = options.merge(index: index)
+          payload[:response] = coerce_exception { client.delete_by_query(**opts) }
+        end
+      end
     end
 
     include InstanceMethods

data/lib/esse/transport/indices.rb

@@ -210,58 +210,6 @@ module Esse
           payload[:response] = coerce_exception { client.reindex(**opts) }
         end
       end
-
-      # Performs an update on every document in the index without changing the source,
-      # for example to pick up a mapping change.
-      #
-      # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (*Required*)
-      # @option arguments [String] :analyzer The analyzer to use for the query string
-      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
-      # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
-      # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
-      # @option arguments [Number] :from Starting offset (default: 0)
-      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
-      # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-      # @option arguments [String] :conflicts What to do when the update by query hits version conflicts? (options: abort, proceed)
-      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-      # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
-      # @option arguments [String] :pipeline Ingest pipeline to set on index requests made by this action. (default: none)
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
-      # @option arguments [String] :q Query in the Lucene query string syntax
-      # @option arguments [List] :routing A comma-separated list of specific routing values
-      # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
-      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
-      # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
-      # @option arguments [Number] :size Deprecated, please use `max_docs` instead
-      # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
-      # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
-      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
-      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
-      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
-      # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
-      # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
-      # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
-      # @option arguments [Boolean] :version_type Should the document increment the version number (internal) on hit or not (reindex)
-      # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting
-      # @option arguments [Boolean] :refresh Should the affected indexes be refreshed?
-      # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
-      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
-      # @option arguments [Number] :scroll_size Size on the scroll request powering the update by query
-      # @option arguments [Boolean] :wait_for_completion Should the request should block until the update by query operation is complete.
-      # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
-      # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.
-      # @option arguments [Hash] :headers Custom HTTP headers
-      # @option arguments [Hash] :body The search definition using the Query DSL
-      #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html
-      def update_by_query(index:, **options)
-        throw_error_when_readonly!
-
-        Esse::Events.instrument('elasticsearch.update_by_query') do |payload|
-          payload[:request] = opts = options.merge(index: index)
-          payload[:response] = coerce_exception { client.update_by_query(**opts) }
-        end
-      end
     end
 
     include InstanceMethods

data/lib/esse/transport.rb

@@ -3,7 +3,7 @@
 module Esse
   class Transport
     require_relative './transport/aliases'
-    require_relative './transport/health'
+    require_relative './transport/cluster'
     require_relative './transport/indices'
     require_relative './transport/search'
     require_relative './transport/documents'

data/lib/esse/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Esse
-  VERSION = '0.4.0.rc2'
+  VERSION = '0.4.0.rc4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esse
 version: !ruby/object:Gem::Version
-  version: 0.4.0.rc2
+  version: 0.4.0.rc4
 platform: ruby
 authors:
 - Marcos G. Zimmermann
 autorequire:
 bindir: exec
 cert_chain: []
-date: 2024-09-11 00:00:00.000000000 Z
+date: 2024-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -228,6 +228,7 @@ files:
 - lib/esse/cli/index/update_aliases.rb
 - lib/esse/cli/index/update_mapping.rb
 - lib/esse/cli/index/update_settings.rb
+- lib/esse/cli/parser/bool_or_hash.rb
 - lib/esse/cli/templates/collection.rb.erb
 - lib/esse/cli/templates/config.rb.erb
 - lib/esse/cli/templates/document.rb.erb
@@ -296,8 +297,8 @@ files:
 - lib/esse/template_loader.rb
 - lib/esse/transport.rb
 - lib/esse/transport/aliases.rb
+- lib/esse/transport/cluster.rb
 - lib/esse/transport/documents.rb
-- lib/esse/transport/health.rb
 - lib/esse/transport/indices.rb
 - lib/esse/transport/search.rb
 - lib/esse/version.rb

data/lib/esse/transport/health.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Esse
-  class Transport
-    module InstanceMethods
-      # Returns basic information about the health of the cluster.
-      #
-      # @option [List] :index Limit the information returned to a specific index
-      # @option [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
-      # @option [String] :level Specify the level of detail for returned information (options: cluster, indices, shards)
-      # @option [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
-      # @option [Time] :master_timeout Explicit operation timeout for connection to master node
-      # @option [Time] :timeout Explicit operation timeout
-      # @option [String] :wait_for_active_shards Wait until the specified number of shards is active
-      # @option [String] :wait_for_nodes Wait until the specified number of nodes is available
-      # @option [String] :wait_for_events Wait until all currently queued events with the given priority are processed (options: immediate, urgent, high, normal, low, languid)
-      # @option [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating shards in the cluster
-      # @option [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no initializing shards in the cluster
-      # @option [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red)
-      # @option [Hash] :headers Custom HTTP headers
-      #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html
-      def health(**options)
-        coerce_exception { client.cluster.health(**options) }
-      end
-    end
-
-    include InstanceMethods
-  end
-end