Implicit Request Handlers
Solr ships with many out-of-the-box request handlers, which are called implicit because they do not need to be configured in solrconfig.xml before you are able to use them.
These handlers have pre-defined default parameters, known as paramsets, which can be modified if necessary.
Available Implicit Endpoints
| All endpoint paths listed below should be placed after Solr’s host and port (if a port is used) to construct a URL. |
Admin Handlers
Many of these handlers are used throughout the Admin UI to show information about Solr.
| File |
Return content of files in
|
||||||
| Health |
Report the health of the node (available only in SolrCloud mode)
This endpoint also accepts additional request parameters. Please see Javadocs for details. |
||||||
| Logging |
Retrieve and modify registered loggers.
|
||||||
| Luke |
Expose the internal Lucene index. This handler must have a collection name in the path to the endpoint. Documentation: Luke Request Handler
|
||||||
| MBeans |
Provide info about all registered SolrInfoMBeans. This handler must have a collection name in the path to the endpoint. Documentation: MBean Request Handler
|
||||||
| Ping |
Health check. This handler must have a collection name in the path to the endpoint. Documentation: Ping
|
||||||
| Plugins |
Return info about all registered plugins. This handler must have a collection name in the path to the endpoint.
|
||||||
| System Properties |
Return JRE system properties.
|
||||||
| Segments |
Return info on last commit generation Lucene index segments.
|
||||||
| System Info |
Return server statistics and settings. Documentation: System Info Handler
This endpoint can also take the collection or core name in the path ( |
||||||
| Threads |
Return info on all JVM threads.
|
Analysis Handlers
| Document Analysis |
Return a breakdown of the analysis process of the given document.
|
||||||
| Field Analysis |
Return index- and query-time analysis over the given field(s)/field type(s). This handler drives the Analysis Screen in Solr’s Admin UI.
|
Handlers for Configuration
| Config API |
Retrieve and modify Solr configuration. Documentation: Config API
|
||||||
| Dump |
Echo the request contents back to the client.
|
||||||
| Replication |
Replicate indexes for SolrCloud recovery and user-managed cluster index distribution. This handler must have a core name in the path to the endpoint.
|
||||||
| Schema API |
Retrieve and modify the Solr schema. Documentation: Schema API
|
Query Handlers
| Export |
Export full sorted result sets. Documentation: Exporting Result Sets
|
||||||
| RealTimeGet |
Low-latency retrieval of the latest version of a document. Documentation: RealTime Get
|
||||||
| Graph Traversal |
Return GraphML formatted output from a Documentation: Graph Traversal
|
||||||
| SQL |
SQL query support. Documentation: SQL Request Handler
|
||||||
| Streaming Expressions |
Distributed stream processing. Documentation: Streaming Requests and Responses
|
||||||
| Terms |
Return a field’s indexed terms and the number of documents containing each term. Documentation: Using the Terms Component in a Request Handler
|
Update Handlers
| Update |
Add, delete and update indexed documents formatted as SolrXML, CSV, SolrJSON or javabin. Documentation: Indexing with Update Handlers
|
||||||
| CSV Updates |
Add and update CSV-formatted documents. Documentation: CSV Update Convenience Paths
|
||||||
| JSON Updates |
Add, delete and update SolrJSON-formatted documents. Documentation: JSON Update Convenience Paths
|
||||||
| Custom JSON Updates |
Add and update custom JSON-formatted documents. Documentation: Transforming and Indexing Custom JSON
|
How to View Implicit Handler Paramsets
You can see configuration for all request handlers, including the implicit request handlers, via the Config API.
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 parameter.
For example, for the /export request handler, you can make a request like this:
-
V1 API
-
V2 API
http://localhost:8983/solr/gettingstarted/config/requestHandler?componentName=/export&expandParams=truehttp://localhost:8983/api/collections/gettingstarted/config/requestHandler?componentName=/export&expandParams=trueThe response will look similar to:
{
"config": {
"requestHandler": {
"/export": {
"class": "solr.ExportHandler",
"useParams": "_EXPORT",
"components": ["query"],
"defaults": {
"wt": "json"
},
"invariants": {
"rq": "{!xport}",
"distrib": false
},
"name": "/export",
"_useParamsExpanded_": {
"_EXPORT": "[NOT AVAILABLE]"
},
"_effectiveParams_": {
"distrib": "false",
"omitHeader": "true",
"wt": "json",
"rq": "{!xport}"
}
}
}
}
}How to Edit Implicit Handler Paramsets
Because implicit request handlers are not present in solrconfig.xml, configuration of their associated default, invariant and appends parameters may be edited via the 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.