Class: Tire::Index

Inherits:
Object
  • Object
show all
Defined in:
lib/tire/index.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, &block) ⇒ Index 



6
7
8
9
 
# File 'lib/tire/index.rb', line 6

def initialize(name, &block)
  @name = name
  block.arity < 1 ? instance_eval(&block) : block.call(self) if block_given?
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



4
5
6
 
# File 'lib/tire/index.rb', line 4

def name
  @name
end

#response ⇒ Object (readonly)

Returns the value of attribute response.



4
5
6
 
# File 'lib/tire/index.rb', line 4

def response
  @response
end

Instance Method Details

#add_alias(alias_name, configuration = {}) ⇒ Object 



43
44
45
 
# File 'lib/tire/index.rb', line 43

def add_alias(alias_name, configuration={})
  Alias.create(configuration.merge( :name => alias_name, :index => @name ) )
end

#aliases(alias_name = nil) ⇒ Object 



51
52
53
 
# File 'lib/tire/index.rb', line 51

def aliases(alias_name=nil)
  alias_name ? Alias.all(@name).select { |a| a.name == alias_name }.first : Alias.all(@name)
end

#analyze(text, options = {}) ⇒ Object 



378
379
380
381
382
383
384
385
386
387
 
# File 'lib/tire/index.rb', line 378

def analyze(text, options={})
  options = {:pretty => true}.update(options)
  params  = options.to_param
  @response = Configuration.client.get "#{url}/_analyze?#{params}", text
  @response.success? ? MultiJson.decode(@response.body) : false

ensure
  curl = %Q|curl -X GET "#{url}/_analyze?#{params}" -d '#{text}'|
  logged('_analyze', curl)
end

#bulk(action, documents, options = {}) ⇒ Object

Performs a bulk request

@myindex.bulk :index, [ {id: 1, title: 'One'}, { id: 2, title: 'Two', _version: 3 } ], refresh: true

Pass the action (index, create, delete) as the first argument, the collection of documents as the second argument, and URL parameters as the last option.

Any meta information contained in documents (such as _routing or _parent) is extracted and added to the "header" line.

Shortcut methods bulk_store, bulk_delete and bulk_create are available.



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
 
# File 'lib/tire/index.rb', line 162

def bulk(action, documents, options={})
  return false if documents.empty?

  # TODO: A more Ruby-like DSL notation should be supported:
  #
  #     Tire.index('myindex').bulk do
  #       create id: 1, title: 'bar', _routing: 'abc'
  #       delete id: 1
  #       # ...
  #     end

  payload = documents.map do |document|
    type = get_type_from_document(document, :escape => false) # Do not URL-escape the _type
    id   = get_id_from_document(document)

    if ENV['DEBUG']
      STDERR.puts "[ERROR] Document #{document.inspect} does not have ID" unless id
    end

    header = { action.to_sym => { :_index => name, :_type => type, :_id => id } }

    if document.respond_to?(:to_hash) && hash = document.to_hash
      meta = {}
      meta[:_version]   = hash.delete(:_version)
      meta[:_routing]   = hash.delete(:_routing)
      meta[:_percolate] = hash.delete(:_percolate)
      meta[:_parent]    = hash.delete(:_parent)
      meta[:_timestamp] = hash.delete(:_timestamp)
      meta[:_ttl]       = hash.delete(:_ttl)
      meta              = meta.reject { |name,value| !value || value.empty? }
      header[action.to_sym].update(meta)
    end

    output = []
    output << MultiJson.encode(header)
    output << convert_document_to_json(document) unless action.to_s == 'delete'
    output.join("\n")
  end
  payload << ""

  tries = 5
  count = 0

  begin
    params = {}
    params[:consistency] = options.delete(:consistency)
    params[:refresh]     = options.delete(:refresh)
    params               = params.reject { |name,value| !value }
    params_encoded       = params.empty? ? '' : "?#{params.to_param}"

    @response = Configuration.client.post("#{url}/_bulk#{params_encoded}", payload.join("\n"))
    raise RuntimeError, "#{@response.code} > #{@response.body}" if @response && @response.failure?
    @response
  rescue StandardError => error
    if count < tries
      count += 1
      STDERR.puts "[ERROR] #{error.message}, retrying (#{count})..."
      retry
    else
      STDERR.puts "[ERROR] Too many exceptions occured, giving up. The HTTP response was: #{error.message}"
      raise if options[:raise]
    end

  ensure
    curl = %Q|curl -X POST "#{url}/_bulk" --data-binary '{... data omitted ...}'|
    logged('_bulk', curl)
  end

