Class: RSolr::Message::Builder

Inherits:
Object
  • Object
show all
Defined in:
lib/rsolr/message.rb

Instance Method Summary collapse

Instance Method Details

#add(data, add_attrs = {}) ⇒ Object

generates “add” xml for updating solr “data” can be a hash or an array of hashes.

  • each hash should be a simple key=>value pair representing a solr doc.

If a value is an array, multiple fields will be created.

“add_attrs” can be a hash for setting the add xml element attributes.

This method can also accept a block. The value yielded to the block is a Message::Document; for each solr doc in “data”. You can set xml element attributes for each “doc” element or individual “field” elements.

For example:

solr.add(:nickname=>‘Tim’, :commitWithin=>1.0) do |doc_msg|

doc_msg.attrs[:boost] = 10.00 # boost the document
nickname = doc_msg.field_by_name(:nickname)
nickname.attrs[:boost] = 20 if nickname.value=='Tim' # boost a field

end

would result in an add element having the attributes boost=“10.0” and a commitWithin=“1.0”. Each doc element would have a boost=“10.0”. The “nickname” field would have a boost=“20.0” if the doc had a “nickname” field with the value of “Tim”.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/rsolr/message.rb', line 102

def add(data, add_attrs={})
  data = [data] unless data.is_a?(Array)
  add = Xout.new :add, add_attrs
  data.each do |doc|
    doc = Document.new(doc) if doc.respond_to?(:each_pair)
    yield doc if block_given?
    add.child :doc, doc.attrs do |doc_node|
      doc.fields.each do |field_obj|
        doc_node.child :field, field_obj.value, field_obj.attrs
      end
    end
  end
  add.to_xml
end

#commit(opts = {}) ⇒ Object

generates a <commit/> message



118
119
120
 
# File 'lib/rsolr/message.rb', line 118

def commit(opts={})
  Xout.new(:commit, opts).to_xml
end

#delete_by_id(ids) ⇒ Object

generates a <delete><id>ID</id></delete> message “ids” can be a single value or array of values



134
135
136
137
138
139
140
 
# File 'lib/rsolr/message.rb', line 134

def delete_by_id(ids)
  ids = [ids] unless ids.is_a?(Array)
  delete_node = Xout.new(:delete) do |xml|
    ids.each { |id| xml.child :id, id }
  end
  delete_node.to_xml
end

#delete_by_query(queries) ⇒ Object

generates a <delete><query>ID</query></delete> message “queries” can be a single value or an array of values



144
145
146
147
148
149
150
 
# File 'lib/rsolr/message.rb', line 144

def delete_by_query(queries)
  queries = [queries] unless queries.is_a?(Array)
  delete_node = Xout.new(:delete) do |xml|
    queries.each { |query| xml.child :query, query }
  end
  delete_node.to_xml
end

#optimize(opts = {}) ⇒ Object

generates a <optimize/> message



123
124
125
 
# File 'lib/rsolr/message.rb', line 123

def optimize(opts={})
  Xout.new(:optimize, opts).to_xml
end

#rollback ⇒ Object

generates a <rollback/> message



128
129
130
 
# File 'lib/rsolr/message.rb', line 128

def rollback
  Xout.new(:rollback).to_xml
end