Home

Sunspot Wiki

Because of the DSL-heavy nature of Sunspot and the heavy use of inheritance in its architecture, the API Docs aren't always the most efficient way to learn about Sunspot's functionality. Thus, here is the wiki, which aims to cover Sunspot usage in a clear, topical way. Feel free to contribute!

If you're new to Sunspot and using it with Rails, start with Adding Sunspot search to Rails in 5 minutes or less.

Installation and configuration

Setting up classes for search and indexing

Working with search

Fulltext search

Scoping by attribute fields

Ordering and pagination

Drilling down with facets

Dynamic fields

Advanced Fulltext Search Configuration

Building queries by hand

Working with adapters

Configuring Solr for use with Sunspot in development, testing, and production

Indexing rich text documents (Solr Cell)

Matching substrings in fulltext search

Wildcard searching with NGrams

Sunspot addons (3rd party libraries that extend Sunspot and Sunspot::Rails)

How to setup solr and sunspot on a rails production server

Searching for special characters with Sunspot, Solr and Tomcat

Upgrading sunspot_solr Solr Instance

Working with Solr 4

Dealing with partial results