elasticsearch_record 1.1.0 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cf2af35e8ed5eb94892c5e1c6c5a7b11fab36539a48a3106b3444862c3654fc
-  data.tar.gz: 63f47637943c1e65e8d2a53c9f887b57ca5bdb139c4b6575997abbd640f2586d
+  metadata.gz: 41575ee0aefe81ed3069dc81c1c0d9062ea841998a7bb4affaab885dad0a4291
+  data.tar.gz: 73e98d4b6aad0fda63df0fff562537245f2d4c95fb5f53d67ad891550d8e6b1b
 SHA512:
-  metadata.gz: 96f3ce41b50dc97f5e4d9cdf79bf5b58af5bedcf219edee5d5d22a88b6517efcad0f3d7a0e26ca0042493d83a59d274a3f33d80ec4e16032c7ec50dfcb6790b2
-  data.tar.gz: c041e7d0bc2e00dd006d1c5b87e403b03f2e9c98a55672f636b29821a318425dc72aabff46e439a4c1281c914f1a07ac86487961f06930fac4169d538a2b9888
+  metadata.gz: ed60e5fe591f92169d51f333c600338cd4fcee46ca6ca988625399ee522068e3b5c67738fe5b9f3fcc1cede6491cfb1b969c525d5b1af2f2ed03e93b7303237f
+  data.tar.gz: eb51b9dc16d0457905fb15589ff2542dfe0a8f59678459be910726305a3b0527e3ddcee6d7e5271e2db0d658dabd5f476eea71b4dca27c1f99375d987de50f0b

data/.yardopts