end

#bulk_create(documents, options = {}) ⇒ Object 



232
233
234
 
# File 'lib/tire/index.rb', line 232

def bulk_create(documents, options={})
  bulk :create, documents, options
end

#bulk_delete(documents, options = {}) ⇒ Object 



240
241
242
 
# File 'lib/tire/index.rb', line 240

def bulk_delete(documents, options={})
  bulk :delete, documents, options
end

#bulk_store(documents, options = {}) ⇒ Object 



236
237
238
 
# File 'lib/tire/index.rb', line 236

def bulk_store(documents, options={})
  bulk :index, documents, options
end

#close(options = {}) ⇒ Object 



369
370
371
372
373
374
375
376
 
# File 'lib/tire/index.rb', line 369

def close(options={})
  @response = Configuration.client.post "#{url}/_close", MultiJson.encode(options)
  MultiJson.decode(@response.body)['ok']

ensure
  curl = %Q|curl -X POST "#{url}/_close"|
  logged('_close', curl)
end

#convert_document_to_json(document) ⇒ Object 



483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/tire/index.rb', line 483

def convert_document_to_json(document)
  document = case
    when document.is_a?(String)
      if ENV['DEBUG']
        Tire.warn "Passing the document as JSON string has been deprecated, " +
                   "please pass an object which responds to `to_indexed_json` or a plain Hash."
      end
      document
    when document.respond_to?(:to_indexed_json) then document.to_indexed_json
    else raise ArgumentError, "Please pass a JSON string or object with a 'to_indexed_json' method," +
                              "'#{document.class}' given."
  end
end

#create(options = {}) ⇒ Object 



33
34
35
36
37
38
39
40
41
 
# File 'lib/tire/index.rb', line 33

def create(options={})
  @options = options
  @response = Configuration.client.post url, MultiJson.encode(options)
  @response.success? ? @response : false

ensure
  curl = %Q|curl -X POST #{url} -d '#{MultiJson.encode(options, :pretty => Configuration.pretty)}'|
  logged('CREATE', curl)
end

#delete ⇒ Object 



24
25
26
27
28
29
30
31
 
# File 'lib/tire/index.rb', line 24

def delete
  @response = Configuration.client.delete url
  @response.success?

ensure
  curl = %Q|curl -X DELETE #{url}|
  logged('DELETE', curl)
end

#delete_mapping(type) ⇒ Object 



106
107
108
109
110
111
112
113
 
# File 'lib/tire/index.rb', line 106

def delete_mapping(type)
  url = "#{self.url}/#{type}"
  @response = Configuration.client.delete(url)
  @response.success?
ensure
  curl = %Q|curl -X DELETE "#{url}"|
  logged("DELETE MAPPING #{type}", curl)
end

#exists? ⇒ Boolean 



15
16
17
18
19
20
21
22
 
# File 'lib/tire/index.rb', line 15

def exists?
  @response = Configuration.client.head("#{url}")
  @response.success?

ensure
  curl = %Q|curl -I "#{url}"|
  logged('HEAD', curl)
end

#get_id_from_document(document) ⇒ Object 



471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/tire/index.rb', line 471

def get_id_from_document(document)
  old_verbose, $VERBOSE = $VERBOSE, nil # Silence Object#id deprecation warnings
  id = case
    when document.is_a?(Hash)
      document[:_id] || document['_id'] || document[:id] || document['id']
    when document.respond_to?(:id) && document.id != document.object_id
      document.id.as_json
  end
  $VERBOSE = old_verbose
  id
