gem 'sunspot_rails' gem 'sunspot_solr' # optional pre-packaged Solr distribution for use in development. Not for use in production.

class Post < ActiveRecord::Base searchable do text :title, :body text :comments do comments.map { |comment| comment.body } end boolean :featured integer :blog_id integer :author_id integer :category_ids, :multiple => true double :average_rating time :published_at time :expired_at string :sort_title do title.downcase.gsub(/^(an?|the)/, '') end end end

class Comment < ActiveRecord::Base searchable do # NOTE: this is not necessary, Solr uses '_root_' field to refer to the parent document integer :post_id # ------------------------------------------------------------------------------------- integer :author_id text :body time :published_at end end class Post < ActiveRecord::Base searchable do text :title, :body child_documents :comments # Must be of type Comment boolean :featured integer :blog_id integer :author_id integer :category_ids, :multiple => true double :average_rating time :published_at time :expired_at string :sort_title do title.downcase.gsub(/^(an?|the)/, '') end end end

Post.search do fulltext 'best pizza' with :blog_id, 1 with(:published_at).less_than Time.now field_list :blog_id, :title order_by :published_at, :desc paginate :page => 2, :per_page => 15 facet :category_ids, :author_id end

# All posts with a `text` field (:title, :body, or :comments) containing 'pizza' Post.search { fulltext 'pizza' } # Posts with pizza, scored higher if pizza appears in the title Post.search do fulltext 'pizza' do boost_fields :title => 2.0 end end # Posts with pizza, scored higher if featured Post.search do fulltext 'pizza' do boost(2.0) { with(:featured, true) } end end # Posts with pizza *only* in the title Post.search do fulltext 'pizza' do fields(:title) end end # Posts with pizza in the title (boosted) or in the body (not boosted) Post.search do fulltext 'pizza' do fields(:body, :title => 2.0) end end

# Posts with the exact phrase "great pizza" Post.search do fulltext '"great pizza"' end

# One word can appear between the words in the phrase, so "great big pizza" # also matches, in addition to "great pizza" Post.search do fulltext '"great pizza"' do query_phrase_slop 1 end end

# Matches documents with great and pizza, and scores documents more # highly if the terms appear in a phrase in the title field Post.search do fulltext 'great pizza' do phrase_fields :title => 2.0 end end # Matches documents with great and pizza, and scores documents more # highly if the terms appear in a phrase (or with one word between them) # in the title field Post.search do fulltext 'great pizza' do phrase_fields :title => 2.0 phrase_slop 1 end end

# Posts with a blog_id of 1 Post.search do with(:blog_id, 1) end # Posts with an average rating between 3.0 and 5.0 Post.search do with(:average_rating, 3.0..5.0) end # Posts with a category of 1, 3, or 5 Post.search do with(:category_ids, [1, 3, 5]) end # Posts published since a week ago Post.search do with(:published_at).greater_than(1.week.ago) end

# Posts not in category 1 or 3 Post.search do without(:category_ids, [1, 3]) end # All examples in "positive" also work negated using `without`

# Passing an empty array is equivalent to a no-op, allowing you to replace this... Post.search do with(:category_ids, id_list) if id_list.present? end # ...with this Post.search do with(:category_ids, id_list) end

# Posts with a blog_id of 1 Post.search do with(:blog_id, 1) field_list [:title] end Post.search do without(:category_ids, [1, 3]) field_list [:title, :author_id] end

# Posts that do not have an expired time or have not yet expired Post.search do any_of do with(:expired_at).greater_than(Time.now) with(:expired_at, nil) end end

# Posts with blog_id 1 and author_id 2 Post.search do all_of do with(:blog_id, 1) with(:author_id, 2) end end

# Posts scoring with any of the two fields. Post.search do any do fulltext "keyword1", :fields => :title fulltext "keyword2", :fields => :body end end

Post.search do any_of do with(:blog_id, 1) all_of do with(:blog_id, 2) with(:category_ids, 3) end end any do all do fulltext "keyword", :fields => :title fulltext "keyword", :fields => :body end all do fulltext "keyword", :fields => :first_name fulltext "keyword", :fields => :last_name end fulltext "keyword", :fields => :description end end

# Posts with blog_id 1 and 'pizza' in the title Post.search do with(:blog_id, 1) fulltext("pizza") end

# Search all children which has a parent named as specified below. Sunspot.search(Child) do child_of(Parent) do with(:name, 'FirstName LastName') end end

# Search all parents which have children # that are between 12 and 17 years old. Sunspot.search(Parent) do parent_which(Child) do with :age, 12..17 end end

search = Post.search do fulltext "pizza" end # Imagine there are 60 *total* results (at 30 results/page, that is two pages) results = search.results # => Array with 30 Post elements search.total # => 60 results.total_pages # => 2 results.first_page? # => true results.last_page? # => false results.previous_page # => nil results.next_page # => 2 results.out_of_bounds? # => false results.offset # => 0

