elasticsearch_record 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8e00649a9c1e9451d8ea006078889081a70cb178a3d0f23336d157929eefafc
-  data.tar.gz: '0596785a16b974b95a48ccb2bb3cb6a334ce553e8d80b1b82691ee98df18fe3b'
+  metadata.gz: 8a386dd571b2e88a62e26f815c16783d3fda97ed911b4edffa4db884230dfc18
+  data.tar.gz: a50697c2043a3160c31716d07d9afbe05bab691267773b92f424bead64193ecb
 SHA512:
-  metadata.gz: 61301e89b67d34fd4ed604a782c85b84bd2316f98c7b67ddf293ad2a27e17e30531b905e7ecdc5a4d9dad34099d9feab8603269b2ee0e680b2a0cd2ff39835d3
-  data.tar.gz: d7d208605dbbe0c09acccacda2ac6deba8a69f85540046ac098b555b9bc5212e7c19c137df1957f0b692112dc694f2a3913538671183e18052061f417f1dbd4b
+  metadata.gz: 4c3172895b50805a17964e0db2406b90fd5797c40d91d17ee9c0cea2a26d0b52d328663f5b44ff882d32bf490662146ef5064040361ae5a677d97868078332b5
+  data.tar.gz: 3d86fb89924f99c2ad64e44c225f78c434cabcbadc4660dfa8032c5038394b05b5ab949abd93d9895b3a7148c07f12ac99374c8cee1c2ce805f2188eab6be143

data/README.md

@@ -55,10 +55,6 @@ Or install it yourself as:
   * logs Elasticsearch API-calls
   * shows Runtime in logs
 
-## Contra - what it _(currently)_ can not
-* Joins to other indexes or databases
-* complex, combined or nested queries ```and, or, Model.arel ...```
-
 ## Setup
 
 ### a) Update your **database.yml** and add a elasticsearch connection:
@@ -255,12 +251,51 @@ _see simple documentation about these methods @ [rubydoc](https://rubydoc.info/g
 - find_by_query
 - msearch
 
+### Useful model API methods
+Fast access to model-related methods for easier access without creating a overcomplicated method call.
+
+Access these methods through the model class method `.api`.
+```ruby
+  # returns mapping of model class
+  klass.api.mappings
+
+  # e.g. for ElasticUser model
+  ElasticUser.api.mappings
+
+  # insert new raw data
+  ElasticUser.api.insert([{name: 'Hans', age: 34}, {name: 'Peter', age: 22}])
+```
+
+* open
+* close
+* refresh
+* block
+* unblock
+* mappings
+* metas
+* settings
+* aliases
+* state
+* schema
+* exists?
+* alias_exists?
+* setting_exists?
+* mapping_exists?
+* meta_exists?
+
+Fast insert, update, delete raw data
+* index
+* insert
+* update
+* delete
+* bulk
+
 ## ActiveRecord ConnectionAdapters table-methods
-Access these methods through the model's connection.
+Access these methods through the model class method `.connection`.
 
 ```ruby
   # returns mapping of provided table (index)
-  model.connection.table_mappings('table-name')
+  klass.connection.table_mappings('table-name')
 ```
 
 - table_mappings

data/docs/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ElasticsearchRecord - CHANGELOG
 
+## [1.4.0] - 2023-01-27
+* [add] `ElasticsearchRecord::ModelApi` for fast & easy access the elasticsearch index - callable through `.api` (e.g. ElasticUser.api.mappings)
+* [ref] `ElasticsearchRecord::Instrumentation::LogSubscriber` to truncate the query-string (default: 1000)
+* [ref] `ActiveRecord::ConnectionAdapters::ElasticsearchAdapter#log` with extra attribute (log: true) to prevent logging (e.g. on custom api calls)
+* [fix] `ElasticsearchRecord::Result#bucket` to prevent resolving additional meta key (key_as_string)
+
 ## [1.3.1] - 2023-01-18
 * [fix] `#none!` method to correctly invalidate the query (String(s) in where-queries like '1=0' will raise now)
 * [fix] missing 'ChangeSettingDefinition' & 'RemoveSettingDefinition' @ `ActiveRecord::ConnectionAdapters::Elasticsearch::UpdateTableDefinition::COMPOSITE_DEFINITIONS` to composite in a single query

data/lib/active_record/connection_adapters/elasticsearch_adapter.rb

@@ -216,14 +216,15 @@ module ActiveRecord # :nodoc:
       # @param [Hash] arguments - action arguments
       # @param [String (frozen)] name - the logging name
       # @param [Boolean] async - send async (default: false) - currently not supported
+      # @param [Boolean] log - send log to instrumenter (default: true)
       # @return [Elasticsearch::API::Response, Object]
-      def api(namespace, action, arguments = {}, name = 'API', async: false)
+      def api(namespace, action, arguments = {}, name = 'API', async: false, log: true)
         raise ::StandardError, 'ASYNC api calls are not supported' if async
 
         # resolve the API target
         target = namespace == :core ? @connection : @connection.__send__(namespace)
 
-        log("#{namespace}.#{action}", arguments, name, async: async) do
+        log("#{namespace}.#{action}", arguments, name, async: async, log: log) do
           response = ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
             target.__send__(action, arguments)
           end
@@ -274,16 +275,24 @@ module ActiveRecord # :nodoc:
       end
 
       # provide a custom log instrumenter for elasticsearch subscribers
-      def log(gate, arguments, name, async: false, &block)
-        @instrumenter.instrument(
-          "query.elasticsearch_record",
-          gate:      gate,
-          name:      name,
-          arguments: gate == 'core.msearch' ? arguments.deep_dup : arguments,
-          async:     async) do
-          @lock.synchronize(&block)
-        rescue => e
-          raise translate_exception_class(e, arguments, [])
+      def log(gate, arguments, name, async: false, log: true, &block)
+        if log
+          @instrumenter.instrument(
+            "query.elasticsearch_record",
+            gate:      gate,
+            name:      name,
+            arguments: gate == 'core.msearch' ? arguments.deep_dup : arguments,
+            async:     async) do
+            @lock.synchronize(&block)
+          rescue => e
+            raise translate_exception_class(e, arguments, [])
+          end
+        else
+          begin
+            @lock.synchronize(&block)
+          rescue => e
+            raise translate_exception_class(e, arguments, [])
+          end
         end
       end
 

data/lib/elasticsearch_record/core.rb

@@ -3,7 +3,6 @@ module ElasticsearchRecord
     extend ActiveSupport::Concern
 
     included do
-
       # Rails resolves the primary_key's value by accessing the +#id+ method.
       # Since Elasticsearch also supports an additional, independent +id+ attribute, it would only be able to access
       # this through +read_attribute(:id)+.
@@ -84,10 +83,11 @@ module ElasticsearchRecord
         cache.compute_if_absent(key) { ElasticsearchRecord::StatementCache.create(connection, &block) }
       end
 
-      # not supported atm - maybe enable in future versions to resolve migrations easier
-      # def primary_class? # :nodoc:
-      #   self == ::ElasticsearchRecord::Base
-      # end
+      # used to provide fast access to the connection API without explicit providing table-related parameters.
+      # @return [anonymous Struct]
+      def api
+        ElasticsearchRecord::ModelApi.new(self)
+      end
 
       private
 

data/lib/elasticsearch_record/gem_version.rb

@@ -8,8 +8,8 @@ module ElasticsearchRecord
 
   module VERSION
     MAJOR = 1
-    MINOR = 3
-    TINY  = 1
+    MINOR = 4
+    TINY  = 0
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/lib/elasticsearch_record/instrumentation/log_subscriber.rb

@@ -5,7 +5,7 @@ module ElasticsearchRecord
     # attach to ElasticsearchRecord related events
     class LogSubscriber < ActiveSupport::LogSubscriber
 
-      IGNORE_PAYLOAD_NAMES = %w[SCHEMA EXPLAIN]
+      IGNORE_PAYLOAD_NAMES = %w[SCHEMA EXPLAIN EXCLUDE]
 
       def self.runtime=(value)
         Thread.current["elasticsearch_record_runtime"] = value
@@ -37,17 +37,18 @@ module ElasticsearchRecord
                end
         name = "CACHE #{name}" if payload[:cached]
 
-        # nice feature: displays the REAL query-time (_qt)
+        # nice feature: displays the REAL query-time from elasticsearch response (_qt)
+        # this is handled through the +::ActiveRecord::ConnectionAdapters::ElasticsearchAdapter#api+ method
         name = "#{name} (took: #{payload[:arguments][:_qt].round(1)}ms)" if payload[:arguments][:_qt]
 
         # build query
-        query = payload[:arguments].except(:_qt).inspect.gsub(/:(\w+)=>/, '\1: ').presence || '-'
+        query = payload[:arguments].except(:_qt).inspect.gsub(/:(\w+)=>/, '\1: ').truncate((payload[:truncate] || 1000), omission: color(' (pruned)', RED))
 
         # final coloring
         name  = color(name, name_color(payload[:name]), true)
         query = color(query, gate_color(payload[:gate]), true) if colorize_logging
 
-        debug "  #{name} #{query}"
+        debug "  #{name} #{query.presence || '-/-'}"
       end
 
       private

data/lib/elasticsearch_record/model_api.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module ElasticsearchRecord
+  class ModelApi
+    attr_reader :klass
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    # undelegated schema methods: clone rename create drop
+    # those should not be quick-accessible, since they might end in heavily broken index
+
+    # delegated dangerous methods (created with exclamation mark)
+    # not able to provide individual arguments - always the defaults will be used
+    %w(open close refresh block unblock).each do |method|
+      define_method("#{method}!") do
+        _connection.send("#{method}_table", _index_name)
+      end
+    end
+
+    # delegated table methods
+    %w(mappings metas settings aliases state schema exists?).each do |method|
+      define_method(method) do |*args|
+        _connection.send("table_#{method}", _index_name, *args)
+      end
+    end
+
+    # delegated plain methods
+    %w(alias_exists? setting_exists? mapping_exists? meta_exists?).each do |method|
+      define_method(method) do |*args|
+        _connection.send(method, _index_name, *args)
+      end
+    end
+
+    # fast insert/update data.
+    #
+    # @example
+    #   index([{name: 'Hans', age: 34}, {name: 'Peter', age: 22}])
+    #
+    #   index({id: 5, name: 'Georg', age: 87})
+    #
+    # @param [Array<Hash>,Hash] data
+    # @param [Hash] options
+    def index(data, **options)
+      bulk(data, :index, **options)
+    end
+
+    # fast insert new data.
+    #
+    # @example
+    #   insert([{name: 'Hans', age: 34}, {name: 'Peter', age: 22}])
+    #
+    #   insert({name: 'Georg', age: 87})
+    #
+    # @param [Array<Hash>,Hash] data
+    # @param [Hash] options
+    def insert(data, **options)
+      bulk(data, :create, **options)
+    end
+
+    # fast update existing data.
+    #
+    # @example
+    #   update([{id: 1, name: 'Hansi'}, {id: 2, name: 'Peter Parker', age: 42}])
+    #
+    #   update({id: 3, name: 'Georg McCain'})
+    #
+    # @param [Array<Hash>,Hash] data
+    # @param [Hash] options
+    def update(data, **options)
+      bulk(data, :update, **options)
+    end
+
+    # fast delete data.
+    #
+    # @example
+    #   delete([1,2,3,5])
+    #
+    #   delete(3)
+    #
+    #   delete({id: 2})
+    #
+    # @param [Array<Hash>,Hash] data
+    # @param [Hash] options
+    def delete(data, **options)
+      data = [data] unless data.is_a?(Array)
+
+      if data[0].is_a?(Hash)
+        bulk(data, :delete, **options)
+      else
+        bulk(data.map{|id| {id: id}}, :delete, **options)
+      end
+    end
+
+    # bulk handle provided data (single Hash or multiple Array<Hash>).
+    # @param [Hash,Array<Hash>] data - the data to insert/update/delete ...
+    # @param [Symbol] operation
+    # @param [Boolean, Symbol] refresh
+    def bulk(data, operation = :index, refresh: true, **options)
+      data = [data] unless data.is_a?(Array)
+
+      _connection.api(:core, :bulk, {
+        index:   _index_name,
+        body:    data.map{|item| {operation => {_id: item[:id], data: item.except(:id)}}},
+        refresh: refresh
+      }, "BULK #{operation.to_s.upcase}", **options)
+    end
+
+    private
+
+    def _index_name
+      klass.index_name
+    end
+
+    def _connection
+      klass.connection
+    end
+  end
+end

data/lib/elasticsearch_record/result.rb

@@ -256,7 +256,7 @@ module ElasticsearchRecord
       else
         # resolve sub-aggregations / nodes without 'meta' keys.
         # if this results in an empty hash, the return will be nil
-        node.except(:key, :doc_count, :doc_count_error_upper_bound, :sum_other_doc_count).transform_values { |val| _resolve_bucket(val) }.presence
+        node.except(:key, :doc_count, :doc_count_error_upper_bound, :sum_other_doc_count, :key_as_string).transform_values { |val| _resolve_bucket(val) }.presence
       end
     end
 

data/lib/elasticsearch_record.rb

@@ -23,6 +23,7 @@ module ElasticsearchRecord
     autoload :Base
     autoload :Core
     autoload :ModelSchema
+    autoload :ModelApi
     autoload :Persistence
     autoload :Querying
     autoload :Query

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch_record
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Tobias Gonsior
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -97,7 +97,7 @@ dependencies:
 description: 'ElasticsearchRecord is a ActiveRecord adapter and provides similar functionality
   for Elasticsearch.
 
-  '
+'
 email:
 - info@ruby-smart.org
 executables: []
@@ -107,7 +107,6 @@ files:
 - ".rspec"
 - ".yardopts"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - docs/CHANGELOG.md
@@ -159,6 +158,7 @@ files:
 - lib/elasticsearch_record/instrumentation/controller_runtime.rb
 - lib/elasticsearch_record/instrumentation/log_subscriber.rb
 - lib/elasticsearch_record/instrumentation/railtie.rb
+- lib/elasticsearch_record/model_api.rb
 - lib/elasticsearch_record/model_schema.rb
 - lib/elasticsearch_record/patches/active_record/relation_merger_patch.rb
 - lib/elasticsearch_record/patches/arel/select_core_patch.rb
@@ -191,7 +191,7 @@ metadata:
   source_code_uri: https://github.com/ruby-smart/elasticsearch_record
   documentation_uri: https://rubydoc.info/gems/elasticsearch_record
   changelog_uri: https://github.com/ruby-smart/elasticsearch_record/blob/main/docs/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -206,8 +206,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: ActiveRecord adapter for Elasticsearch
 test_files: []

data/Gemfile.lock

@@ -1,73 +0,0 @@
-PATH
-  remote: .
-  specs:
-    elasticsearch_record (1.2.4)
-      activerecord (~> 7.0.0)
-      elasticsearch (~> 8.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (7.0.4)
-      activesupport (= 7.0.4)
-    activerecord (7.0.4)
-      activemodel (= 7.0.4)
-      activesupport (= 7.0.4)
-    activesupport (7.0.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    concurrent-ruby (1.1.10)
-    diff-lcs (1.5.0)
-    elastic-transport (8.1.0)
-      faraday (< 3)
-      multi_json
-    elasticsearch (8.5.2)
-      elastic-transport (~> 8)
-      elasticsearch-api (= 8.5.2)
-    elasticsearch-api (8.5.2)
-      multi_json
-    faraday (2.7.2)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
-    i18n (1.12.0)
-      concurrent-ruby (~> 1.0)
-    minitest (5.16.3)
-    multi_json (1.15.0)
-    rake (13.0.6)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.1)
-    ruby2_keywords (0.0.5)
-    tzinfo (2.0.5)
-      concurrent-ruby (~> 1.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-    yard-activesupport-concern (0.0.1)
-      yard (>= 0.8)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  elasticsearch_record!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  yard (~> 0.9)
-  yard-activesupport-concern (~> 0.0.1)
-
-BUNDLED WITH
-   2.3.18