end

#get_mapping ⇒ Object 



78
79
80
81
82
83
84
85
 
# File 'lib/tire/index.rb', line 78

def get_mapping
  @response = Configuration.client.get("#{url}/_mapping")
  result = MultiJson.decode(@response.body)[@name]
  @response.success? ? result : false
ensure
  curl = %Q|curl -X GET "#{url}/_mapping?pretty"|
  logged("GET MAPPING", curl)
end

#get_type_from_document(document, options = {}) ⇒ Object 



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/tire/index.rb', line 451

def get_type_from_document(document, options={})
  options = {:escape => true}.merge(options)

  old_verbose, $VERBOSE = $VERBOSE, nil # Silence Object#type deprecation warnings
  type = case
    when document.respond_to?(:document_type)
      document.document_type
    when document.is_a?(Hash)
      document[:_type] || document['_type'] || document[:type] || document['type']
    when document.respond_to?(:_type)
      document._type
    when document.respond_to?(:type) && document.type != document.class
      document.type
    end
  $VERBOSE = old_verbose

  type ||= 'document'
  options[:escape] ? Utils.escape(type) : type
end

#import(klass_or_collection, options = {}) ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/tire/index.rb', line 244

def import(klass_or_collection, options={})
  case
    when method = options.delete(:method)
      options = {:page => 1, :per_page => 1000}.merge options
      while (documents = klass_or_collection.send(method.to_sym, options.merge(:page => options[:page]))) \
                        && documents.to_a.length > 0

        documents = yield documents if block_given?

        bulk_store documents, options
        GC.start
        options[:page] += 1
      end

    when klass_or_collection.respond_to?(:map)
      documents = block_given? ? yield(klass_or_collection) : klass_or_collection
      bulk_store documents, options

    else
      raise ArgumentError, "Please pass either an Enumerable compatible class, or a collection object " +
                           "with a method for fetching records in batches (such as 'paginate')."
  end
end

#logged(endpoint = '/', curl = '') ⇒ Object 



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/tire/index.rb', line 428

def logged(endpoint='/', curl='')
  if Configuration.logger
    error = $!

    Configuration.logger.log_request endpoint, @name, curl

    code = @response ? @response.code : error.class rescue 'N/A'

    if Configuration.logger.level.to_s == 'debug'
      body = if @response && @response.body && !@response.body.to_s.empty?
          MultiJson.encode( MultiJson.load(@response.body), :pretty => Configuration.pretty)
        elsif error && error.message && !error.message.to_s.empty?
          MultiJson.encode( MultiJson.load(error.message), :pretty => Configuration.pretty) rescue ''
        else ''
      end
    else
      body = ''
    end

    Configuration.logger.log_response code, nil, body
  end
end

#mapping(*args) ⇒ Object

Get or update the index mapping

Without arguments, returns the index mapping as a Hash

When passed arguments, attempts to update the index mapping:

index.mapping 'article', properties: { body: { type: "string" } }

You can pass the ignore_conflicts option as a part of the Hash:

index.mapping 'article', properties: { body: { type: "string" } }, ignore_conflicts: true



67
68
69
 
# File 'lib/tire/index.rb', line 67

def mapping(*args)
  args.empty? ? get_mapping : put_mapping(*args)
end

#mapping!(*args) ⇒ Object

Raises an exception for unsuccessful responses

Raises:

  • (RuntimeError) 


73
74
75
76
 
# File 'lib/tire/index.rb', line 73

def mapping!(*args)
  mapping(*args)
  raise RuntimeError, response.body unless response.success?
end

#open(options = {}) ⇒ Object 



359
360
361
362
363
364
365
366
367
 
# File 'lib/tire/index.rb', line 359

def open(options={})
  # TODO: Remove the duplication in the execute > rescue > ensure chain
  @response = Configuration.client.post "#{url}/_open", MultiJson.encode(options)
  MultiJson.decode(@response.body)['ok']

