关于本指南

本指南描述了 Apache Solr 的所有重要特性和功能。

Solr 可以从 https://solr.apache.org/ 免费下载。

本指南旨在提供高层次的文档,更侧重于百科全书式的介绍,而非菜谱式的指导。其结构旨在满足广泛的需求,从刚入门的新开发人员到扩展其应用程序或进行故障排除的经验丰富的开发人员。在应用程序生命周期的任何阶段,当您需要有关 Solr 的权威信息时,它都将非常有用。

所呈现的材料假设您熟悉一些基本的搜索概念,并且可以阅读 XML。它并不假设您是 Java 程序员,尽管在直接使用 Lucene 或开发 Solr 安装的自定义扩展时,了解 Java 会很有帮助。

主机和端口示例

运行 Solr 时的默认端口是 8983。本指南中的示例、URL 和屏幕截图可能会显示不同的端口,因为 Solr 使用的端口号是可配置的。

如果您没有自定义 Solr 的安装,请确保在遵循示例时使用端口 8983,或者配置您自己的安装以使用示例中显示的端口号。

同样,URL 示例通篇使用 localhost;如果您是从 Solr 托管服务器的远程位置访问 Solr,请将 localhost 替换为 Solr 运行的正确域名或 IP。

例如,我们可能会提供一个像这样的示例查询

https://127.0.0.1:8983/solr/gettingstarted/select?q=brown+cow

此 URL 中有几个项目您可能需要在本地进行更改。首先,如果您的服务器在“www.example.com”上运行,则需要将“localhost”替换为正确的域名。如果您没有使用端口 8983,您也需要替换它。最后,您需要将“gettingstarted”(集合或核心名称)替换为您的实现中正在使用的正确名称。然后,URL 将变为

http://www.example.com/solr/mycollection/select?q=brown+cow

目录路径

路径信息是相对于 solr.home 给出的,它是主 Solr 安装下存储 Solr 集合及其 confdata 目录的位置。

在许多情况下,这位于安装的 server/solr 目录中。但是,可能会有例外,特别是如果您的安装对此进行了自定义。

在本指南的几个例子中,我们的示例是基于“techproducts”示例构建的(即,您已使用命令 bin/solr start -e techproducts 启动 Solr)。在这种情况下,solr.home 将是为您自动创建的 example/ 目录的子目录。

有关此目录中包含的内容的更多详细信息,另请参阅 Solr 主目录 部分。

API 示例

Solr 目前存在两种样式的 API。第一个是在 Solr 随着时间推移而发展时有些有机地增长起来的,而第二个(称为“V2 API”)使用现代化的、自文档化的 API 接口重新设计了许多原始 API。

在许多情况下(但并非所有情况),两种风格的 API 调用的参数和输出是相同的。但在所有情况下,所使用的路径和端点都是不同的。

在本指南中,我们添加了两种风格的示例,分别标记为“V1 API”和“V2 API”。截至本指南 7.2 版本,这些示例尚未完成 - 随着未来版本指南的发布,将添加更多内容。

v2 API 部分提供了更多关于如何使用新 API 结构的信息,包括如果您选择禁用它的方法。

所有 API 都会返回一个响应头,其中包含请求的状态和处理时间。某些 API 还会包含用于请求的参数。本指南中的许多示例都省略了此标头信息,您可以通过在任何请求中添加参数 omitHeader=true 在本地执行此操作。

特殊的内联注释

这些页面中包含特殊的注释。注释有几种类型:

信息块提供您需要了解的额外信息。
重要块提供我们希望您注意的信息。
提示块提供有用的提示。
注意块提供您应该谨慎对待的场景或配置的详细信息。
警告块用于警告您可能危险的更改或操作。