index.rb
17.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
module Searchkick
class Index
attr_reader :name, :options
def initialize(name, options = {})
@name = name
@options = options
end
def create(options = {})
client.indices.create index: name, body: options
end
def delete
client.indices.delete index: name
end
def exists?
client.indices.exists index: name
end
def refresh
client.indices.refresh index: name
end
def alias_exists?
client.indices.exists_alias name: name
end
def swap(new_name)
old_indices =
begin
client.indices.get_alias(name: name).keys
rescue Elasticsearch::Transport::Transport::Errors::NotFound
[]
end
actions = old_indices.map { |old_name| {remove: {index: old_name, alias: name}} } + [{add: {index: new_name, alias: name}}]
client.indices.update_aliases body: {actions: actions}
end
# record based
def store(record)
client.index(
index: name,
type: document_type(record),
id: search_id(record),
body: search_data(record)
)
end
def remove(record)
id = search_id(record)
unless id.blank?
client.delete(
index: name,
type: document_type(record),
id: id
)
end
end
def import(records)
records.group_by { |r| document_type(r) }.each do |type, batch|
client.bulk(
index: name,
type: type,
body: batch.map { |r| {index: {_id: search_id(r), data: search_data(r)}} }
)
end
end
def retrieve(record)
client.get(
index: name,
type: document_type(record),
id: search_id(record)
)["_source"]
end
def reindex_record(record)
if record.destroyed? || !record.should_index?
begin
remove(record)
rescue Elasticsearch::Transport::Transport::Errors::NotFound
# do nothing
end
else
store(record)
end
end
def reindex_record_async(record)
if defined?(Searchkick::ReindexV2Job)
Searchkick::ReindexV2Job.perform_later(record.class.name, record.id.to_s)
else
Delayed::Job.enqueue Searchkick::ReindexJob.new(record.class.name, record.id.to_s)
end
end
def similar_record(record, options = {})
like_text = retrieve(record).to_hash
.keep_if { |k, v| !options[:fields] || options[:fields].map(&:to_s).include?(k) }
.values.compact.join(" ")
# TODO deep merge method
options[:where] ||= {}
options[:where][:_id] ||= {}
options[:where][:_id][:not] = record.id.to_s
options[:limit] ||= 10
options[:similar] = true
# TODO use index class instead of record class
search_model(record.class, like_text, options)
end
# search
def search_model(searchkick_klass, term = nil, options = {}, &block)
query = Searchkick::Query.new(searchkick_klass, term, options)
if block
block.call(query.body)
end
if options[:execute] == false
query
else
query.execute
end
end
# reindex
def create_index(options = {})
index_options = options[:index_options] || self.index_options
index = Searchkick::Index.new("#{name}_#{Time.now.strftime('%Y%m%d%H%M%S%L')}", @options)
index.create(index_options)
index
end
# remove old indices that start w/ index_name
def clean_indices
all_indices = client.indices.get_aliases
indices = all_indices.select { |k, v| (v.empty? || v["aliases"].empty?) && k =~ /\A#{Regexp.escape(name)}_\d{14,17}\z/ }.keys
indices.each do |index|
Searchkick::Index.new(index).delete
end
indices
end
# https://gist.github.com/jarosan/3124884
# http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/
def reindex_scope(scope, options = {})
skip_import = options[:import] == false
clean_indices
index = create_index(index_options: scope.searchkick_index_options)
# check if alias exists
if alias_exists?
# import before swap
index.import_scope(scope) unless skip_import
# get existing indices to remove
swap(index.name)
clean_indices
else
delete if exists?
swap(index.name)
# import after swap
index.import_scope(scope) unless skip_import
end
index.refresh
true
end
def import_scope(scope)
batch_size = @options[:batch_size] || 1000
# use scope for import
scope = scope.search_import if scope.respond_to?(:search_import)
if scope.respond_to?(:find_in_batches)
scope.find_in_batches batch_size: batch_size do |batch|
import batch.select(&:should_index?)
end
else
# https://github.com/karmi/tire/blob/master/lib/tire/model/import.rb
# use cursor for Mongoid
items = []
scope.all.each do |item|
items << item if item.should_index?
if items.length == batch_size
import items
items = []
end
end
import items
end
end
def index_options
options = @options
if options[:mappings] && !options[:merge_mappings]
settings = options[:settings] || {}
mappings = options[:mappings]
else
settings = {
analysis: {
analyzer: {
searchkick_keyword: {
type: "custom",
tokenizer: "keyword",
filter: ["lowercase"] + (options[:stem_conversions] == false ? [] : ["searchkick_stemmer"])
},
default_index: {
type: "custom",
# character filters -> tokenizer -> token filters
# https://www.elastic.co/guide/en/elasticsearch/guide/current/analysis-intro.html
char_filter: ["ampersand"],
tokenizer: "standard",
# synonym should come last, after stemming and shingle
# shingle must come before searchkick_stemmer
filter: ["standard", "lowercase", "asciifolding", "searchkick_index_shingle", "searchkick_stemmer"]
},
searchkick_search: {
type: "custom",
char_filter: ["ampersand"],
tokenizer: "standard",
filter: ["standard", "lowercase", "asciifolding", "searchkick_search_shingle", "searchkick_stemmer"]
},
searchkick_search2: {
type: "custom",
char_filter: ["ampersand"],
tokenizer: "standard",
filter: ["standard", "lowercase", "asciifolding", "searchkick_stemmer"]
},
# https://github.com/leschenko/elasticsearch_autocomplete/blob/master/lib/elasticsearch_autocomplete/analyzers.rb
searchkick_autocomplete_index: {
type: "custom",
tokenizer: "searchkick_autocomplete_ngram",
filter: ["lowercase", "asciifolding"]
},
searchkick_autocomplete_search: {
type: "custom",
tokenizer: "keyword",
filter: ["lowercase", "asciifolding"]
},
searchkick_word_search: {
type: "custom",
tokenizer: "standard",
filter: ["lowercase", "asciifolding"]
},
searchkick_suggest_index: {
type: "custom",
tokenizer: "standard",
filter: ["lowercase", "asciifolding", "searchkick_suggest_shingle"]
},
searchkick_text_start_index: {
type: "custom",
tokenizer: "keyword",
filter: ["lowercase", "asciifolding", "searchkick_edge_ngram"]
},
searchkick_text_middle_index: {
type: "custom",
tokenizer: "keyword",
filter: ["lowercase", "asciifolding", "searchkick_ngram"]
},
searchkick_text_end_index: {
type: "custom",
tokenizer: "keyword",
filter: ["lowercase", "asciifolding", "reverse", "searchkick_edge_ngram", "reverse"]
},
searchkick_word_start_index: {
type: "custom",
tokenizer: "standard",
filter: ["lowercase", "asciifolding", "searchkick_edge_ngram"]
},
searchkick_word_middle_index: {
type: "custom",
tokenizer: "standard",
filter: ["lowercase", "asciifolding", "searchkick_ngram"]
},
searchkick_word_end_index: {
type: "custom",
tokenizer: "standard",
filter: ["lowercase", "asciifolding", "reverse", "searchkick_edge_ngram", "reverse"]
}
},
filter: {
searchkick_index_shingle: {
type: "shingle",
token_separator: ""
},
# lucky find http://web.archiveorange.com/archive/v/AAfXfQ17f57FcRINsof7
searchkick_search_shingle: {
type: "shingle",
token_separator: "",
output_unigrams: false,
output_unigrams_if_no_shingles: true
},
searchkick_suggest_shingle: {
type: "shingle",
max_shingle_size: 5
},
searchkick_edge_ngram: {
type: "edgeNGram",
min_gram: 1,
max_gram: 50
},
searchkick_ngram: {
type: "nGram",
min_gram: 1,
max_gram: 50
},
searchkick_stemmer: {
# use stemmer if language is lowercase, snowball otherwise
# TODO deprecate language option in favor of stemmer
type: options[:language] == options[:language].to_s.downcase ? "stemmer" : "snowball",
language: options[:language] || "English"
}
},
char_filter: {
# https://www.elastic.co/guide/en/elasticsearch/guide/current/custom-analyzers.html
# &_to_and
ampersand: {
type: "mapping",
mappings: ["&=> and "]
}
},
tokenizer: {
searchkick_autocomplete_ngram: {
type: "edgeNGram",
min_gram: 1,
max_gram: 50
}
}
}
}
if Searchkick.env == "test"
settings.merge!(number_of_shards: 1, number_of_replicas: 0)
end
settings.deep_merge!(options[:settings] || {})
# synonyms
synonyms = options[:synonyms] || []
if synonyms.respond_to?(:call)
synonyms = synonyms.call
end
if synonyms.any?
settings[:analysis][:filter][:searchkick_synonym] = {
type: "synonym",
synonyms: synonyms.select { |s| s.size > 1 }.map { |s| s.join(",") }
}
# choosing a place for the synonym filter when stemming is not easy
# https://groups.google.com/forum/#!topic/elasticsearch/p7qcQlgHdB8
# TODO use a snowball stemmer on synonyms when creating the token filter
# http://elasticsearch-users.115913.n3.nabble.com/synonym-multi-words-search-td4030811.html
# I find the following approach effective if you are doing multi-word synonyms (synonym phrases):
# - Only apply the synonym expansion at index time
# - Don't have the synonym filter applied search
# - Use directional synonyms where appropriate. You want to make sure that you're not injecting terms that are too general.
settings[:analysis][:analyzer][:default_index][:filter].insert(4, "searchkick_synonym")
settings[:analysis][:analyzer][:default_index][:filter] << "searchkick_synonym"
end
if options[:wordnet]
settings[:analysis][:filter][:searchkick_wordnet] = {
type: "synonym",
format: "wordnet",
synonyms_path: Searchkick.wordnet_path
}
settings[:analysis][:analyzer][:default_index][:filter].insert(4, "searchkick_wordnet")
settings[:analysis][:analyzer][:default_index][:filter] << "searchkick_wordnet"
end
if options[:special_characters] == false
settings[:analysis][:analyzer].each do |analyzer, analyzer_settings|
analyzer_settings[:filter].reject! { |f| f == "asciifolding" }
end
end
mapping = {}
# conversions
if options[:conversions]
mapping[:conversions] = {
type: "nested",
properties: {
query: {type: "string", analyzer: "searchkick_keyword"},
count: {type: "integer"}
}
}
end
mapping_options = Hash[
[:autocomplete, :suggest, :text_start, :text_middle, :text_end, :word_start, :word_middle, :word_end, :highlight]
.map { |type| [type, (options[type] || []).map(&:to_s)] }
]
mapping_options.values.flatten.uniq.each do |field|
field_mapping = {
type: "multi_field",
fields: {
field => {type: "string", index: "not_analyzed"},
"analyzed" => {type: "string", index: "analyzed"}
# term_vector: "with_positions_offsets" for fast / correct highlighting
# http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-highlighting.html#_fast_vector_highlighter
}
}
mapping_options.except(:highlight).each do |type, fields|
if fields.include?(field)
field_mapping[:fields][type] = {type: "string", index: "analyzed", analyzer: "searchkick_#{type}_index"}
end
end
if mapping_options[:highlight].include?(field)
field_mapping[:fields]["analyzed"][:term_vector] = "with_positions_offsets"
end
mapping[field] = field_mapping
end
(options[:locations] || []).map(&:to_s).each do |field|
mapping[field] = {
type: "geo_point"
}
end
(options[:unsearchable] || []).map(&:to_s).each do |field|
mapping[field] = {
type: "string",
index: "no"
}
end
routing = {}
if options[:routing]
routing = {required: true, path: options[:routing].to_s}
end
mappings = {
_default_: {
properties: mapping,
_routing: routing,
# https://gist.github.com/kimchy/2898285
dynamic_templates: [
{
string_template: {
match: "*",
match_mapping_type: "string",
mapping: {
# http://www.elasticsearch.org/guide/reference/mapping/multi-field-type/
type: "multi_field",
fields: {
# analyzed field must be the default field for include_in_all
# http://www.elasticsearch.org/guide/reference/mapping/multi-field-type/
# however, we can include the not_analyzed field in _all
# and the _all index analyzer will take care of it
"{name}" => {type: "string", index: "not_analyzed"},
"analyzed" => {type: "string", index: "analyzed"}
}
}
}
}
]
}
}.deep_merge(options[:mappings] || {})
end
{
settings: settings,
mappings: mappings
}
end
# other
def tokens(text, options = {})
client.indices.analyze({text: text, index: name}.merge(options))["tokens"].map { |t| t["token"] }
end
def klass_document_type(klass)
if klass.respond_to?(:document_type)
klass.document_type
else
klass.model_name.to_s.underscore
end
end
protected
def client
Searchkick.client
end
def document_type(record)
klass_document_type(record.class)
end
def search_id(record)
record.id.is_a?(Numeric) ? record.id : record.id.to_s
end
def search_data(record)
source = record.search_data
options = record.class.searchkick_options
# stringify fields
# remove _id since search_id is used instead
source = source.inject({}) { |memo, (k, v)| memo[k.to_s] = v; memo }.except("_id")
# conversions
conversions_field = options[:conversions]
if conversions_field && source[conversions_field]
source[conversions_field] = source[conversions_field].map { |k, v| {query: k, count: v} }
end
# hack to prevent generator field doesn't exist error
(options[:suggest] || []).map(&:to_s).each do |field|
source[field] = nil unless source[field]
end
# locations
(options[:locations] || []).map(&:to_s).each do |field|
if source[field]
if source[field].first.is_a?(Array) # array of arrays
source[field] = source[field].map { |a| a.map(&:to_f).reverse }
else
source[field] = source[field].map(&:to_f).reverse
end
end
end
cast_big_decimal(source)
source.as_json
end
# change all BigDecimal values to floats due to
# https://github.com/rails/rails/issues/6033
# possible loss of precision :/
def cast_big_decimal(obj)
case obj
when BigDecimal
obj.to_f
when Hash
obj.each do |k, v|
obj[k] = cast_big_decimal(v)
end
when Enumerable
obj.map do |v|
cast_big_decimal(v)
end
else
obj
end
end
end
end