ensure
  curl = %Q|curl -X POST "#{url}/_open"|
  logged('_open', curl)
end

#percolate(*args, &block) ⇒ Object 



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/tire/index.rb', line 409

def percolate(*args, &block)
  document = args.shift
  type     = get_type_from_document(document)

  document = MultiJson.decode convert_document_to_json(document)

  query = Search::Query.new(&block).to_hash if block_given?

  payload = { :doc => document }
  payload.update( :query => query ) if query

  @response = Configuration.client.get "#{url}/#{type}/_percolate", MultiJson.encode(payload)
  MultiJson.decode(@response.body)['matches']

ensure
  curl = %Q|curl -X GET "#{url}/#{type}/_percolate?pretty" -d '#{MultiJson.encode(payload, :pretty => Configuration.pretty)}'|
  logged('_percolate', curl)
end

#put_mapping(type, mapping) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/tire/index.rb', line 87

def put_mapping(type, mapping)
  params = {}
  if ignore_conflicts = mapping.delete(:ignore_conflicts) || mapping.delete("ignore_conflicts")
    params[:ignore_conflicts] = ignore_conflicts
  end

  url  = "#{self.url}/#{type}/_mapping"
  url += "?#{params.to_param}" unless params.empty?

  payload = { type => mapping }.to_json

  @response = Configuration.client.put url, payload
  result = MultiJson.decode(@response.body)
  @response.success? ? result : false
ensure
  curl = %Q|curl -X PUT "#{url}" -d '#{payload}'|
  logged("PUT MAPPING #{type}", curl)
end

#refresh ⇒ Object 



351
352
353
354
355
356
357
 
# File 'lib/tire/index.rb', line 351

def refresh
  @response = Configuration.client.post "#{url}/_refresh", ''

ensure
  curl = %Q|curl -X POST "#{url}/_refresh"|
  logged('_refresh', curl)
end

#register_percolator_query(name, options = {}, &block) ⇒ Object 



389
390
391
392
393
394
395
396
397
398
 
# File 'lib/tire/index.rb', line 389

def register_percolator_query(name, options={}, &block)
  options[:query] = Search::Query.new(&block).to_hash if block_given?

  @response = Configuration.client.put "#{Configuration.url}/_percolator/#{@name}/#{name}", MultiJson.encode(options)
  MultiJson.decode(@response.body)['ok']

ensure
  curl = %Q|curl -X PUT "#{Configuration.url}/_percolator/#{@name}/#{name}?pretty" -d '#{MultiJson.encode(options, :pretty => Configuration.pretty)}'|
  logged('_percolator', curl)
end

#reindex(name, options = {}, &block) ⇒ Object 



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/tire/index.rb', line 268

def reindex(name, options={}, &block)
  new_index = Index.new(name)
  new_index.create(options) unless new_index.exists?

  transform = options.delete(:transform)

  Search::Scan.new(self.name, &block).each do |results|

    documents = results.map do |document|
      document  = document.to_hash.except(:type, :_index, :_explanation, :_score, :_version, :highlight, :sort)
      document  = transform.call(document) if transform
      document
    end

    new_index.bulk_store documents
  end
end

#remove(*args) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/tire/index.rb', line 286

def remove(*args)
  if args.size > 1
    type, document = args
    type           = Utils.escape(type)
    id             = get_id_from_document(document) || document
  else
    document = args.pop
    type     = get_type_from_document(document)
    id       = get_id_from_document(document) || document
  end
  raise ArgumentError, "Please pass a document ID" unless id

  url    = "#{self.url}/#{type}/#{Utils.escape(id)}"
  result = Configuration.client.delete url
  MultiJson.decode(result.body) if result.success?

ensure
  curl = %Q|curl -X DELETE "#{url}"|
  logged("#{type}/#{id}", curl)
end

#remove_alias(alias_name) ⇒ Object 



47
48
49
 
# File 'lib/tire/index.rb', line 47