search = Post.search do fulltext "pizza" paginate :page => 2 end # Again, imagine there are 60 total results; this is the second page results = search.results # => Array with 30 Post elements search.total # => 60 results.total_pages # => 2 results.first_page? # => false results.last_page? # => true results.previous_page # => 1 results.next_page # => nil results.out_of_bounds? # => false results.offset # => 30

search = Post.search do fulltext "pizza" paginate :page => 1, :per_page => 50 end

search = Post.search do fulltext "pizza" paginate :cursor => "*" end results = search.results # Results will contain cursor for the next page results.next_page_cursor # => "AoIIP4AAACxQcm9maWxlIDEwMTk=" # Imagine there are 60 *total* results (at 30 results/page, that is two pages) results.current_cursor # => "*" results.total_pages # => 2 results.first_page? # => true results.last_page? # => false

search = Post.search do fulltext "pizza" paginate :cursor => "AoIIP4AAACxQcm9maWxlIDEwMTk=" end results = search.results # Again, imagine there are 60 total results; this is the second page results.next_page_cursor # => "AoEsUHJvZmlsZSAxNzY5" results.current_cursor # => "AoIIP4AAACxQcm9maWxlIDEwMTk=" results.total_pages # => 2 results.first_page? # => false # Last page will be detected only when current page contains less then per_page elements or contains nothing results.last_page? # => false

# Posts that match 'pizza' returning counts for each :author_id search = Post.search do fulltext "pizza" facet :author_id end search.facet(:author_id).rows.each do |facet| puts "Author #{facet.value} has #{facet.count} pizza posts!" end

# Posts that match 'pizza' and author with id 42 # Returning counts for each :author_id (even those not in the search result) search = Post.search do fulltext "pizza" author_filter = with(:author_id, 42) facet :author_id, exclude: [author_filter] end search.facet(:author_id).rows.each do |facet| puts "Author #{facet.value} has #{facet.count} pizza posts!" end

# Posts faceted by ranges of average ratings search = Post.search do facet(:average_rating) do row(1.0..2.0) do with(:average_rating, 1.0..2.0) end row(2.0..3.0) do with(:average_rating, 2.0..3.0) end row(3.0..4.0) do with(:average_rating, 3.0..4.0) end row(4.0..5.0) do with(:average_rating, 4.0..5.0) end end end # e.g., # Number of posts with rating within 1.0..2.0: 2 # Number of posts with rating within 2.0..3.0: 1 search.facet(:average_rating).rows.each do |facet| puts "Number of posts with rating within #{facet.value}: #{facet.count}" end

# Posts faceted by range of average ratings Sunspot.search(Post) do facet :average_rating, :range => 1..5, :range_interval => 1 end

Sunspot.search(Post) do json_facet(:title) end

# limit the results to 10 Sunspot.search(Post) do json_facet(:title, limit: 10) end # returns only the results with a minimum count of 10 Sunspot.search(Post) do json_facet(:title, minimum_count: 10) end # sort by count Sunspot.search(Post) do json_facet(:title, sort: :count) end # filter titles by prefix 't' Sunspot.search(Post) do json_facet(:title, prefix: 't') end

# Get posts with distinct title # available stategies: :unique, :hll Sunspot.search(Post) do json_facet(:blog_id, distinct: { group_by: :title, strategy: :unique }) end

Sunspot.search(Post) do json_facet(:title, nested: { field: :author_name } ) end

