elastic_ar_sync 0.1.0 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd13df6ed68262c7b4c23444f09d48a3530ad97e5df6f682f505ec32f9304de1
-  data.tar.gz: 3b4e0cb0b9c5f0226eaa85aab9d4c68b10a4a1e57c1a435f877a1dbcaa61b257
+  metadata.gz: 892ccfa7c17e4a02cf8c774eec3ec71eb6dfaf16006052e0d82381b4aec48bb5
+  data.tar.gz: 1c948f281659aec4a29bdbb28471a55127f3fab23080fca7b63fb43454b3d140
 SHA512:
-  metadata.gz: 219487c1c412620a86beabe73e1ef4db107a17d427d69e775ef301e20fe98a24cec1f9af23ee98611a777ba6b05604551ac25fb4e06fbe43b5878e6b020b0be0
-  data.tar.gz: bc3b782c8f7b8626383b3dee9ec539ad4d7d00d62702c6edfa91eeeab9be91edfe25b3e693fa602b859b85ed52ad746d1d037e8d6d2847119be4770b80ef3436
+  metadata.gz: 4524209a6682d5bf32f8543d54e138b0eb0e271a2ae04e417a8fa0ee905ac32788dfbd92300b2c5431ad54274222935b20b0268e71b37e542c8545e75e21eb46
+  data.tar.gz: cbd985be6b920d6c0f9e910a636ab391261e9187d9d56dce6323906be4cc1d8482e8028f489e2eb355e1cf4e6500cab301368a9ede05434c6636965ab3b0329c

data/README.md

@@ -1,8 +1,122 @@
 # ElasticArSync
-Short description and motivation.
-
+This repository contains easy set up modules for RDB and elasticsearch index with Active Record.
+This is based on `gem elasticsearch-rails`.
 ## Usage
-How to use my plugin.
+### Preparation
+Install `gem sidekiq` and `gem redis-rails` to use Asynchronous processing for your app.
+Install `gem elasticsearch-rails`, `gem elasticsearch-model` and `gem elasticsearch` for your app.
+
+
+Include module `ElasticArSync::Elastic::Syncable` on your Model class which is inherited ActiveRecord.
+
+and define `index_config` after `include ElasticArSync::Elastic::Syncable` if you use this module normally.
+
+you can override index_config described after.
+
+example below
+
+```ruby
+class XXXXX < ActiveRecord
+  include ElasticArSync::Elastic::Syncable
+  index_config
+end
+```
+
+then your Model class is included modules which is for sync model's table with elasticsearch index.
+
+when you create new record elasticsearch index save new document in sync.
+update and delete is same as create.
+
+this module contains class method `index_setup` to setup index.
+
+setup means create new index and put alias to new index and sync whole records of RDB with new index,
+then you can use new index without any command.
+
+```ruby
+XXXXX.index_setup
+```
+
+### usable methods
+if your Model class included `ElasticArSync::Elastic::Syncable`, it can use class methods below.
+
+- index_setup (class method)
+→ to setup index to elsticsearch
+
+- create_index (class method)
+→ to create new index to elasticsearch
+
+- delete_index({index_name})  (class method)
+→ to delete index. needed argument index name which you delete
+
+- import_all_record(index_name) (class method)
+→ to sync whole record with elasticsearch
+
+- switch_alias(new_index_name) (class method)
+→ to switch using index, you needed create more than two index
+
+- mapping_list_keys (class method)
+→ to get mapping list array of your index
+
+- get_aliases (class method)
+→ to get aliase list array which you created
+
+### Customize
+if you change process of after commit, you can override instance methods below.
+default is provided by `ElasticArSync::Elastic::Worker::IndexWorker`
+
+- document_sync_create
+→ for callback of create
+
+- document_sync_update
+→ for callback of update
+
+- document_sync_delete
+→ for callback of destroy
+
+if you define original mapping of index like type, attribute, etc, 
+you can use `index_config` after `include ElasticArSync::Elastic::Syncable`.
+
+example below
+
+you can override args `dynamic`, `number_of_shards`, `attr_mappings`.
+especially default mapping is whole attributes of your Model class, so you can customize mapping attributes by overriding attr_mappings.
+```ruby
+index_config(dynamic: 'false', number_of_shards: 1, attr_mappings: { id: 'integer', name: 'text', birth: 'date' })
+```
+
+you can also override part of attributes by `override_mappings` like below
+
+＊As a premise, your model contain [id: integer, name: string, birth: date]
+
+```ruby
+index_config(override_mappings: { birth: :keyword })
+```
+
+then birth will mapping as keyword type in index of elasticsearch.
+
+if you want add mapping which is not defined as schema column of model, you can save method result as well like below.
+
+```ruby
+index_config(override_mappings: { full_name: :keyword })
+```
+
+＊`full_name` is instance method
+
+then full_name will mapped to index mapping as keyword type. but you have to define instance method full_name to your model class.
+
+if you define your original mapping additionally, you can also define like below.
+
+```ruby
+  settings index: { number_of_shards: number_of_shards } do
+    mappings do
+      indexes key, type: value
+    end
+  end
+```
+
+tips: just reference here.
+
+https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-model
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/elastic_ar_sync/elastic/syncable.rb

