esse 0.2.0 → 0.2.3

data/lib/esse/transport/indices.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+module Esse
+  class Transport
+    module InstanceMethods
+      # Creates an index with optional settings and mappings.
+      #
+      # @param options [Hash] Options hash
+      # @option [String] :index The name of the index
+      # @option [String] :wait_for_active_shards Set the number of active shards to wait for before the operation returns.
+      # @option [Time] :timeout Explicit operation timeout
+      # @option [Time] :master_timeout Specify timeout for connection to master
+      # @option [Hash] :headers Custom HTTP headers
+      # @option [Hash] :body The configuration for the index (`settings` and `mappings`)
+      # @option [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red)
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html
+      def create_index(index:, wait_for_status: nil, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.create_index') do |payload|
+          payload[:request] = opts = options.merge(index: index)
+          payload[:response] = response = coerce_exception { client.indices.create(**opts) }
+          if response && response['acknowledged']
+            coerce_exception do
+              cluster.wait_for_status!(status: (wait_for_status || cluster.wait_for_status), index: index)
+            end
+          end
+          response
+        end
+      end
+
+      # Returns information about whether a particular index exists.
+      #
+      # @option [List] :index A comma-separated list of index names
+      # @option [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+      # @option [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
+      # @option [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
+      # @option [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
+      # @option [Boolean] :flat_settings Return settings in flat format (default: false)
+      # @option [Boolean] :include_defaults Whether to return all default setting for each of the indices.
+      # @option [Hash] :headers Custom HTTP headers
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html
+      def index_exist?(index:, **options)
+        Esse::Events.instrument('elasticsearch.index_exist') do |payload|
+          payload[:request] = opts = options.merge(index: index)
+          payload[:response] = coerce_exception { client.indices.exists(**opts) }
+        end
+      end
+
+      # Deletes an index.
+      #
+      # @option [List] :index A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
+      # @option [Time] :timeout Explicit operation timeout
+      # @option [Time] :master_timeout Specify timeout for connection to master
+      # @option [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
+      # @option [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false)
+      # @option [String] :expand_wildcards Whether wildcard expressions should get expanded to open, closed, or hidden indices (options: open, closed, hidden, none, all)
+      # @option [Hash] :headers Custom HTTP headers
+      # @option [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red)
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html
+      def delete_index(index:, wait_for_status: nil, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.delete_index') do |payload|
+          payload[:request] = opts = options.merge(index: index)
+          payload[:response] = response = coerce_exception { client.indices.delete(**opts) }
+          if response && response['acknowledged']
+            coerce_exception do
+              cluster.wait_for_status!(status: (wait_for_status || cluster.wait_for_status), index: index)
+            end
+          end
+          response
+        end
+      end
+
+      # Open a previously closed index
+      #
+      # @option options [List] :index A comma separated list of indices to open
+      # @option options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
+      #   are open, closed or both. (options: open, closed)
+      # @option options [String] :ignore_indices When performed on multiple indices, allows to ignore
+      #   `missing` ones (options: none, missing) @until 1.0
+      # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+      #   unavailable (missing, closed, etc)
+      # @option options [Time] :timeout Explicit operation timeout
+      # @raise [Esse::Transport::ServerError]
+      #   in case of failure
+      # @return [Hash] the elasticsearch response
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-open.html
+      def open(index:, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.open') do |payload|
+          payload[:request] = attributes = options.merge(index: index)
+          payload[:response] = coerce_exception { client.indices.open(**attributes) }
+        end
+      end
+
+      # Close an index (keep the data on disk, but deny operations with the index).
+      #
+      # @option options [List] :index A comma separated list of indices to open
+      # @option options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
+      #   are open, closed or both. (options: open, closed)
+      # @option options [String] :ignore_indices When performed on multiple indices, allows to ignore
+      #   `missing` ones (options: none, missing) @until 1.0
+      # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+      #   unavailable (missing, closed, etc)
+      # @option options [Time] :timeout Explicit operation timeout
+      # @raise [Esse::Transport::ServerError] in case of failure
+      # @return [Hash] the elasticsearch response
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html
+      def close(index:, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.close') do |payload|
+          payload[:request] = attributes = options.merge(index: index)
+          payload[:response] = coerce_exception { client.indices.close(**attributes) }
+        end
+      end
+
+      # Performs the refresh operation in one or more indices.
+      #
+      # @option options [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
+      # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @option options [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 options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+      # @option options [Hash] :headers Custom HTTP headers
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html
+      def refresh(index:, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.refresh') do |payload|
+          payload[:request] = attributes = options.merge(index: index)
+          payload[:response] = coerce_exception { client.indices.refresh(**attributes) }
+        end
+      end
+
+      # Updates the index mappings.
+      #
+      # @option options [List] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices.
+      # @option options [Time] :timeout Explicit operation timeout
+      # @option options [Time] :master_timeout Specify timeout for connection to master
+      # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @option options [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 options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+      # @option options [Boolean] :write_index_only When true, applies mappings only to the write index of an alias or data stream
+      # @option options [Hash] :headers Custom HTTP headers
+      # @option options [Hash] :body The mapping definition (*Required*)
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html
+      def update_mapping(index:, body:, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.update_mapping') do |payload|
+          payload[:request] = opts = options.merge(index: index, body: body)
+          payload[:response] = coerce_exception { client.indices.put_mapping(**opts) }
+        end
+      end
+
+      # Updates the index settings.
+      #
+      # @option options [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
+      # @option options [Time] :master_timeout Specify timeout for connection to master
+      # @option options [Time] :timeout Explicit operation timeout
+      # @option options [Boolean] :preserve_existing Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`
+      # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @option options [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 options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+      # @option options [Boolean] :flat_settings Return settings in flat format (default: false)
+      # @option options [Hash] :headers Custom HTTP headers
+      # @option options [Hash] :body The index settings to be updated (*Required*)
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html
+      def update_settings(index:, body:, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.update_settings') do |payload|
+          payload[:request] = opts = options.merge(index: index, body: body)
+          payload[:response] = coerce_exception { client.indices.put_settings(**opts) }
+        end
+      end
+    end
+
+    include InstanceMethods
+  end
+end

data/lib/esse/transport/search.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Esse
+  class Transport
+    module InstanceMethods
+      # Returns results matching a query.
+      # @param [Hash] options
+      # @option [String] :index The comma-separated list of index names to search; use `_all` to perform the operation on all indices
+      def search(index:, **options)
+        definition = options.merge(
+          index: index,
+        )
+
+        Esse::Events.instrument('elasticsearch.search') do |payload|
+          payload[:request] = definition
+          payload[:response] = coerce_exception { client.search(definition) }
+        end
+      end
+
+      # Allows to retrieve a large numbers of results from a single search request.
+      #
+      # @param [Hash] options
+      # @option [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
+      # @option [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+      # @option [Hash] :body The scroll ID
+      def scroll(scroll:, **definition)
+        unless definition[:body]
+          raise ArgumentError, 'scroll search must have a :body with the :scroll_id'
+        end
+        Esse::Events.instrument('elasticsearch.search') do |payload|
+          payload[:request] = definition
+          payload[:response] = coerce_exception { client.scroll(scroll: scroll, **definition) }
+        end
+      end
+
+      # Explicitly clears the search context for a scroll.
+      #
+      # @param [Hash] options
+      # @option [Hash] :body Body with the "scroll_id" (string or array of strings) Scroll IDs to clear.
+      #   To clear all scroll IDs, use _all.
+      def clear_scroll(body:, **options)
+        coerce_exception { client.clear_scroll(body: body, **options) }
+      end
+    end
+
+    include InstanceMethods
+  end
+end

data/lib/esse/transport.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Esse
+  class Transport
+    require_relative './transport/aliases'
+    require_relative './transport/health'
+    require_relative './transport/indices'
+    require_relative './transport/search'
+    require_relative './transport/documents'
+
+    extend Forwardable
+
+    def_delegators :@cluster, :client, :throw_error_when_readonly!
+
+    attr_reader :cluster
+
+    def initialize(cluster)
+      @cluster = cluster
+    end
+
+    # Elasticsearch::Transport was renamed to Elastic::Transport in 8.0
+    # This lib should support both versions that's why we are wrapping up the transport
+    # errors to local errors.
+    #
+    # We are not only coercing exceptions but also the response body. Elasticsearch-ruby >= 8.0 returns
+    # the response wrapped in a Elasticsearch::API::Response::Response object. We are unwrapping it
+    # to keep the same interface. But we may want to coerce it to some internal object in the future.
+    def coerce_exception
+      resp = yield
+      if resp.class.name.start_with?('Elasticsearch::API::Response')
+        resp = resp.body
+      end
+      resp
+    rescue => exception
+      name = Hstring.new(exception.class.name)
+      if /^(Elasticsearch|Elastic|OpenSearch)?::Transport::Transport::Errors/.match?(name.value) && \
+          (exception_class = Esse::Transport::ERRORS[name.demodulize.value])
+        raise exception_class.new(exception.message)
+      else
+        raise exception
+      end
+    end
+  end
+end

data/lib/esse/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Esse
-  VERSION = '0.2.0'
+  VERSION = '0.2.3'
 end

data/lib/esse.rb

@@ -1,12 +1,22 @@
 # frozen_string_literal: true
 
-require_relative 'esse/core'
-require_relative 'esse/errors'
-require_relative 'esse/index'
+require 'multi_json'
+require 'forwardable'
+
+begin
+  require 'elasticsearch'
+rescue LoadError
+end
+
+begin
+  require 'opensearch'
+rescue LoadError
+end
 
 module Esse
-  SETTING_ROOT_KEY = 'settings'
-  MAPPING_ROOT_KEY = 'mappings'
+  SETTING_ROOT_KEY = :settings
+  MAPPING_ROOT_KEY = :mappings
+  DEFAULT_REPO_NAME = 'default'
   CLI_IGNORE_OPTS = %i[
     require
     silent
@@ -17,3 +27,8 @@ module Esse
     config/initializers/esse.rb
   ].freeze
 end
+
+require_relative 'esse/plugins'
+require_relative 'esse/core'
+require_relative 'esse/errors'
+require_relative 'esse/index'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: esse
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Marcos G. Zimmermann
-autorequire: 
+autorequire:
 bindir: exec
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2023-11-11 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: elasticsearch
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -212,9 +198,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
-description: All the elegance of ruby with the elasticsearch flexibility. This gem
-  is a pretty simple but excential helpers to deal with mapping, indexing, serialization
-  and search.
+description: With all elegance of Ruby and ElasticSearch flexibility this gem brings
+  to you the best of both worlds. Provides a solid architecture allowing to easily
+  Extract, Transform, Enrich and Load data from any data source into ElasticSearch/OpenSearch
+  and also to search it. It is framework-agnostic, which means you can use it with
+  any Ruby framework or even without any framework at all.
 email:
 - mgzmaster@gmail.com
 executables:
@@ -224,19 +212,6 @@ extra_rdoc_files: []
 files:
 - exec/esse
 - lib/esse.rb
-- lib/esse/backend/index.rb
-- lib/esse/backend/index/aliases.rb
-- lib/esse/backend/index/close.rb
-- lib/esse/backend/index/create.rb
-- lib/esse/backend/index/delete.rb
-- lib/esse/backend/index/documents.rb
-- lib/esse/backend/index/existance.rb
-- lib/esse/backend/index/open.rb
-- lib/esse/backend/index/refresh.rb
-- lib/esse/backend/index/reset.rb
-- lib/esse/backend/index/update.rb
-- lib/esse/backend/index_type.rb
-- lib/esse/backend/index_type/documents.rb
 - lib/esse/cli.rb
 - lib/esse/cli/base.rb
 - lib/esse/cli/event_listener.rb
@@ -252,42 +227,72 @@ 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/templates/collection.rb.erb
 - lib/esse/cli/templates/config.rb.erb
+- lib/esse/cli/templates/document.rb.erb
 - lib/esse/cli/templates/index.rb.erb
-- lib/esse/cli/templates/type_collection.rb.erb
-- lib/esse/cli/templates/type_mappings.json
-- lib/esse/cli/templates/type_serializer.rb.erb
+- lib/esse/cli/templates/mappings.json
+- lib/esse/cli/templates/settings.json
 - lib/esse/cluster.rb
+- lib/esse/cluster_engine.rb
+- lib/esse/collection.rb
 - lib/esse/config.rb
 - lib/esse/core.rb
+- lib/esse/deprecations.rb
+- lib/esse/deprecations/cluster.rb
+- lib/esse/deprecations/deprecate.rb
+- lib/esse/deprecations/index.rb
+- lib/esse/deprecations/index_backend_delegator.rb
+- lib/esse/deprecations/repository.rb
+- lib/esse/deprecations/repository_backend_delegator.rb
+- lib/esse/deprecations/serializer.rb
+- lib/esse/document.rb
+- lib/esse/dynamic_template.rb
 - lib/esse/errors.rb
 - lib/esse/events.rb
 - lib/esse/events/bus.rb
 - lib/esse/events/event.rb
 - lib/esse/events/publisher.rb
+- lib/esse/hash_document.rb
+- lib/esse/import/bulk.rb
+- lib/esse/import/request_body.rb
 - lib/esse/index.rb
 - lib/esse/index/actions.rb
-- lib/esse/index/backend.rb
+- lib/esse/index/aliases.rb
+- lib/esse/index/attributes.rb
 - lib/esse/index/base.rb
 - lib/esse/index/descendants.rb
+- lib/esse/index/documents.rb
+- lib/esse/index/indices.rb
 - lib/esse/index/inheritance.rb
 - lib/esse/index/mappings.rb
-- lib/esse/index/naming.rb
+- lib/esse/index/object_document_mapper.rb
+- lib/esse/index/plugins.rb
+- lib/esse/index/search.rb
 - lib/esse/index/settings.rb
 - lib/esse/index/type.rb
 - lib/esse/index_mapping.rb
 - lib/esse/index_setting.rb
-- lib/esse/index_type.rb
-- lib/esse/index_type/actions.rb
-- lib/esse/index_type/backend.rb
-- lib/esse/index_type/mappings.rb
 - lib/esse/logging.rb
-- lib/esse/object_document_mapper.rb
+- lib/esse/null_document.rb
+- lib/esse/plugins.rb
 - lib/esse/primitives.rb
 - lib/esse/primitives/hash_utils.rb
 - lib/esse/primitives/hstring.rb
 - lib/esse/primitives/output.rb
+- lib/esse/repository.rb
+- lib/esse/repository/actions.rb
+- lib/esse/repository/documents.rb
+- lib/esse/repository/object_document_mapper.rb
+- lib/esse/search/query.rb
+- lib/esse/search/response.rb
 - lib/esse/template_loader.rb
+- lib/esse/transport.rb
+- lib/esse/transport/aliases.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
 homepage: https://github.com/marcosgz/esse
 licenses:
@@ -296,7 +301,7 @@ metadata:
   homepage_uri: https://github.com/marcosgz/esse
   source_code_uri: https://github.com/marcosgz/esse
   changelog_uri: https://github.com/marcosgz/esse/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -311,9 +316,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
-summary: Pure Ruby toolkit based on official elasticsearch-ruby library. (No! It isn't
-  a new DSL)
+summary: Pure Ruby and framework-agnostic ElasticSearch/OpenSearch toolkit for building
+  indexers and searchers
 test_files: []

data/lib/esse/backend/index/aliases.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-module Esse
-  module Backend
-    class Index
-      module InstanceMethods
-        # Return a list of index aliases.
-        #
-        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
-        # @param options [Array] :index list of serialized documents to be indexed(Optional)
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-aliases.html
-        def aliases(**options)
-          response = client.indices.get_alias({ index: index_name, name: '*' }.merge(options))
-          idx_name = response.keys.find { |idx| idx.start_with?(index_name) }
-          return [] unless idx_name
-
-          response.dig(idx_name, 'aliases')&.keys || []
-        rescue Elasticsearch::Transport::Transport::Errors::NotFound
-          []
-        end
-
-        # Returns a list of indices.
-        #
-        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
-        # @return [Array] list of indices that match with `index_name`.
-        def indices(**options)
-          client.indices.get_alias({ name: index_name }.merge(options)).keys
-        rescue Elasticsearch::Transport::Transport::Errors::NotFound
-          []
-        end
-
-        # Replaces all existing aliases by the respective suffixed index from argument.
-        #
-        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
-        # @option [String] :suffix The suffix of the index used for versioning.
-        # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] in case of failure
-        # @return [Hash] the elasticsearch response
-        def update_aliases!(suffix:, **options)
-          raise(ArgumentError, 'index suffix cannot be nil') if suffix.nil?
-
-          options[:body] = {
-            actions: [
-              *indices.map do |index|
-                { remove: { index: index, alias: index_name } }
-              end,
-              { add: {index: build_real_index_name(suffix), alias: index_name } }
-            ],
-          }
-
-          Esse::Events.instrument('elasticsearch.update_aliases') do |payload|
-            payload[:request] = options
-            payload[:response] = client.indices.update_aliases(options)
-          end
-        end
-
-        # Replaces all existing aliases by the respective suffixed index from argument.
-        #
-        # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
-        # @option [String] :suffix The suffix of the index used for versioning.
-        # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] in case of failure
-        # @return [Hash] the elasticsearch response, or an hash with 'errors' as true in case of failure
-        def update_aliases(suffix:, **options)
-          update_aliases!(suffix: suffix, **options)
-        rescue Elasticsearch::Transport::Transport::Errors::NotFound
-          { 'errors' => true }
-        end
-      end
-
-      include InstanceMethods
-    end
-  end
-end

data/lib/esse/backend/index/close.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module Esse
-  module Backend
-    class Index
-      module InstanceMethods
-        # Close an index (keep the data on disk, but deny operations with the index).
-        #
-        # @option options [String, nil] :suffix The index suffix. Defaults to the index_version.
-        #   Use nil if you want to check existence of the `index_name` index or alias.
-        # @option options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
-        #   are open, closed or both. (options: open, closed)
-        # @option options [String] :ignore_indices When performed on multiple indices, allows to ignore
-        #   `missing` ones (options: none, missing) @until 1.0
-        # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #   unavailable (missing, closed, etc)
-        # @option options [Time] :timeout Explicit operation timeout
-        # @raise [Elasticsearch::Transport::Transport::Errors::BadRequest, Elasticsearch::Transport::Transport::Errors::NotFound]
-        #   in case of failure
-        # @return [Hash] the elasticsearch response
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html
-        def close!(suffix: index_version, **options)
-          Esse::Events.instrument('elasticsearch.close') do |payload|
-            payload[:request] = attributes = options.merge(index: index_name(suffix: suffix))
-            payload[:response] = client.indices.close(**attributes)
-          end
-        end
-
-        # Close an index (keep the data on disk, but deny operations with the index).
-        #
-        # @option options [String, nil] :suffix The index suffix. Defaults to the index_version.
-        #   Use nil if you want to check existence of the `index_name` index or alias.
-        # @option options [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that
-        #   are open, closed or both. (options: open, closed)
-        # @option options [String] :ignore_indices When performed on multiple indices, allows to ignore
-        #   `missing` ones (options: none, missing) @until 1.0
-        # @option options [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-        #   unavailable (missing, closed, etc)
-        # @option options [Time] :timeout Explicit operation timeout
-        # @return [Hash] the elasticsearch response, or an hash with 'errors' as true in case of failure
-        #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html
-        def close(suffix: index_version, **options)
-          close!(suffix: suffix, **options)
-        rescue Elasticsearch::Transport::Transport::ServerError
-          { 'errors' => true }
-        end
-      end
-
-      include InstanceMethods
-    end
-  end
-end