@@ -1,4 +1,6 @@
 --embed-mixins
 --markup=markdown
 --files docs/*.*
---plugin relative_markdown_links
+--plugin relative_markdown_links
+--plugin activesupport-concern
+--exclude lib/elasticsearch_record/patches

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    elasticsearch_record (1.1.0)
+    elasticsearch_record (1.2.4)
       activerecord (~> 7.0.0)
       elasticsearch (~> 8.4)
 
@@ -28,7 +28,7 @@ GEM
       elasticsearch-api (= 8.5.2)
     elasticsearch-api (8.5.2)
       multi_json
-    faraday (2.7.1)
+    faraday (2.7.2)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
@@ -56,6 +56,8 @@ GEM
     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
@@ -65,6 +67,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   yard (~> 0.9)
+  yard-activesupport-concern (~> 0.0.1)
 
 BUNDLED WITH
    2.3.18

data/README.md

@@ -136,7 +136,7 @@ scope.where(kind: :undefined).offset(10).update_all(name: "New Name")
 ### Refactored ```where``` method:
 Different to the default where-method you can now use it in different ways.
 
-Using it by default with a Hash, the method decides itself to either add a filter, or must_not query.
+Using it by default with a Hash, the method decides itself to either add a filter, or must_not clause.
 
 _Hint: If not provided through ```#kind```-method a default kind **:bool** will be used._
 ```ruby
@@ -209,6 +209,8 @@ total = scope.total
 - aggs_only!
 - total_only!
 
+_see simple documentation about these methods @ [rubydoc](https://rubydoc.info/gems/elasticsearch_record/ElasticsearchRecord/Relation/QueryMethods)_
+
 ### Available calculation methods
 - percentiles
 - percentile_ranks
@@ -219,6 +221,8 @@ total = scope.total
 - sum
 - calculate
 
+_see simple documentation about these methods @ [rubydoc](https://rubydoc.info/gems/elasticsearch_record/ElasticsearchRecord/Relation/CalculationMethods)_
+
 ### Available result methods
 - aggregations
 - buckets
@@ -231,6 +235,8 @@ total = scope.total
 - point_in_time
 - pit_results
 
+_see simple documentation about these methods @ [rubydoc](https://rubydoc.info/gems/elasticsearch_record/ElasticsearchRecord/Relation/ResultMethods)_
+
 ### Additional methods 
 - to_query
 
@@ -240,20 +246,24 @@ total = scope.total
 - index_base_name
 - relay_id_attribute
 
-### Useful model instance methods
+### Useful model class methods
+- auto_increment?
+- max_result_window
 - source_column_names
 - searchable_column_names
 - find_by_query
 - msearch
 
-## ActiveRecord ConnectionAdapters schema-methods
+## ActiveRecord ConnectionAdapters table-methods
 Access these methods through the model's connection.
+
 ```ruby
   # returns mapping of provided table (index)
   model.connection.table_mappings('table-name')
 ```
 
 - table_mappings
+- table_metas
 - table_settings
 - table_aliases
 - table_state
@@ -261,12 +271,14 @@ Access these methods through the model's connection.
 - alias_exists?
 - setting_exists?
 - mapping_exists?
+- meta_exists?
 - max_result_window
 - cluster_info
 
 ## Active Record Schema migration methods
 Access these methods through the model's connection or within any `Migration`.
 
+**cluster actions:**
 - open_table
 - open_tables
 - close_table
@@ -274,8 +286,15 @@ Access these methods through the model's connection or within any `Migration`.
 - truncate_table
 - truncate_tables
 - drop_table
+- block_table
+- unblock_table
+- clone_table
 - create_table
 - change_table
+
+**table actions:**
+- change_meta
+- delete_meta
 - add_mapping
 - change_mapping
 - change_mapping_meta
@@ -299,11 +318,15 @@ class AddTests < ActiveRecord::Migration[7.0]
       t.setting :number_of_shards, "1"
       t.setting :number_of_replicas, 0
     end
+
+    # changes the auto-increment value
+    change_meta "assignments", :auto_increment, 3625
     
     create_table "settings", force: true do |t|
       t.mapping :created_at, :date
-      t.mapping :key, :keyword do |m|
+      t.mapping :key, :integer do |m|
         m.primary_key = true
+        m.auto_increment = 10
       end
       t.mapping :status, :keyword
       t.mapping :updated_at, :date
@@ -315,11 +338,11 @@ class AddTests < ActiveRecord::Migration[7.0]
     end
 
     add_mapping "settings", :active, :boolean do |m|
-      m.comment = "Hans"
+      m.comment = "Contains the active state"
     end
 
     change_table 'settings', force: true do |t|
-      t.add_setting( "index.search.idle.after", "20s")
+      t.add_setting("index.search.idle.after", "20s")
       t.add_setting("index.shard.check_on_startup", true)
       t.add_alias('supersettings')
     end
@@ -337,9 +360,6 @@ class AddTests < ActiveRecord::Migration[7.0]
       t.timestamps
     end
 
-    change_mapping_meta "vintage", :number, auto_increment: 'true'
-    change_mapping_meta "vintage", :number, peter: 'hans'
-
     change_mapping_attributes "vintage", :number, fields: {raw: {type: :keyword}}
   end
 

data/docs/CHANGELOG.md

@@ -1,6 +1,45 @@
 # ElasticsearchRecord - CHANGELOG
 
-## [1.1.0] - 2022-12-02
+## [1.2.4] - 2022-12-15
+* [fix] missing `#visit_Arel_Nodes_In` method in `Arel::Visitors::ElasticsearchQuery` to build array conditions
+* [fix] resolving buckets from relation `ElasticsearchRecord::Result#buckets` not recognizing sub-buckets
+
+## [1.2.3] - 2022-12-12
+* [fix] `change_table` 'if_exists: true' returns at the wrong state
+
+## [1.2.2] - 2022-12-12
+* [add] `:if_exists` option for `change_table`
+* [fix] executing `_compute_table_name` irregular on some schema methods and some not - not only executes on `create_table` and `change_table`
+* [ref] private `_compute_table_name` method to public `compute_table_name`
+* [ref] drop `_compute_table_name` on methods: open_table, close_table, truncate_table, drop_table, block_table, unblock_table & clone_table
+
+## [1.2.1] - 2022-12-12
+* [add] `ActiveRecord::ConnectionAdapters::Elasticsearch::SchemaStatements#access_id_fielddata?` which checks the clusters setting 'indices.id_field_data.enabled' to determinate if a general sorting on the +_id+-field is possible or not.
+* [add] `ElasticsearchRecord::Relation#ordered_relation` which overwrites the original method to check against the `#access_id_fielddata?` method
+* [fix] default order by '_id' causes an exception if clusters 'indices.id_field_data.enabled' is disabled
+* [fix] subfield where-condition `where('field.subfield', 'value')` was transformed into a nested 'join-table' hash
+* [fix] yardoc docs & generation
+
+## [1.2.0] - 2022-12-02
+* [add] `ElasticsearchRecord::SchemaMigration` to fix connection-related differences (like table_name_prefix, table_name_suffix)
+* [add] connection (config-related) 'table_name_prefix' & 'table_name_suffix' - now will be forwarded to all related models & schema-tables
+* [add] `#block_table`, `#unblock_table`, `#clone_table`, `#table_metas`, `#meta_exists?`, `#change_meta`, `#delete_meta` methods for Elasticsearch ConnectionAdapter
+* [add] `ElasticsearchRecord::Base.auto_increment?`
+* [add] index 'meta' method to access the `_meta` mapping
+* [add] `.ElasticsearchRecord::Base.relay_id_attribute` to relay a possible existing 'id'-attribute
+* [add] new enabled attribute `enabled` - which defines 'searchable attributes & fields' and gets also read from the index-mappings
+* [ref] insert a new record with primary_key & auto_increment through a wrapper `_insert_with_auto_increment`
+* [ref] resolve `primary_keys` now from the index `_meta` mapping first (old mapping-related 'meta.primary_key:"true"' is still supported)
+* [ref] disable 'strict' mode (= validation) of settings, alias, mappings as default (this can be still used with `strict: true`)
+* [ref] silent unsupported methods 'create/drop' for `ElasticsearchRecord::Tasks::ElasticsearchDatabaseTasks`
+* [ref] primary_key & auto_increment handling of custom defined mappings - now uses the index `_meta` mapping
+* [fix] creating a record with different 'primary_key' fails with removed value (value no longer gets dropped)
+* [fix] some index-settings not being ignored through `#transform_settings!`
+* [fix] `ActiveRecord::ConnectionAdapters::Elasticsearch::SchemaDumper` dumping environment-related tables in the same database
+* [fix] `ActiveRecord::ConnectionAdapters::Elasticsearch::TableMappingDefinition` fails with explicit assignable attributes (now uses ASSIGNABLE_ATTRIBUTES)
+* [fix] tables with provided 'table_name_prefix' or 'table_name_suffix' not being ignored by the SchemaDumper
+
+## [1.1.0] - 2022-12-01
 * [add] support for schema dumps & migrations for Elasticsearch
 * [add] `buckets` query/relation result method to resolve the buckets as key->value hash from aggregations
 * [add] support for third-party gems (e.g. elasticsearch-dsl)

data/elasticsearch_record.gemspec

@@ -39,4 +39,5 @@ DESC
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rake', "~> 13.0"
   spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'yard-activesupport-concern', '~> 0.0.1'
 end

data/lib/active_record/connection_adapters/elasticsearch/column.rb

@@ -5,13 +5,14 @@ module ActiveRecord
     module Elasticsearch
       class Column < ConnectionAdapters::Column # :nodoc:
 
-        attr_reader :virtual, :fields, :properties, :meta
+        attr_reader :virtual, :fields, :properties, :meta, :enabled
 
-        def initialize(name, default, sql_type_metadata = nil, virtual: false, fields: nil, properties: nil, meta: nil, **kwargs)
+        def initialize(name, default, sql_type_metadata = nil, virtual: false, fields: nil, properties: nil, meta: nil, enabled: nil, **kwargs)
           @virtual    = virtual
           @fields     = fields.presence || []
           @properties = properties.presence || []
           @meta       = meta.presence || {}
+          @enabled    = enabled.nil? ? true : enabled
 
           super(name, default, sql_type_metadata, true, nil, **kwargs)
         end
@@ -21,6 +22,12 @@ module ActiveRecord
           meta? && meta['comment']
         end
 
+        # returns true if this column is enabled (= searchable by queries)
+        # @return [Boolean]
+        def enabled?
+          !!enabled
+        end
+
         # returns true if this column is virtual.
         # Virtual columns cannot be saved.
         # @return [Boolean]

data/lib/active_record/connection_adapters/elasticsearch/schema_definitions/clone_table_definition.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'active_record/connection_adapters/elasticsearch/schema_definitions/table_definition'
+
+module ActiveRecord
+  module ConnectionAdapters
+    module Elasticsearch
+      class CloneTableDefinition < TableDefinition
+
+        attr_reader :target
+
+        def initialize(conn, name, target, settings: nil, aliases: nil, **opts)
+          super(conn, name, **opts)
+
+          @target   = target
+          @settings = HashWithIndifferentAccess.new
+          @aliases  = HashWithIndifferentAccess.new
+
+          transform_settings!(settings) if settings.present?
+          transform_aliases!(aliases) if aliases.present?
+        end
+
+        # returns an array with all +TableSettingDefinition+.
+        # @return [Array]
+        def settings
+          @settings.values
+        end
+
+        # returns an array with all +TableAliasDefinition+.
+        # @return [Array]
+        def aliases
+          @aliases.values
+        end
+
+        ######################
+        # DEFINITION METHODS #
+        ######################
+
+        def setting(name, value, force: false, **options, &block)
+          raise ArgumentError, "you cannot define an already defined setting '#{name}'!" if @settings.key?(name) && !force?(force)
+
+          @settings[name] = new_setting_definition(name, value, **options, &block)
+
+          self
+        end
+
+        def remove_setting(name)
+          @settings.delete name
+        end
+
+        # we can use +alias+ here, since the instance method is not a reserved keyword!
+
+        def alias(name, force: false, **options, &block)
+          raise ArgumentError, "you cannot define an already defined alias '#{name}'." if @aliases.key?(name) && !force?(force)
+
+          @aliases[name] = new_alias_definition(name, **options, &block)
+
+          self
+        end
+
+        def remove_alias(name)
+          @aliases.delete name
+        end
+
+        private
+
+        def _before_exec
+          block_table(self.name, :write)
+        end
+
+        def _after_exec
+          unblock_table(self.name, :write)
+        end
+
+        alias :_rescue_exec :_after_exec
+
+        def _exec
+          execute(schema_creation.accept(self), 'CLONE TABLE').dig('acknowledged')
+        end
+
+        # force empty states to prevent "Name is static for an open table" error.
+        def state
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/elasticsearch/schema_definitions/column_methods.rb

@@ -17,7 +17,7 @@ module ActiveRecord
           # Appends a primary key definition to the table definition.
           # Can be called multiple times, but this is probably not a good idea.
           def primary_key(name, type = :primary_key, **options)
-            mapping(name, type, **options.merge(primary_key: true))
+            mapping(name, type, **options.merge(primary_key: true, auto_increment: true))
           end
         end
 

data/lib/active_record/connection_adapters/elasticsearch/schema_definitions/create_table_definition.rb

@@ -12,6 +12,7 @@ module ActiveRecord
           @settings = HashWithIndifferentAccess.new
           @mappings = HashWithIndifferentAccess.new
           @aliases  = HashWithIndifferentAccess.new
+          @metas    = HashWithIndifferentAccess.new
 
           transform_settings!(settings) if settings.present?
           transform_mappings!(mappings) if mappings.present?
@@ -30,6 +31,12 @@ module ActiveRecord
           @mappings.values
         end
 
+        # returns an array with all +TableMetaDefinition+.
+        # @return [Array]
+        def metas
+          @metas.values
+        end
+
         # provide backwards compatibility to columns
         alias columns mappings
 
@@ -48,11 +55,32 @@ module ActiveRecord
         # DEFINITION METHODS #
         ######################
 
+        # adds a new meta
+        def meta(name, value, force: false, **options)
+          raise ArgumentError, "you cannot define an already defined meta '#{name}'!" if @metas.key?(name) && !force?(force)
+
+          @metas[name] = new_meta_definition(name, value, **options)
+
+          self
+        end
+
+        def remove_meta(name)
+          @metas.delete(name)
+        end
+
         # adds a new mapping
         def mapping(name, type, force: false, **options, &block)
           raise ArgumentError, "you cannot define an already defined mapping '#{name}'!" if @mappings.key?(name) && !force?(force)
 
-          @mappings[name] = new_mapping_definition(name, type, **options, &block)
+          mapping = new_mapping_definition(name, type, **options, &block)
+          @mappings[name] = mapping
+
+
+          # check if the mapping is assigned as primary_key
+          if mapping.primary_key?
+            meta :primary_key, mapping.name
+            meta(:auto_increment, mapping.auto_increment) if mapping.auto_increment?
+          end
 
           self
         end
@@ -126,32 +154,6 @@ module ActiveRecord
         def state
           nil
         end
-
-        def transform_mappings!(mappings)
-          return unless mappings['properties'].present?
-
-          mappings['properties'].each do |name, attributes|
-            self.mapping(name, attributes.delete('type'), **attributes)
-          end
-        end
-
-        def transform_settings!(settings)
-          # exclude settings, that are provided through the API but are not part of the index-settings
-          settings
-            .with_indifferent_access
-            .each { |name, value|
-              # don't transform ignored names
-              next if ActiveRecord::ConnectionAdapters::Elasticsearch::TableSettingDefinition.match_ignore_names?(name)
-
-              self.setting(name, value)
-            }
-        end
-
-        def transform_aliases!(aliases)
-          aliases.each do |name, attributes|
-            self.alias(name, **attributes)
-          end
-        end
       end
     end
   end

data/lib/active_record/connection_adapters/elasticsearch/schema_definitions/table_definition.rb

@@ -10,16 +10,19 @@ module ActiveRecord
       class TableDefinition
         include ColumnMethods
 
-        delegate :execute, :schema_creation, :column_exists?, :mapping_exists?, :setting_exists?, :alias_exists?, :close_table, :open_table, :table_mappings, to: :conn
+        delegate :execute, :schema_creation,
+                 :column_exists?, :mapping_exists?, :meta_exists?, :setting_exists?, :alias_exists?,
+                 :close_table, :open_table, :block_table, :unblock_table,
+                 :table_mappings, :table_metas, :table_settings, to: :conn
 
         attr_reader :conn
         attr_reader :name
         attr_reader :opts
 
         def initialize(conn, name, **opts)
-          @conn = conn
-          @name = name
-          @opts = opts
+          @conn   = conn
+          @name   = name
+          @opts   = opts
           @failed = false
         end
 
@@ -33,10 +36,11 @@ module ActiveRecord
             yield self
           rescue => e
             @failed = false
+            _rescue_assign
             raise e
-          ensure
-            _after_assign
           end
+
+          _after_assign
         end
 
         def exec!
@@ -47,10 +51,11 @@ module ActiveRecord
             _exec
           rescue => e
             @failed = false
+            _rescue_exec
             raise e
-          ensure
-            _after_exec
           end
+
+          _after_exec
         end
 
         def failed?
@@ -67,6 +72,10 @@ module ActiveRecord
           true
         end
 
+        def _rescue_assign
+          true
+        end
+
         def _before_exec
           true
         end
@@ -75,11 +84,23 @@ module ActiveRecord
           true
         end
 
+        def _rescue_exec
+          true
+        end
+
         def _exec
           raise ArgumentError, "you cannot execute a TableDefinition directly - use 'CreateTableDefinition' or 'UpdateTableDefinition' instead!"
         end
 
-        def new_mapping_definition(name, type, strict: true, **attributes, &block)
+        def new_meta_definition(name, value, strict: false, **)
+          meta = TableMetaDefinition.new(name, value)
+
+          raise ArgumentError, "you cannot define an invalid meta '#{name}' (#{meta.error_messages})!" if strict?(strict) && !meta.valid?
+
+          meta
+        end
+
+        def new_mapping_definition(name, type, strict: false, **attributes, &block)
           mapping = TableMappingDefinition.new(name, type, attributes)
           block.call(mapping) if block_given?
 
@@ -90,7 +111,7 @@ module ActiveRecord
 
         alias :new_column_definition :new_mapping_definition
 
-        def new_alias_definition(name, strict: true, **attributes, &block)
+        def new_alias_definition(name, strict: false, **attributes, &block)
           # create new alias
           tbl_alias = TableAliasDefinition.new(name, attributes)
           block.call(tbl_alias) if block_given?
@@ -100,7 +121,7 @@ module ActiveRecord
           tbl_alias
         end
 
-        def new_setting_definition(name, value, strict: true, **, &block)
+        def new_setting_definition(name, value, strict: false, **, &block)
           # create new setting
           setting = TableSettingDefinition.new(name, value).with_state(state)
           block.call(setting) if block_given?
@@ -124,7 +145,41 @@ module ActiveRecord
         end
 
         def strict?(strict = nil)
-          opts.fetch(:strict, true) && strict != false
+          opts.fetch(:strict, false) || strict
+        end
+
+        def transform_mappings!(mappings)
+          # transform +_meta+ mappings
+          if mappings['_meta'].present?
+            mappings['_meta'].each do |name, value|
+              self.meta(name, value)
+            end
+          end
+
+          # transform properties (=columns)
+          if mappings['properties'].present?
+            mappings['properties'].each do |name, attributes|
+              self.mapping(name, attributes.delete('type'), **attributes)
+            end
+          end
+        end
+
+        def transform_settings!(settings)
+          # exclude settings, that are provided through the API but are not part of the index-settings
+          settings
+            .with_indifferent_access
+            .each { |name, value|
+              # don't transform ignored names
+              next if ActiveRecord::ConnectionAdapters::Elasticsearch::TableSettingDefinition.match_ignore_names?(name)
+
+              self.setting(name, value)
+            }
+        end
+
+        def transform_aliases!(aliases)
+          aliases.each do |name, attributes|
+            self.alias(name, **attributes)
+          end
         end
       end
     end