Solr ships with many out-of-the-box RequestHandlers, which are called implicit because they are not configured in solrconfig.xml
.
These handlers have pre-defined default parameters, known as paramsets, which can be modified if necessary.
List of Implicitly Available Endpoints
Endpoint | Request Handler class | Paramset | Description |
---|---|---|---|
|
|
Returns content of files in |
|
|
|
Retrieve/modify registered loggers. |
|
|
Expose the internal lucene index. |
||
|
Provide info about all registered SolrInfoMBeans. |
||
|
Health check. |
||
|
N/A |
Return info about all registered plugins. |
|
|
|
Return JRE system properties. |
|
|
|
Return info on last commit generation Lucene index segments. |
|
|
Return server statistics and settings |
||
|
Return info on all JVM threads. |
||
|
Return a breakdown of the analysis process of the given document. |
||
|
|
Return index- and query-time analysis over the given field(s)/field type(s). |
|
|
Retrieve/modify Solr configuration. |
||
|
|
Echo the request contents back to the client. |
|
|
Export full sorted result sets. |
||
|
Real-time get: low-latency retrieval of the latest version of a document. |
||
|
Return GraphML formatted output from a |
||
|
Replicate indexes for SolrCloud recovery and Master/Slave index distribution. |
||
|
Retrieve/modify Solr schema. |
||
|
Front end of the Parallel SQL interface. |
||
|
Distributed stream processing. |
||
|
Return a field’s indexed terms and the number of documents containing each term. |
||
|
Add, delete and update indexed documents formatted as SolrXML, CSV, SolrJSON or javabin. |
||
|
Add and update CSV-formatted documents. |
||
|
Add, delete and update SolrJSON-formatted documents. |
||
|
Add and update custom JSON-formatted documents. |
How to View the Configuration
You can see configuration for all request handlers, including the implicit request handlers, via the Config API. For the gettingstarted
collection:
curl http://localhost:8983/solr/gettingstarted/config/requestHandler
To restrict the results to the configuration for a particular request handler, use the componentName
request parameter. To see just the configuration for the /export
request handler:
curl "http://localhost:8983/solr/gettingstarted/config/requestHandler?componentName=/export"
To include the expanded paramset in the response, as well as the effective parameters from merging the paramset parameters with the built-in parameters, use the expandParams
request param. For the /export
request handler, you can make a request like this:
curl "http://localhost:8983/solr/gettingstarted/config/requestHandler?componentName=/export&expandParams=true"
How to Edit the Configuration
Because implicit request handlers are not present in solrconfig.xml
, configuration of their associated default
, invariant
and appends
parameters may be edited via Request Parameters API using the paramset listed in the above table. However, other parameters, including SearchHandler components, may not be modified. The invariants and appends specified in the implicit configuration cannot be overridden.
We welcome feedback on Solr documentation. However, we cannot provide application support via comments. If you need help, please send a message to the Solr User mailing list.