隐式请求处理程序

Solr 附带许多开箱即用的请求处理程序,这些处理程序被称为隐式处理程序,因为您无需在 solrconfig.xml 中配置它们即可使用它们。

这些处理程序具有预定义的默认参数,称为 paramsets,如果需要,可以修改这些参数。

可用的隐式端点

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

管理处理程序

其中许多处理程序在整个管理界面中使用,以显示有关 Solr 的信息。

文件

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

API 端点 类 & Javadocs Paramset

solr/<collection>/admin/file

ShowFileRequestHandler

_ADMIN_FILE

健康

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

API 端点 类 & Javadocs Paramset

v1: solr/admin/info/health

v2: api/node/health

HealthCheckHandler

此端点还接受其他请求参数。有关详细信息,请参见 Javadocs

日志

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

API 端点 类 & Javadocs Paramset

v1: solr/admin/info/logging

v2: api/node/logging

LoggingHandler

_ADMIN_LOGGING

Luke

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

API 端点 类 & Javadocs Paramset

solr/<collection>/admin/luke

LukeRequestHandler

_ADMIN_LUKE

MBeans

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

API 端点 类 & Javadocs Paramset

solr/<collection>/admin/mbeans

SolrInfoMBeanHandler

_ADMIN_MBEANS

Ping

健康检查。此处理程序的端点路径中必须包含集合名称。

文档Ping

API 端点 类 & Javadocs Paramset

solr/<collection>/admin/ping

PingRequestHandler

_ADMIN_PING

插件

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

API 端点 类 & Javadocs Paramset

solr/<collection>/admin/plugins

PluginInfoHandler

无。

系统属性

返回 JRE 系统属性。

API 端点 类 & Javadocs Paramset

v1: solr/admin/info/properties

v2: api/node/properties

PropertiesRequestHandler

_ADMIN_PROPERTIES

段 (Segments)

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

API 端点 类 & Javadocs Paramset

solr/<collection>/admin/segments

SegmentsInfoRequestHandler

_ADMIN_SEGMENTS

系统信息

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

API 端点 类 & Javadocs Paramset

v1: solr/admin/info/system

v2: api/node/system

SystemInfoHandler

_ADMIN_SYSTEM

此端点还可以在路径中包含集合或核心名称(solr/<collection>/admin/systemsolr/<core>/admin/system),这将包括所有系统级信息以及有关服务于该请求的特定核心的其他信息。

线程

返回所有 JVM 线程的信息。

API 端点 类 & Javadocs Paramset

v1: solr/admin/info/threads

v2: api/node/threads

ThreadDumpHandler

_ADMIN_THREADS

分析处理器

文档分析

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

API 端点 类 & Javadocs Paramset

solr/<collection>/analysis/document

DocumentAnalysisRequestHandler

_ANALYSIS_DOCUMENT

字段分析

返回给定字段/字段类型上的索引和查询时分析。此处理器驱动 Solr 管理 UI 中的 分析屏幕

API 端点 类 & Javadocs Paramset

solr/<collection>/analysis/field

FieldAnalysisRequestHandler

_ANALYSIS_FIELD

配置处理器

配置 API

检索和修改 Solr 配置。

文档: 配置 API

API 端点 类 & Javadocs Paramset

v1: solr/<collection>/config

v2: api/collections/<collection>/config

SolrConfigHandler

_CONFIG

转储 (Dump)

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

API 端点 类 & Javadocs Paramset

solr/debug/dump

DumpRequestHandler

_DEBUG_DUMP

复制 (Replication)

为 SolrCloud 恢复和用户管理的集群索引分发复制索引。此处理器必须在端点的路径中包含核心名称。

API 端点 类 & Javadocs Paramset

solr/<core>/replication

ReplicationHandler

_REPLICATION

模式 API

检索和修改 Solr 模式。

文档: 模式 API

API 端点 类 & Javadocs Paramset

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

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

SchemaHandler

_SCHEMA

查询处理器

导出 (Export)

导出完整排序的结果集。

文档: 导出结果集

API 端点 类 & Javadocs Paramset

solr/<collection>/export

ExportHandler

_EXPORT

实时获取 (RealTimeGet)

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

文档: 实时获取

API 端点 类 & Javadocs Paramset

solr/<collection>/get

RealTimeGetHandler

_GET

图遍历

gatherNodes 流式表达式返回 GraphML 格式的输出。

文档: 图遍历

API 端点 类 & Javadocs Paramset

solr/<collection>/graph

GraphHandler

_ADMIN_GRAPH

SQL

SQL 查询支持。

API 端点 类 & Javadocs Paramset

solr/<collection>/sql

SQLHandler

_SQL

流式表达式

分布式流处理。

API 端点 类 & Javadocs Paramset

solr/<collection>/stream

StreamHandler

_STREAM

词项 (Terms)

返回字段的索引词项以及包含每个词项的文档数。

API 端点 类 & Javadocs Paramset

solr/<collection>/terms

SearchHandler

_TERMS

更新处理器

更新 (Update)

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

API 端点 类 & Javadocs Paramset

solr/<collection>/update

UpdateRequestHandler

_UPDATE

CSV 更新

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

API 端点 类 & Javadocs Paramset

solr/<collection>/update/csv

UpdateRequestHandler

_UPDATE_CSV

JSON 更新

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

API 端点 类 & Javadocs Paramset

solr/<collection>/update/json

UpdateRequestHandler

_UPDATE_JSON

自定义 JSON 更新

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

API 端点 类 & Javadocs Paramset

solr/<collection>/update/json/docs

UpdateRequestHandler

_UPDATE_JSON_DOCS

如何查看隐式处理器参数集

您可以通过 配置 API 查看所有请求处理器的配置,包括隐式请求处理器。

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

例如,对于 /export 请求处理器,您可以发出如下请求

  • V1 API

  • V2 API

https://127.0.0.1:8983/solr/gettingstarted/config/requestHandler?componentName=/export&expandParams=true
https://127.0.0.1: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 使用上表中列出的参数集编辑其关联的 defaultinvariantappends 参数的配置。但是,其他参数(包括 SearchHandler 组件)可能无法修改。隐式配置中指定的 invariants 和 appends 不能被覆盖。