Sunspot.search(Post) do json_facet(:title, nested: { field: :author_name, nested: { field: :title } ) end

# Search for all books with specified title and facets # on the timestamp of reviews. # An additional filter on children can be specified inside the on_child operator.  Sunspot.search(Book) do fulltext 'awesome book title', fields: [:title] json_facet :review_date, block_join: (on_child(Review) do with(:review_date).greater_than(DateTime.parse('2015-01-01T00:00:00Z')) end) end

# Search for all reviews of a particular author. # Perform faceting on the book category. Sunspot.search(Review) do with :author, 'yonik' # An empty block means no additional filters: takes all parents # of the selected children.  json_facet :category, block_join: on_parent(Book) {} end

# Order by average rating, descending Post.search do fulltext("pizza") order_by(:average_rating, :desc) end # Order by relevancy score and in the case of a tie, average rating Post.search do fulltext("pizza") order_by(:score, :desc) order_by(:average_rating, :desc) end # Randomized ordering Post.search do fulltext("pizza") order_by(:random) end

# Order by sum of two example fields: rating1 + rating2 Post.search do fulltext("pizza") order_by_function(:sum, :rating1, :rating2, :desc) end # Order by nested functions: rating1 + (rating2*rating3) Post.search do fulltext("pizza") order_by_function(:sum, :rating1, [:product, :rating2, :rating3], :desc) end # Order by fields and constants: rating1 + (rating2 * 5) Post.search do fulltext("pizza") order_by_function(:sum, :rating1, [:product, :rating2, '5'], :desc) end # Order by average of three fields: (rating1 + rating2 + rating3) / 3 Post.search do fulltext("pizza") order_by_function(:div, [:sum, :rating1, :rating2, :rating3], '3', :desc) end

class Post < ActiveRecord::Base searchable do # Denormalized `string` field because grouping can only be performed # on string fields string(:blog_id_str) { |p| p.blog_id.to_s } end end # Returns only the top scoring document per blog_id search = Post.search do group :blog_id_str end search.group(:blog_id_str).matches # Total number of matches to the query search.group(:blog_id_str).groups.each do |group| puts group.value # blog_id of the each document in the group # By default, there is only one document per group (the highest # scoring one); if `limit` is specified (see below), multiple # documents can be returned per group group.results.each do |result| # ... end end

# Returns the top 3 scoring documents per blog_id Post.search do group :blog_id_str do limit 3 ngroups false # If you don't need the total groups counter end end # Returns document ordered within each group by published_at (by # default, the ordering is score) Post.search do group :blog_id_str do order_by(:average_rating, :desc) end end # Facet count is based on the most relevant document of each group # matching the query (>= Solr 3.4) Post.search do group :blog_id_str do truncate end facet :blog_id_str, :extra => :any end

# Returns the top post for each range of average ratings search = Post.search do group do query("1.0 to 2.0") do with(:average_rating, 1.0..2.0) end query("2.0 to 3.0") do with(:average_rating, 2.0..3.0) end query("3.0 to 4.0") do with(:average_rating, 3.0..4.0) end query("4.0 to 5.0") do with(:average_rating, 4.0..5.0) end end end search.group(:queries).matches # Total number of matches to the queries search.group(:queries).groups.each do |group| puts group.value # The argument to query - "1.0 to 2.0", for example group.results.each do |result| # ... end end

# This finds the top 10 posts for each category in category_ids. search = Post.search do group do limit 10 category_ids.each do |category_id| query category_id do with(:category_id, category_id) end end end end

class Post < ActiveRecord::Base searchable do # ... latlon(:location) { Sunspot::Util::Coordinates.new(lat, lon) } end end

# Searches posts within 100 kilometers of (32, -68) Post.search do with(:location).in_radius(32, -68, 100) end

# Searches posts within 100 kilometers of (32, -68) with `bbox`. This is # an approximation so searches run quicker, but it may include other # points that are slightly outside of the required distance Post.search do with(:location).in_radius(32, -68, 100, :bbox => true) end

# Searches posts within the bounding box defined by the corners (45, # -94) to (46, -93) Post.search do with(:location).in_bounding_box([45, -94], [46, -93]) end

# Orders documents by closeness to (32, -68) Post.search do order_by_geodist(:location, 32, -68) end

class Photo < ActiveRecord::Base searchable do text :description string :caption, :default_boost => 1.5 time :created_at integer :photo_container_id end end class PhotoContainer < ActiveRecord::Base searchable do text :name join(:description, :target => Photo, :type => :text, :join => { :from => :photo_container_id, :to => :id }) join(:caption, :target => Photo, :type => :string, :join => { :from => :photo_container_id, :to => :id }) join(:photos_created, :target => Photo, :type => :time, :join => { :from => :photo_container_id, :to => :id }, :as => 'created_at_d') end end PhotoContainer.search do with(:caption, 'blah') with(:photos_created).between(Date.new(2011,3,1)..Date.new(2011,4,1)) fulltext("keywords", :fields => [:name, :description]) end # ...or PhotoContainer.search do with(:caption, 'blah') with(:photos_created).between(Date.new(2011,3,1)..Date.new(2011,4,1)) any do fulltext("keyword1", :fields => :name) fulltext("keyword2", :fields => :description) # will be joined from the Photo model end end

class Tweet < ActiveRecord::Base searchable do text :keywords integer :profile_id end end class Rss < ActiveRecord::Base searchable do text :keywords integer :profile_id end end class Profile < ActiveRecord::Base searchable do text :name join(:keywords, :prefix => "tweet", :target => Tweet, :type => :text, :join => { :from => :profile_id, :to => :id }) join(:keywords, :prefix => "rss", :target => Rss, :type => :text, :join => { :from => :profile_id, :to => :id }) end end Profile.search do any do fulltext("keyword1 keyword2", :fields => [:tweet_keywords]) do minimum_match 1 end fulltext("keyword3", :fields => [:rss_keywords]) end end # ...produces: # sort: "score desc", fl: "* score", start: 0, rows: 20, # fq: ["type:Profile"], # q: (_query_:"{!join from=profile_ids_i to=id_i v=$qTweet91755700}" OR _query_:"{!join from=profile_ids_i to=id_i v=$qRss91753840}"), # qTweet91755700: _query_:"{!field f=type}Tweet"+_query_:"{!edismax qf='keywords_text' mm='1'}keyword1 keyword2", # qRss91753840: _query_:"{!field f=type}Rss"+_query_:"{!edismax qf='keywords_text'}keyword3"

class Post < ActiveRecord::Base searchable do id_prefix "IBM!" # ... end end

class Post < ActiveRecord::Base searchable do id_prefix "USA!IBM!" # ... end end

class Blog < ActiveRecord::Base has_many :posts searchable do id_prefix "BLOGDATA!" # ... end end class Post < ActiveRecord::Base belongs_to :blog searchable do id_prefix "BLOGDATA!" # ... end end

class Blog < ActiveRecord::Base has_many :posts searchable do id_prefix do "BLOGDATA#{self.id}!" end # ... end end class Post < ActiveRecord::Base belongs_to :blog searchable do id_prefix do "BLOGDATA#{self.blog_id}!" end # ... end end

class Post < ActiveRecord::Base searchable do # ... text :body, :stored => true end end

search = Post.search do fulltext "pizza" do highlight :body end end # Will output something similar to: # Post #1 # I really love *pizza* # *Pizza* is my favorite thing # Post #2 # Pepperoni *pizza* is delicious search.hits.each do |hit| puts "Post ##{hit.primary_key}" hit.highlights(:body).each do |highlight| puts " " + highlight.format { |word| "*#{word}*" } end end

search = Post.search do stats :average_rating end puts "Minimum average rating: #{search.stats(:average_rating).min}" puts "Maximum average rating: #{search.stats(:average_rating).max}"

search = Post.search do stats :average_rating, :blog_id end

search = Post.search do stats :average_rating do facet :featured end end search.stats(:average_rating).facet(:featured).rows.each do |row| puts "Minimum average rating for featured=#{row.value}: #{row.min}" end

search = Post.search do stats :average_rating do json_facet :featured end end search.json_facet_stats(:featured).rows.each do |row| puts "Minimum average rating for featured=#{row.value}: #{row.min}" end

search = Sunspot.search(Book) do with(:pub_year).greater_than(1983) # The :on parameter is needed here! # It must match the type specified in :block_join stats :stars, sort: :avg, on: Review do json_facet :author_name, block_join: (on_child(Review) do with :author_name, 'serious_reviewer1967' end) end end

search = Post.search do stats :average_rating do facet :featured end stats :blog_id do facet :average_rating end end

#Posts with pizza, scored higher (square promotion field) if is_promoted Post.search do fulltext 'pizza' do boost(function {sqrt(:promotion)}) { with(:is_promoted, true) } end end

class Post < ActiveRecord::Base searchable do # all fields stored text :body, :stored => true string :title, :stored => true end end post1 = Post.create #... post2 = Post.create #... # atomic update on class level Post.atomic_update post1.id => {title: 'A New Title'}, post2.id => {body: 'A New Body'} # atomic update on instance level post1.atomic_update body: 'A New Body', title: 'Another New Title'

class Post < ActiveRecord::Base searchable do # The :more_like_this option must be set to true text :body, :more_like_this => true end end post = Post.first results = Sunspot.more_like_this(post) do fields :body minimum_term_frequency 5 end

class Post < ActiveRecord::Base searchable do text :title, :boost => 5.0 text :body end end

class Post < ActiveRecord::Base searchable do text :body, :stored => true end end # Retrieving stored contents without hitting the database Post.search.hits.each do |hit| puts hit.stored(:body) end

Post.search do without_stored_fields end

# Using #results pulls in the records from the object-relational # mapper (e.g., ActiveRecord + a SQL server) Post.search.results.each do |result| puts result.body end

# Using #hits gives back all information requested from Solr, but does # not load the object from the object-relational mapper Post.search.hits.each do |hit| puts hit.stored(:body) end

Post.search.each_hit_with_result do |hit, result| # ... end

# On a class itself Person.reindex Sunspot.commit # or commit(true) for a soft commit (Solr4) # On mixed objects Sunspot.index [post1, item2] Sunspot.index person3 Sunspot.commit # or commit(true) for a soft commit (Solr4) # With autocommit Sunspot.index! [post1, item2, person3]

Sunspot.session = Sunspot::SessionProxy::ThreadLocalSessionProxy.new

 session = Sunspot::Rails.build_session Sunspot::Rails::Configuration.new Sunspot.session = session

Post.search do adjust_solr_params do |params| params[:q] += " AND something_s:more" end end