關於本指南

本指南說明 Apache Solr 的所有重要功能和特性。

Solr 可從 https://solr.dev.org.tw/ 免費下載。

本指南旨在提供高階文件,其目的在於更像百科全書而非食譜。它的結構旨在滿足廣泛的需求,從剛入門的新開發人員到擴充其應用程式或進行疑難排解的經驗豐富的開發人員。無論您何時需要關於 Solr 的權威資訊,它都可以在應用程式生命週期的任何階段使用。

呈現的資料假設您熟悉一些基本的搜尋概念,並且可以閱讀 XML。它不假設您是 Java 程式設計師,儘管在直接使用 Lucene 或開發 Solr 安裝的自訂擴充功能時,了解 Java 會很有幫助。

主機和連接埠範例

執行 Solr 時的預設連接埠為 8983。本指南中的範例、URL 和螢幕擷取畫面可能會顯示不同的連接埠,因為 Solr 使用的連接埠號碼是可設定的。

如果您尚未自訂 Solr 的安裝,請確保在遵循範例時使用連接埠 8983,或設定您自己的安裝以使用範例中顯示的連接埠號碼。

同樣地,URL 範例在整個過程中都使用 localhost;如果您要從遠端連線到託管 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.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 來實現此目的。

特殊的內文註解

這些頁面中包含特殊的註解。註解有多種類型:

資訊區塊提供您應該了解的額外資訊。
重要區塊提供我們希望您注意的重要資訊。
提示區塊提供有用的提示。
注意區塊提供您應謹慎處理的情境或設定的詳細資訊。
警告區塊用於警告您可能會有危險的變更或動作。