elasticsearch_record 1.1.0 → 1.2.0

data/lib/elasticsearch_record/core.rb

@@ -3,12 +3,19 @@ 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)+.
+      # To also have the ability of accessing this attribute through the default, this flag can be enabled.
+      # @attribute! Boolean
       class_attribute :relay_id_attribute, instance_writer: false, default: false
     end
 
     # overwrite to provide a Elasticsearch version of returning a 'primary_key' attribute.
     # Elasticsearch uses the static +_id+ column as primary_key, but also supports an additional +id+ column.
-    # To provide functionality of returning the +id+ attribute, this method must also support it.
+    # To provide functionality of returning the +id+ attribute, this method must also support it
+    # with enabled +relay_id_attribute+.
     # @return [Object]
     def id
       # check, if the model has a +id+ attribute
@@ -19,7 +26,8 @@ module ElasticsearchRecord
 
     # overwrite to provide a Elasticsearch version of setting a 'primary_key' attribute.
     # Elasticsearch uses the static +_id+ column as primary_key, but also supports an additional +id+ column.
-    # To provide functionality of setting the +id+ attribute, this method must also support it.
+    # To provide functionality of setting the +id+ attribute, this method must also support it
+    # with enabled +relay_id_attribute+.
     # @param [Object] value
     def id=(value)
       # check, if the model has a +id+ attribute
@@ -33,23 +41,26 @@ module ElasticsearchRecord
 
     # overwrite to provide a Elasticsearch version of returning a 'primary_key' was attribute.
     # Elasticsearch uses the static +_id+ column as primary_key, but also supports an additional +id+ column.
-    # To provide functionality of returning the +id_Was+ attribute, this method must also support it.
+    # To provide functionality of returning the +id_Was+ attribute, this method must also support it
+    # with enabled +relay_id_attribute+.
     def id_was
-      relay_id_attribute? && has_attribute?('id') ? attribute_was('id') : attribute_was(@primary_key)
+      relay_id_attribute? && has_attribute?('id') ? attribute_was('id') : super
     end
 
-    # overwrite the write_attribute method to write 'id', if present
+    # overwrite the write_attribute method to always write to the 'id'-attribute, if present.
+    # This methods does not check for +relay_id_attribute+ flag!
     # see @ ActiveRecord::AttributeMethods::Write#write_attribute
     def write_attribute(attr_name, value)
-      return _write_attribute('id', value) if attr_name.to_s == 'id' && relay_id_attribute? && has_attribute?('id')
+      return _write_attribute('id', value) if attr_name.to_s == 'id' && has_attribute?('id')
 
       super
     end
 
-    # overwrite read_attribute method to read 'id', if present
+    # overwrite read_attribute method to read from the 'id'-attribute, if present.
+    # This methods does not check for +relay_id_attribute+ flag!
     # see @ ActiveRecord::AttributeMethods::Read#read_attribute
     def read_attribute(attr_name, &block)
-      return _read_attribute('id', &block) if attr_name.to_s == 'id' && relay_id_attribute? && has_attribute?('id')
+      return _read_attribute('id', &block) if attr_name.to_s == 'id' && has_attribute?('id')
 
       super
     end
@@ -73,6 +84,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
+
       private
 
       # creates a new relation object and extends it with our own Relation.

data/lib/elasticsearch_record/gem_version.rb

@@ -8,7 +8,7 @@ module ElasticsearchRecord
 
   module VERSION
     MAJOR = 1
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
     PRE   = nil
 

data/lib/elasticsearch_record/model_schema.rb

@@ -3,10 +3,25 @@ module ElasticsearchRecord
     extend ActiveSupport::Concern
 
     included do
+      # Rails resolves a pluralized underscore table_name from the class name - which will not work for some models.
+      # To support a general +table_name_prefix+ & +table_name_suffix+ a custom 'index_base_name' can be provided.
+      # @attribute! String|Symbol
       class_attribute :index_base_name, instance_writer: false, default: nil
     end
 
     module ClassMethods
