Welcome to sunburnt’s documentation!

Sunburnt is a library to help Python programs interact with the Apache Solr search engine.

Support

For initial help with problems see our mailing list. Please file any bugs in the github issue tracker.

Contents:

• About Sunburnt
• Installing Sunburnt
  • Using pip
  • Using a downloaded release
  • Using git
• Installing and configuring Solr
• Reading a Solr Schema
• Configuring a connection
  • HTTP caching
  • Schema migrations
• Querying Solr
  • Searching your solr instance
  • Executing queries and interpreting the response
  • Pagination
  • Returning different fields
  • More complex queries
  • Sorting results
  • Excluding results from queries
  • Optional terms and combining queries
  • Wildcard searching
  • Filter queries and caching
  • Query boosting
  • Faceting
  • Highlighting
  • More Like This
  • Spatial fields
  • Binary fields
  • UUID fields
• More Like This queries
  • Basic MLT query
  • Further MLT query options
  • Sourcing content from the web
  • MLT queries on indexed content
  • Chaining MLT queries
• Adding documents
• Deleting documents
• Managing your index
  • Committing changes
  • Optimizing
  • Rollback
• Contributing to Sunburnt
• Documentation
• Tests
  • Checking internal state
  • Mocking out external dependencies