Welcome to the Apache Solr Wiki

General Information

• Solr Website

• Download latest Solr Release

• Introduction to Solr

• Solr Tutorial

• SOLR mailing lists: Sign-up or Search/Browse the Mailing List Archives

  • Please read these tips on using the mailing lists effectively before posting.

• The Solr FAQ and the Solr Relevancy FAQ

• SolrResources - Books, Blogs, Reviews, Articles, Product Sheet, Presentations, etc...

• SolrTerminology

• Powered by Solr

• SolrPerformanceData

• Support - People and companies for hire

• Solr Change Log with all the juicy info about recently committed features.

Solr Development

• HackingSolr -- Info for people interested in hacking and customizing the Solr application

• TestingSolr -- Information for running Solr unit tests

• NightlyBuilds -- Jenkins (formerly Hudson) hosts nightly Solr builds

• Latest stable code for 3.x branch (svn URL).

• TaskList of ideas for future development

• HowToContribute improvements

• Info For Committers

• TestPlans

• SolrPluginRepository

• NewSolrCloudDesign

• HowToCompileSolr -- steps tested under Windows 7 / Windows 8

Using Solr

Installation and Configuration

• General Installation Steps

  • Includes information about useful settings in specific environments

• SolrLogging

• ConfiguringSolr

  • SolrConfigXml

  • SchemaXml

  • AnalyzersTokenizersTokenFilters

  • SolrAndHTTPCaches

  • CoreAdmin (i.e. MultiCore)

• SolrAdminGUI

Search and Indexing

• Indexing Documents

  • Adding Documents in XML format - Covers XML syntax for adds, deletes, commits and optimizes

  • Adding Documents in JSON format - Covers JSON syntax for adds, deletes, commits and optimizes

  • Adding Documents in CSV format

  • DataImportHandler - Solr contrib that supports full and delta indexing directly from SQL databases, and local or REST accessible XML files.

  • AnalysisRequestHandler - Analyzing documents without indexing

  • Solr Content Extraction Library (Solr Cell) - Covers how to index MS Word, PDF, etc. using Solr Cell (a.k.a. ExtractingRequestHandler). Also see the older version at UpdateRichDocuments

  • Update Processors - Update Processors define how an update request is processed.

    • Deduplication - prevent or tag duplicate documents

  • LanguageDetection - Identify the language of documents and mark them.

• Searching Solr

  • Request Handlers - Control the logic used to process requests. Several different Request Handlers are included with Solr, or you can write your own custom implementation.

  • Response Writers - Control the formating of the responses generated by Request Handlers. Several different Response Writers are included with Solr, or you can write your own custom implementation.

  • Input Parameters

    • QueryParametersIndex - index of query parameters in following wiki pages

    • CoreQueryParameters

    • CommonQueryParameters

    • SimpleFacetParameters

    • HighlightingParameters

    • MoreLikeThis

  • Search Components - Search Components provide core functionality to a Request Handler.

  • Query Syntax - syntax for default query parsing, and how to specify a Query Parser.

  • Function Queries - Using the values in fields in functions and as factors in scoring

  • Faceted search - Category counts for search results

  • (Geo)Spatial Search - Find results near a point

  • Field Collapsing / Result Grouping - documents with a common field value are grouped

  • Join - Do joins (similar to database) on documents

Tips, Tricks and Use Cases

• FilterQueryGuidance - How do I partition my query in main query and filter query in order to have Solr's caching work efficiently?

• SolrPlugins

• SolrRelevancyCookbook

• NearRealtimeSearch

• Auto-complete - use either Faceting with facet.prefix or Suggester or TermsComponent

• UniqueKey - Covers tips about unique keys in the schema

• Japanese Language Support - How to search Japanese text, best practices and various considerations

• Using PreAnalyzedField type for integration with external document processing pipelines

Solr Clients

• IntegratingSolr - includes information about accessing Solr from a variety of programming languages and existing third party applications.

Operations and Production

• SolrCaching

• SolrPerformanceFactors

• SolrSecurity

• Index Replication

• Built in SolrRequestHandler based SolrReplication

• Unix script based CollectionDistribution

• DistributedSearch

• CollectionRebuilding

• MergingSolrIndexes

• SolrOperationsTools

• SolrJmx and SolrMonitoring

User-contributed content

• Translations - Unofficial translations of the official documentation, in hope of easing the review process.

• :TODO: How to implement basic indexing in Tomcat

How to edit this Wiki

This Wiki is a collaborative site, anyone can contribute and share:

• Create an account by clicking the "Login" link at the top of any page, and picking a username and password.

• Edit any page by pressing Edit at the top or the bottom of the page

There are some conventions used on the Solr wiki:

• :TODO: (/!\ :TODO: /!\ ) is used to denote sections that definitely need to be cleaned up.

• Solr4.0 (<!> [[Solr4.0]]) is used to draw attention to which version of Solr a feature was (or will be) added to Solr.

Some general info on using this Wiki Software:

• Create a link to another page with joined capitalized words (like WikiSandBox) or with ["quoted words in brackets"]

• See HelpForBeginners to get you going, HelpContents for all help pages.

• HelpOnMoinWikiSyntax: quick access to wiki syntax