@@ -37,7 +37,9 @@ module ElasticArSync
         end
 
         def as_indexed_json(_option = {})
-          attributes.symbolize_keys.select { |key, _| self.class.mapping_list_keys.include?(key) }
+          hash = {}
+          self.class.mapping_list_keys.each { |key| hash[key.to_s] = send(key) }
+          hash.as_json
         end
       end
 
@@ -67,24 +69,40 @@ module ElasticArSync
           ElasticArSync::Elastic::Services::IndexHandler.new(self).switch_alias(alias_name: index_name, new_index_name: new_index_name)
         end
 
-        def index_config(dynamic: 'false', number_of_shards: 1, attr_mappings: default_index_mapping)
-          settings index: { number_of_shards: number_of_shards } do
+        def index_config(dynamic: 'false', override_settings: {}, attr_mappings: default_index_mapping, override_mappings: {})
+          attr_mappings.merge!(override_mappings) if override_mappings.present?
+
+          settings default_index_setting.merge!(override_settings) do
             # ES6からStringが使えないのでtextかkeywordにする。
             mappings dynamic: dynamic do
               attr_mappings.each do |key, value|
-                indexes key, type: value
+                next unless value.is_a?(Hash)
+
+                if value[:type].to_s == 'nested'
+                  indexes key ,value.reject { |k, _| k.to_sym == :nested_attr } do
+                    value[:nested_attr].each { |key, value| indexes key, value }
+                  end
+                  next
+                end
+
+                indexes key, value
               end
             end
           end
         end
 
+        def default_index_setting
+          { index: { number_of_shards: 1 } }
+        end
+
         def default_index_mapping
           mapping = {}
           attribute_types.each do |attribute, active_model_type|
             type = active_model_type.type
-            type = :text if (active_model_type.type.to_sym == :string) || (type == :integer && defined_enums.symbolize_keys.keys.include?(attribute.to_sym))
+            type = :text if (active_model_type.type.to_sym == :string)
+            type = :keyword if type == :integer && defined_enums.symbolize_keys.keys.include?(attribute.to_sym)
             type = :date if active_model_type.type == :datetime
-            mapping[attribute.to_sym] = type
+            mapping[attribute.to_sym] = { type: type }
           end
           mapping
         end
@@ -100,6 +118,14 @@ module ElasticArSync
             raise Elasticsearch::Transport::Transport::Errors::NotFound, "インデックスがありません alias_name: #{alias_name}"
           end
         end
+
+        def current_index
+          get_aliases.select { |_, value| value["aliases"].present? }.keys.first
+        end
+
+        def current_mapping
+          __elasticsearch__.client.indices.get_mapping[current_index]["mappings"]["_doc"]["properties"]
+        end
       end
     end
   end

data/lib/elastic_ar_sync/version.rb

@@ -1,3 +1,3 @@
 module ElasticArSync
-  VERSION = '0.1.0'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_ar_sync
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.6
 platform: ruby
 authors:
 - KitakatsuTed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2020-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails