Class: RSolr::Xml::Generator

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

Instance Method Summary collapse

Instance Method Details

#add(data, add_attrs = nil, &block) ⇒ 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”.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/rsolr/xml.rb', line 106

def add data, add_attrs = nil, &block
  add_attrs ||= {}
  data = [data] unless data.is_a?(Array)
  build do |xml|
    xml.add(add_attrs) do |add_node|
      data.each do |doc|
        doc = RSolr::Xml::Document.new(doc) if doc.respond_to?(:each_pair)
        yield doc if block_given?
        add_node.doc(doc.attrs) do |doc_node|
          doc.fields.each do |field_obj|
            doc_node.field field_obj.value, field_obj.attrs
          end
        end
      end
    end
  end
end

#build(&block) ⇒ Object 



75
76
77
78
79
 
# File 'lib/rsolr/xml.rb', line 75

def build &block
  b = ::Builder::XmlMarkup.new(:indent => 0, :margin => 0, :encoding => 'UTF-8')
  b.instruct!
  block_given? ? yield(b) : b
end

#commit(opts = nil) ⇒ Object

generates a <commit/> message



125
126
127
128
 
# File 'lib/rsolr/xml.rb', line 125

def commit opts = nil
  opts ||= {}
  build {|xml| xml.commit(opts) }
end

#delete_by_id(ids) ⇒ Object

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



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

def delete_by_id ids
  ids = [ids] unless ids.is_a?(Array)
  build do |xml|
    xml.delete do |delete_node|
      ids.each { |id| delete_node.id(id) }
    end
  end
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



154
155
156
157
158
159
160
161
 
# File 'lib/rsolr/xml.rb', line 154

def delete_by_query(queries)
  queries = [queries] unless queries.is_a?(Array)
  build do |xml|
    xml.delete do |delete_node|
      queries.each { |query| delete_node.query(query) }
    end
  end
end

#optimize(opts = nil) ⇒ Object

generates a <optimize/> message



131
132
133
134
 
# File 'lib/rsolr/xml.rb', line 131

def optimize opts = nil
  opts ||= {}
  build {|xml| xml.optimize(opts) }
end

#rollback ⇒ Object

generates a <rollback/> message



137
138
139
 
# File 'lib/rsolr/xml.rb', line 137

def rollback
  build {|xml| xml.rollback({}) }
end