Class: Tire::Index
- Inherits:
-
Object
- Object
- Tire::Index
- Defined in:
- lib/tire/index.rb
Instance Attribute Summary collapse
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#response ⇒ Object
readonly
Returns the value of attribute response.
Instance Method Summary collapse
- #add_alias(alias_name, configuration = {}) ⇒ Object
- #aliases(alias_name = nil) ⇒ Object
- #analyze(text, options = {}) ⇒ Object
- #bulk_store(documents, options = {}) ⇒ Object
- #close(options = {}) ⇒ Object
- #convert_document_to_json(document) ⇒ Object
- #create(options = {}) ⇒ Object
- #delete ⇒ Object
- #exists? ⇒ Boolean
- #get_id_from_document(document) ⇒ Object
- #get_type_from_document(document, options = {}) ⇒ Object
- #import(klass_or_collection, options = {}) ⇒ Object
-
#initialize(name, &block) ⇒ Index
constructor
A new instance of Index.
- #logged(endpoint = '/', curl = '') ⇒ Object
- #mapping ⇒ Object
- #open(options = {}) ⇒ Object
- #percolate(*args, &block) ⇒ Object
- #refresh ⇒ Object
- #register_percolator_query(name, options = {}, &block) ⇒ Object
- #reindex(name, options = {}, &block) ⇒ Object
- #remove(*args) ⇒ Object
- #remove_alias(alias_name) ⇒ Object
- #retrieve(type, id) ⇒ Object
- #settings ⇒ Object
- #store(*args) ⇒ Object
- #unregister_percolator_query(name) ⇒ Object
- #url ⇒ Object
Constructor Details
#initialize(name, &block) ⇒ Index
Returns a new instance of 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
228 229 230 231 232 233 234 235 236 237 |
# File 'lib/tire/index.rb', line 228 def analyze(text, ={}) = {:pretty => true}.update() params = .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_store(documents, options = {}) ⇒ Object
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 |
# File 'lib/tire/index.rb', line 88 def bulk_store(documents, ={}) 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) STDERR.puts "[ERROR] Document #{document.inspect} does not have ID" unless id output = [] output << %Q|{"index":{"_index":"#{@name}","_type":"#{type}","_id":"#{id}"}}| output << convert_document_to_json(document) output.join("\n") end payload << "" tries = 5 count = 0 begin response = Configuration.client.post("#{url}/_bulk", payload.join("\n")) raise RuntimeError, "#{response.code} > #{response.body}" if response.failure? response rescue StandardError => error if count < tries count += 1 STDERR.puts "[ERROR] #{error.}, retrying (#{count})..." retry else STDERR.puts "[ERROR] Too many exceptions occured, giving up. The HTTP response was: #{error.}" raise if [:raise] end ensure curl = %Q|curl -X POST "#{url}/_bulk" -d '{... data omitted ...}'| logged('BULK', curl) end end |
#close(options = {}) ⇒ Object
219 220 221 222 223 224 225 226 |
# File 'lib/tire/index.rb', line 219 def close(={}) @response = Configuration.client.post "#{url}/_close", MultiJson.encode() MultiJson.decode(@response.body)['ok'] ensure curl = %Q|curl -X POST "#{url}/_close"| logged('_close', curl) end |
#convert_document_to_json(document) ⇒ Object
332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/tire/index.rb', line 332 def convert_document_to_json(document) document = case when document.is_a?(String) Tire.warn "Passing the document as JSON string in Index#store has been deprecated, " + "please pass an object which responds to `to_indexed_json` or a plain Hash." 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 = @response = Configuration.client.post url, MultiJson.encode() @response.success? ? @response : false ensure curl = %Q|curl -X POST #{url} -d '#{MultiJson.encode()}'| 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 |
#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
320 321 322 323 324 325 326 327 328 329 330 |
# File 'lib/tire/index.rb', line 320 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 end $VERBOSE = old_verbose id end |
#get_type_from_document(document, options = {}) ⇒ Object
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/tire/index.rb', line 300 def get_type_from_document(document, ={}) = {:escape => true}.merge() 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' [:escape] ? Utils.escape(type) : type end |
#import(klass_or_collection, options = {}) ⇒ Object
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/tire/index.rb', line 125 def import(klass_or_collection, ={}) case when method = .delete(:method) = {:page => 1, :per_page => 1000}.merge while documents = klass_or_collection.send(method.to_sym, .merge(:page => [:page])) \ and documents.to_a.length > 0 documents = yield documents if block_given? bulk_store documents, [:page] += 1 end when klass_or_collection.respond_to?(:map) documents = block_given? ? yield(klass_or_collection) : klass_or_collection bulk_store documents, 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
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/tire/index.rb', line 278 def logged(endpoint='/', curl='') if Configuration.logger error = $! Configuration.logger.log_request endpoint, @name, curl code = @response ? @response.code : error.class rescue 200 if Configuration.logger.level.to_s == 'debug' body = if @response defined?(Yajl) ? Yajl::Encoder.encode(@response.body, :pretty => true) : MultiJson.encode(@response.body) else error. rescue '' end else body = '' end Configuration.logger.log_response code, nil, body end end |
#mapping ⇒ Object
55 56 57 58 |
# File 'lib/tire/index.rb', line 55 def mapping @response = Configuration.client.get("#{url}/_mapping") MultiJson.decode(@response.body)[@name] end |
#open(options = {}) ⇒ Object
209 210 211 212 213 214 215 216 217 |
# File 'lib/tire/index.rb', line 209 def open(={}) # TODO: Remove the duplication in the execute > rescue > ensure chain @response = Configuration.client.post "#{url}/_open", MultiJson.encode() MultiJson.decode(@response.body)['ok'] ensure curl = %Q|curl -X POST "#{url}/_open"| logged('_open', curl) end |
#percolate(*args, &block) ⇒ Object
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'lib/tire/index.rb', line 259 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=1" -d '#{payload.to_json}'| logged('_percolate', curl) end |
#refresh ⇒ Object
201 202 203 204 205 206 207 |
# File 'lib/tire/index.rb', line 201 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
239 240 241 242 243 244 245 246 247 248 |
# File 'lib/tire/index.rb', line 239 def register_percolator_query(name, ={}, &block) [:query] = Search::Query.new(&block).to_hash if block_given? @response = Configuration.client.put "#{Configuration.url}/_percolator/#{@name}/#{name}", MultiJson.encode() MultiJson.decode(@response.body)['ok'] ensure curl = %Q|curl -X PUT "#{Configuration.url}/_percolator/#{@name}/?pretty=1" -d '#{MultiJson.encode()}'| logged('_percolator', curl) end |
#reindex(name, options = {}, &block) ⇒ Object
148 149 150 151 152 153 154 155 156 157 |
# File 'lib/tire/index.rb', line 148 def reindex(name, ={}, &block) new_index = Index.new(name) new_index.create() unless new_index.exists? Search::Scan.new(self.name, &block).each do |results| new_index.bulk_store results.map do |document| document.to_hash.except(:type, :_index, :_explanation, :_score, :_version, :highlight, :sort) end end end |
#remove(*args) ⇒ Object
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
# File 'lib/tire/index.rb', line 159 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}/#{id}" result = Configuration.client.delete url MultiJson.decode(result.body) if result.success? ensure curl = %Q|curl -X DELETE "#{url}"| logged(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) ⇒ Object
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/tire/index.rb', line 180 def retrieve(type, id) raise ArgumentError, "Please pass a document ID" unless id type = Utils.escape(type) url = "#{self.url}/#{type}/#{id}" @response = Configuration.client.get url h = MultiJson.decode(@response.body) if Configuration.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']) Configuration.wrapper.new(document) end ensure curl = %Q|curl -X GET "#{url}"| logged(id, curl) end |
#settings ⇒ Object
60 61 62 63 |
# File 'lib/tire/index.rb', line 60 def settings @response = Configuration.client.get("#{url}/_settings") MultiJson.decode(@response.body)[@name]['settings'] end |
#store(*args) ⇒ Object
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/tire/index.rb', line 65 def store(*args) document, = args type = get_type_from_document(document) if percolate = [:percolate] percolate = "*" if percolate === true end id = get_id_from_document(document) document = convert_document_to_json(document) url = id ? "#{self.url}/#{type}/#{id}" : "#{self.url}/#{type}/" url += "?percolate=#{percolate}" if percolate @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
250 251 252 253 254 255 256 257 |
# File 'lib/tire/index.rb', line 250 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 |
#url ⇒ Object
11 12 13 |
# File 'lib/tire/index.rb', line 11 def url "#{Configuration.url}/#{@name}" end |