+      # overwrite this method to provide an optional +table_name_prefix+ from the connection config.
+      # @return [String]
+      def table_name_prefix
+        super.presence || connection.table_name_prefix
+      end
+
+      # overwrite this method to provide an optional +table_name_suffix+ from the connection config.
+      # @return [String]
+      def table_name_suffix
+        super.presence || connection.table_name_suffix
+      end
+
       # Guesses the table name, but does not decorate it with prefix and suffix information.
       def undecorated_table_name(model_name)
         # check the 'index_base_name' first, so +table_name_prefix+ & +table_name_suffix+ can still be used
@@ -14,20 +29,29 @@ module ElasticsearchRecord
       end
 
       # returns the configured +max_result_window+ (default: 10000)
+      # @return [Integer]
       def max_result_window
         @max_result_window ||= connection.max_result_window(table_name)
       end
 
+      # returns true, if the table should behave as +auto_increment+ by creating new records.
+      # resolves the auto_increment status from the tables +_meta+.
+      # @return [Boolean]
+      def auto_increment?
+        @auto_increment ||= !!connection.table_metas(table_name).dig('auto_increment')
+      end
+
       # returns an array with columns names, that are not virtual (and not a base structure).
       # so this is a array of real document (+_source+) attributes of the index.
       # @return [Array<String>]
       def source_column_names
-        @source_column_names ||= columns.reject(&:virtual).map(&:name) - ActiveRecord::ConnectionAdapters::ElasticsearchAdapter.base_structure_keys
+        @source_column_names ||= columns.reject(&:virtual?).map(&:name) - ActiveRecord::ConnectionAdapters::ElasticsearchAdapter.base_structure_keys
       end
 
       # returns an array with columns names, that are searchable (also includes nested fields & properties )
+      # @return [Array<String>]
       def searchable_column_names
