隐式请求处理程序

Solr 附带许多开箱即用的请求处理程序，这些处理程序被称为隐式处理程序，因为在使用它们之前无需在 solrconfig.xml 中对其进行配置。

这些处理程序具有预定义的默认参数，称为参数集，必要时可以对其进行修改。

可用的隐式端点

下面列出的所有端点路径都应放在 Solr 的主机和端口（如果使用端口）之后以构建 URL。

管理处理程序

许多此类处理程序在整个管理 UI 中用于显示有关 Solr 的信息。

文件

返回 ${solr.home}/conf/ 中的文件内容。此处理程序的端点路径中必须有集合名称。

API 端点类和 Javadoc 参数集

solr/<collection>/admin/file

ShowFileRequestHandler

_ADMIN_FILE

运行状况

报告节点的运行状况（仅在 SolrCloud 模式下可用）

API 端点类和 Javadoc 参数集

v1: solr/admin/info/health

v2: api/node/health

HealthCheckHandler

此端点还接受其他请求参数。有关详细信息，请参阅 Javadoc。

日志记录

检索和修改已注册的记录器。

API 端点类和 Javadoc 参数集

v1: solr/admin/info/logging

v2: api/node/logging

LoggingHandler

_ADMIN_LOGGING

Luke

公开内部 Lucene 索引。此处理程序的端点路径中必须有集合名称。

文档：Luke 请求处理程序

API 端点类和 Javadoc 参数集

solr/<collection>/admin/luke

LukeRequestHandler

_ADMIN_LUKE

MBean

提供有关所有已注册 SolrInfoMBean 的信息。此处理程序的端点路径中必须有集合名称。

文档：MBean 请求处理程序

API 端点类和 Javadoc 参数集

solr/<collection>/admin/mbeans

SolrInfoMBeanHandler

_ADMIN_MBEANS

Ping

运行状况检查。此处理程序的端点路径中必须有集合名称。

文档：Ping

API 端点类和 Javadoc 参数集

solr/<collection>/admin/ping

PingRequestHandler

_ADMIN_PING

插件

返回有关所有已注册插件的信息。此处理程序的端点路径中必须有集合名称。

API 端点类和 Javadoc 参数集

solr/<collection>/admin/plugins

PluginInfoHandler

无。

系统属性

返回 JRE 系统属性。

API 端点类和 Javadoc 参数集

v1: solr/admin/info/properties

v2: api/node/properties

PropertiesRequestHandler

_ADMIN_PROPERTIES

段

返回上一次提交生成 Lucene 索引段的信息。

API 端点类和 Javadoc 参数集

solr/<collection>/admin/segments

SegmentsInfoRequestHandler

_ADMIN_SEGMENTS

系统信息

返回服务器统计信息和设置。

文档：系统信息处理程序

API 端点类和 Javadoc 参数集

v1: solr/admin/info/system

v2: api/node/system

SystemInfoHandler

_ADMIN_SYSTEM

此端点还可以在路径中采用集合或核心名称（solr/<collection>/admin/system 或 solr/<core>/admin/system），其中将包括所有系统级信息以及处理请求的特定核心有关的其他信息。

线程

返回有关所有 JVM 线程的信息。

API 端点类和 Javadoc 参数集

v1: solr/admin/info/threads

v2: api/node/threads

ThreadDumpHandler

_ADMIN_THREADS

分析处理程序

文档分析

返回给定文档的分析过程的细分。

文档：https://cwiki.apache.org/confluence/display/solr/AnalysisRequestHandler

API 端点类和 Javadoc 参数集

solr/<collection>/analysis/document

DocumentAnalysisRequestHandler

_ANALYSIS_DOCUMENT

字段分析

返回对给定字段/字段类型进行索引和查询时分析的结果。此处理程序驱动 Solr 管理 UI 中的分析屏幕。

API 端点类和 Javadoc 参数集

solr/<collection>/analysis/field

FieldAnalysisRequestHandler

_ANALYSIS_FIELD

用于配置的处理程序

Config API

检索和修改 Solr 配置。

文档：配置 API