def remove_alias(alias_name)
  Alias.find(alias_name) { |a| a.indices.delete @name }.save
end

#retrieve(type, id, options = {}) ⇒ Object 



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
 
# File 'lib/tire/index.rb', line 307

def retrieve(type, id, options={})
  raise ArgumentError, "Please pass a document ID" unless id

  url       = "#{self.url}/#{Utils.escape(type)}/#{Utils.escape(id)}"

  params    = {}
  params[:routing]    = options[:routing] if options[:routing]
  params[:fields]     = options[:fields]  if options[:fields]
  params[:preference] = options[:preference] if options[:preference]
  params_encoded      = params.empty? ? '' : "?#{params.to_param}"

  @response = Configuration.client.get "#{url}#{params_encoded}"

  h = MultiJson.decode(@response.body)
  wrapper = options[:wrapper] || Configuration.wrapper
  if wrapper == Hash then h
  else
    return nil if h['exists'] == false
    document = h['_source'] || h['fields'] || {}
    document.update('id' => h['_id'], '_type' => h['_type'], '_index' => h['_index'], '_version' => h['_version'])
    wrapper.new(document)
  end

ensure
  curl = %Q|curl -X GET "#{url}"|
  logged("#{type}/#{id}", curl)
end

#settings ⇒ Object 



115
116
117
118
 
# File 'lib/tire/index.rb', line 115

def settings
  @response = Configuration.client.get("#{url}/_settings")
  MultiJson.decode(@response.body)[@name]['settings']
end

#store(*args) ⇒ Object 



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
 
# File 'lib/tire/index.rb', line 120

def store(*args)
  document, options = args

  id       = get_id_from_document(document)
  type     = get_type_from_document(document)
  document = convert_document_to_json(document)

  options ||= {}
  params    = {}

  if options[:percolate]
    params[:percolate] = options[:percolate]
    params[:percolate] = "*" if params[:percolate] === true
  end

  params[:parent]  = options[:parent]  if options[:parent]
  params[:routing] = options[:routing] if options[:routing]
  params[:replication] = options[:replication] if options[:replication]

  params_encoded = params.empty? ? '' : "?#{params.to_param}"

  url  = id ? "#{self.url}/#{type}/#{Utils.escape(id)}#{params_encoded}" : "#{self.url}/#{type}/#{params_encoded}"

  @response = Configuration.client.post url, document
  MultiJson.decode(@response.body)
ensure
  curl = %Q|curl -X POST "#{url}" -d '#{document}'|
  logged([type, id].join('/'), curl)
end

#unregister_percolator_query(name) ⇒ Object 



400
401
402
403
404
405
406
407
 
# File 'lib/tire/index.rb', line 400

def unregister_percolator_query(name)
  @response = Configuration.client.delete "#{Configuration.url}/_percolator/#{@name}/#{name}"
  MultiJson.decode(@response.body)['ok']

ensure
  curl = %Q|curl -X DELETE "#{Configuration.url}/_percolator/#{@name}"|
  logged('_percolator', curl)
end

#update(type, id, payload = {}, options = {}) ⇒ Object 



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/tire/index.rb', line 335

def update(type, id, payload={}, options={})
  raise ArgumentError, "Please pass a document type" unless type
  raise ArgumentError, "Please pass a document ID"   unless id
  raise ArgumentError, "Please pass a script or partial document in the payload hash" unless payload[:script] || payload[:doc]

  type      = Utils.escape(type)
  url       = "#{self.url}/#{type}/#{Utils.escape(id)}/_update"
  url      += "?#{options.to_param}" unless options.keys.empty?
  @response = Configuration.client.post url, MultiJson.encode(payload)
  MultiJson.decode(@response.body)

ensure
  curl = %Q|curl -X POST "#{url}" -d '#{MultiJson.encode(payload, :pretty => Configuration.pretty)}'|
  logged(id, curl)
end

#url ⇒ Object 



11
12
13
 
# File 'lib/tire/index.rb', line 11

def url
  "#{Configuration.url}/#{@name}"
end