-        @searchable_column_names ||= columns.reject(&:virtual).reduce([]) { |m, column|
+        @searchable_column_names ||= columns.select(&:enabled?).reduce([]) { |m, column|
           m << column.name
           m += column.field_names
           m += column.property_names

data/lib/elasticsearch_record/persistence.rb

@@ -3,7 +3,6 @@ module ElasticsearchRecord
     extend ActiveSupport::Concern
 
     module ClassMethods
-
       # insert a new record into the Elasticsearch index
       # NOTICE: We don't want to mess up with the Arel-builder - so we send new data directly to the API
       # @param [ActiveModel::Attribute] values
@@ -12,41 +11,20 @@ module ElasticsearchRecord
         # values is not a "key=>values"-Hash, but a +ActiveModel::Attribute+ - so the casted values gets resolved here
         values = values.transform_values(&:value)
 
-        update_auto_increment = false
-
-        # resolve possible provided primary_key value from values
-        arguments = if (id = values[self.primary_key]).present?
-                      {id: id}
-                    elsif self.columns_hash[self.primary_key]&.meta['auto_increment'] # BETA: should not be used on mass imports to the Elasticsearch-index
-                      update_auto_increment = true
-                      ids = [
-                        connection.table_mappings(self.table_name).dig('properties', self.primary_key, 'meta', 'auto_increment').to_i + 1,
-                        self.unscoped.all.maximum(self.primary_key).to_i + 1
-                      ]
-                      {id: ids.max}
-                    else
-                      {}
-                    end
-
-        # IMPORTANT: Always drop possible provided 'primary_key' column +_id+.
-        values.delete(self.primary_key)
-
-        # build new query
-        query = ElasticsearchRecord::Query.new(
-          index:     table_name,
-          type:      ElasticsearchRecord::Query::TYPE_CREATE,
-          body:      values,
-          arguments: arguments,
-          refresh:   true)
-
-        # execute query and return inserted id
-        id = connection.insert(query, "#{self} Create")
+        # resolve & update a auto_increment value
+        _insert_with_auto_increment(values) do |arguments|
+          # build new query
+          query = ElasticsearchRecord::Query.new(
+            index:     table_name,
+            type:      ElasticsearchRecord::Query::TYPE_CREATE,
+            # IMPORTANT: always exclude possible provided +_id+ field
+            body:      values.except('_id'),
+            arguments: arguments,
+            refresh:   true)
 
-        if id.present? && update_auto_increment
-          connection.change_mapping_meta(table_name, self.primary_key, auto_increment: id)
+          # execute query and return inserted id
+          connection.insert(query, "#{self} Create")
         end
-
-        id
       end
 
       # updates a persistent entry in the Elasticsearch index
@@ -80,6 +58,39 @@ module ElasticsearchRecord
         # execute query and return total deletes
         connection.delete(query, "#{self} Delete")
       end
+
+      private
+
+      # WARNING: BETA!!!
+      # Resolves the +auto_increment+ status from the tables +_meta+ attributes.
+      def _insert_with_auto_increment(values)
+        # check, if the primary_key's values is provided.
+        # so, no need to resolve a +auto_increment+ value, but provide
+        if values[self.primary_key].present?
+          # resolve id from values
+          id = values[self.primary_key]
+
+          yield({id: id})
+        elsif auto_increment?
+          ids = [
+            # we try to resolve the current-auto-increment value from the tables meta
+            connection.table_metas(self.table_name).dig('auto_increment').to_i + 1,
+            # for secure reasons, we also resolve the current maximum value for the primary key
+            self.unscoped.all.maximum(self.primary_key).to_i + 1
+          ]
+
+          id = yield({ id: ids.max })
+
+          if id.present?
+            connection.change_meta(self.table_name, :auto_increment, id)
+          end
+
+          # return inserted id
+          id
+        else
+          yield({})
+        end
+      end
     end
   end
 end

data/lib/elasticsearch_record/query.rb

@@ -22,6 +22,7 @@ module ElasticsearchRecord
 
     # -- INDEX TYPES ---------------------------------------------------------------------------------------------------
     TYPE_INDEX_CREATE = :index_create
+    TYPE_INDEX_CLONE  = :index_clone
     # INDEX update is not implemented by Elasticsearch
     # - this is handled through individual updates of +mappings+, +settings+ & +aliases+.
     # INDEX delete is handled directly as API-call
@@ -38,7 +39,8 @@ module ElasticsearchRecord
       TYPE_CREATE, TYPE_UPDATE, TYPE_UPDATE_BY_QUERY, TYPE_DELETE, TYPE_DELETE_BY_QUERY,
 
       # -- INDEX TYPES
-      TYPE_INDEX_CREATE, TYPE_INDEX_UPDATE_MAPPING, TYPE_INDEX_UPDATE_SETTING, TYPE_INDEX_UPDATE_ALIAS,
+      TYPE_INDEX_CREATE, TYPE_INDEX_CLONE,
+      TYPE_INDEX_UPDATE_MAPPING, TYPE_INDEX_UPDATE_SETTING, TYPE_INDEX_UPDATE_ALIAS,
       TYPE_INDEX_DELETE_ALIAS
     ].freeze
 
@@ -59,6 +61,7 @@ module ElasticsearchRecord
     GATES = {
       TYPE_SQL                  => [:sql, :query],
       TYPE_INDEX_CREATE         => [:indices, :create],
+      TYPE_INDEX_CLONE          => [:indices, :clone],
       TYPE_INDEX_UPDATE_MAPPING => [:indices, :put_mapping],
       TYPE_INDEX_UPDATE_SETTING => [:indices, :put_settings],
       TYPE_INDEX_UPDATE_ALIAS   => [:indices, :put_alias],

data/lib/elasticsearch_record/schema_migration.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "active_record/schema_migration"
+
+module ElasticsearchRecord
+  class SchemaMigration < ElasticsearchRecord::Base # :nodoc:
+    class << self
+      def primary_key
+        "version"
+      end
+
+      def table_name
+        "#{table_name_prefix}#{schema_migrations_table_name}#{table_name_suffix}"
+      end
+
+      def create_table
+        unless connection.table_exists?(table_name)
+          connection.create_table(table_name, id: false) do |t|
+            t.string :version, **connection.internal_string_options_for_primary_key
+          end
+        end
+      end
+
+      def drop_table
+        connection.drop_table table_name, if_exists: true
+      end
+
+      def normalize_migration_number(number)
+        "%.3d" % number.to_i
+      end
+
+      def normalized_versions
+        all_versions.map { |v| normalize_migration_number v }
+      end
+
+      def all_versions
+        order(:version).pluck(:version)
+      end
+
+      def table_exists?
+        connection.data_source_exists?(table_name)
+      end
+    end
+
+    def version
+      super.to_i
+    end
+  end
+end

data/lib/elasticsearch_record/tasks/elasticsearch_database_tasks.rb

@@ -3,20 +3,20 @@
 module ElasticsearchRecord
   module Tasks
     class ElasticsearchDatabaseTasks
-      delegate :connection, :establish_connection, to: ActiveRecord::Base
+      delegate :connection, :establish_connection, to: ElasticsearchRecord::Base
 
       def initialize(db_config)
         @db_config = db_config
       end
 
       def create
-        #establish_connection(db_config)
-        $stdout.puts "\n>>> 'create' elasticsearch is not supported - the following message is insignificant!"
+        # 'create' database / cluster is not supported
+        nil
       end
 
       def drop
-        #establish_connection(db_config)
-        $stdout.puts "\n>>> 'drop' elasticsearch is not supported - the following message is insignificant!"
+        # 'drop' database / cluster is not supported
+        nil
       end
 
       def purge
@@ -24,6 +24,16 @@ module ElasticsearchRecord
         drop
       end
 
+      def structure_dump(*)
+        $stdout.puts "\n>>> 'structure_dump' elasticsearch is not supported and will be ignored!"
+        nil
+      end
+
+      def structure_load(*)
+        $stdout.puts "\n>>> 'structure_load' elasticsearch is not supported and will be ignored!"
+        nil
+      end
+
       private
 
       attr_reader :db_config

data/lib/elasticsearch_record.rb

@@ -27,6 +27,7 @@ module ElasticsearchRecord
     autoload :Querying
     autoload :Query
     autoload :Result
+    autoload :SchemaMigration
     autoload :StatementCache
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch_record
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Tobias Gonsior
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -106,11 +106,13 @@ files:
 - lib/active_record/connection_adapters/elasticsearch/schema_creation.rb
 - lib/active_record/connection_adapters/elasticsearch/schema_definitions.rb
 - lib/active_record/connection_adapters/elasticsearch/schema_definitions/attribute_methods.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_definitions/clone_table_definition.rb
 - lib/active_record/connection_adapters/elasticsearch/schema_definitions/column_methods.rb
 - lib/active_record/connection_adapters/elasticsearch/schema_definitions/create_table_definition.rb
 - lib/active_record/connection_adapters/elasticsearch/schema_definitions/table_alias_definition.rb
 - lib/active_record/connection_adapters/elasticsearch/schema_definitions/table_definition.rb
 - lib/active_record/connection_adapters/elasticsearch/schema_definitions/table_mapping_definition.rb
+- lib/active_record/connection_adapters/elasticsearch/schema_definitions/table_meta_definition.rb
 - lib/active_record/connection_adapters/elasticsearch/schema_definitions/table_setting_definition.rb
 - lib/active_record/connection_adapters/elasticsearch/schema_definitions/update_table_definition.rb
 - lib/active_record/connection_adapters/elasticsearch/schema_dumper.rb
@@ -161,6 +163,7 @@ files:
 - lib/elasticsearch_record/relation/result_methods.rb
 - lib/elasticsearch_record/relation/value_methods.rb
 - lib/elasticsearch_record/result.rb
+- lib/elasticsearch_record/schema_migration.rb
 - lib/elasticsearch_record/statement_cache.rb
 - lib/elasticsearch_record/tasks/elasticsearch_database_tasks.rb
 - lib/elasticsearch_record/version.rb
@@ -189,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: ActiveRecord adapter for Elasticsearch