API 端点类和 Javadoc 参数集

v1: solr/<collection>/config

v2: api/collections/<collection>/config

SolrConfigHandler

_CONFIG

转储

将请求内容回显到客户端。

API 端点类和 Javadoc 参数集

solr/debug/dump

DumpRequestHandler

_DEBUG_DUMP

复制

复制索引以进行 SolrCloud 恢复和用户管理的集群索引分发。此处理程序的端点路径中必须有核心名称。

API 端点类和 Javadoc 参数集

solr/<core>/replication

ReplicationHandler

_REPLICATION

模式 API

检索和修改 Solr 架构。

文档：架构 API

API 端点类和 Javadoc 参数集

v1: solr/<collection>/schema, solr/<core>/schema

v2: api/collections/<collection>/schema, api/cores/<core>/schema

SchemaHandler

_SCHEMA

查询处理程序

导出

导出完全排序的结果集。

文档: 导出结果集

API 端点类和 Javadoc 参数集

solr/<collection>/export

ExportHandler

_EXPORT

实时获取

低延迟检索文档的最新版本。

文档: 实时获取

API 端点类和 Javadoc 参数集

solr/<collection>/get

RealTimeGetHandler

_GET

图遍历

返回 GraphML 格式化输出，来自 gatherNodes 流式表达式。

文档: 图遍历

API 端点类和 Javadoc 参数集

solr/<collection>/graph

GraphHandler

_ADMIN_GRAPH

SQL

SQL 查询支持。

文档: SQL 请求处理程序

API 端点类和 Javadoc 参数集

solr/<collection>/sql

SQLHandler

_SQL

流表达式

分布式流处理。

文档: 流请求和响应

API 端点类和 Javadoc 参数集

solr/<collection>/stream

StreamHandler

_STREAM

术语

返回字段的索引术语和包含每个术语的文档数。

文档: 在请求处理程序中使用术语组件

API 端点类和 Javadoc 参数集

solr/<collection>/terms

SearchHandler

_TERMS

更新处理程序

更新

添加、删除和更新以 SolrXML、CSV、SolrJSON 或 javabin 格式编写的索引文档。

文档: 使用更新处理程序进行索引

API 端点类和 Javadoc 参数集

solr/<collection>/update

UpdateRequestHandler

_UPDATE

CSV 更新

添加和更新 CSV 格式的文档。

文档: CSV 更新便捷路径

API 端点类和 Javadoc 参数集

solr/<collection>/update/csv

UpdateRequestHandler

_UPDATE_CSV

JSON 更新

添加、删除和更新 SolrJSON 格式的文档。

文档: JSON 更新便捷路径

API 端点类和 Javadoc 参数集

solr/<collection>/update/json

UpdateRequestHandler

_UPDATE_JSON

自定义 JSON 更新

添加和更新自定义 JSON 格式的文档。

文档: 转换和索引自定义 JSON

API 端点类和 Javadoc 参数集

solr/<collection>/update/json/docs

UpdateRequestHandler

_UPDATE_JSON_DOCS

如何查看隐式处理程序参数集

你可以通过配置 API 查看所有请求处理程序的配置，包括隐式请求处理程序。

要将扩展的参数集包含在响应中，以及将参数集参数与内置参数合并后的有效参数，请使用 expandParams 请求参数。

例如，对于 /export 请求处理程序，你可以发出这样的请求

V1 API

http://localhost:8983/solr/gettingstarted/config/requestHandler?componentName=/export&expandParams=true

V2 API

http://localhost:8983/api/collections/gettingstarted/config/requestHandler?componentName=/export&expandParams=true

响应将类似于

{
  "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}"
        }
      }
    }
  }
}

如何编辑隐式处理程序参数集

由于隐式请求处理程序不存在于 solrconfig.xml 中，因此可以通过使用上表中列出的参数集通过请求参数 API 来编辑其关联的 default、invariant 和 appends 参数的配置。但是，包括 SearchHandler 组件在内的其他参数可能无法修改。隐式配置中指定的 invariants 和 appends 无法被覆盖。