暗黙的なリクエストハンドラ

Solr には、多くのすぐに使えるリクエストハンドラが付属しています。これらは、使用前に `solrconfig.xml` で構成する必要がないため、暗黙的なリクエストハンドラと呼ばれます。

これらのハンドラには、 *paramsets* と呼ばれる事前に定義されたデフォルトパラメータがあり、必要に応じて変更できます。

使用可能な暗黙的なエンドポイント

以下にリストされているすべてのエンドポイントパスは、Solr のホストとポート(ポートを使用する場合)の後に配置して URL を構築する必要があります。

管理ハンドラ

これらのハンドラの多くは、管理 UI 全体で 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 インデックスを公開します。このハンドラでは、エンドポイントへのパスにコレクション名を含める必要があります。

**ドキュメント**: Luke リクエストハンドラ

API エンドポイント クラスとJavadocs Paramset

solr/<collection>/admin/luke

LukeRequestHandler

_ADMIN_LUKE

MBeans

登録されているすべての SolrInfoMBeans に関する情報を提供します。このハンドラでは、エンドポイントへのパスにコレクション名を含める必要があります。

**ドキュメント**: MBean リクエストハンドラ

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

セグメント

最後のコミット世代の 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/system` または `solr/<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

設定用ハンドラ

Config API

Solrの設定を取得および変更します。

ドキュメント: 設定API

API エンドポイント クラスとJavadocs Paramset

v1: solr/<collection>/config

v2: api/collections/<collection>/config

SolrConfigHandler

_CONFIG

ダンプ

リクエストの内容をクライアントに返します。

API エンドポイント クラスとJavadocs Paramset

solr/debug/dump

DumpRequestHandler

_DEBUG_DUMP

レプリケーション

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

クエリハンドラ

エクスポート

完全なソート済み結果セットをエクスポートします。

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クエリをサポートします。

ドキュメント: SQLリクエストハンドラ

API エンドポイント クラスとJavadocs Paramset

solr/<collection>/sql

SQLHandler

_SQL

ストリーミング式

分散ストリーム処理。

API エンドポイント クラスとJavadocs Paramset

solr/<collection>/stream

StreamHandler

_STREAM

ターム

フィールドのインデックス済みタームと、各タームを含むドキュメント数を返します。

API エンドポイント クラスとJavadocs Paramset

solr/<collection>/terms

SearchHandler

_TERMS

更新ハンドラ

更新

SolrXML、CSV、SolrJSON、またはjavabin形式でフォーマットされたインデックス済みドキュメントを追加、削除、および更新します。

API エンドポイント クラスとJavadocs Paramset

solr/<collection>/update

UpdateRequestHandler

_UPDATE

CSV更新

CSV形式のドキュメントを追加および更新します。

ドキュメント: CSV更新の簡易パス

API エンドポイント クラスとJavadocs Paramset

solr/<collection>/update/csv

UpdateRequestHandler

_UPDATE_CSV

JSON更新

SolrJSON形式のドキュメントを追加、削除、および更新します。

ドキュメント: JSON更新の簡易パス

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

https://127.0.0.1:8983/solr/gettingstarted/config/requestHandler?componentName=/export&expandParams=true

V2 API

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には存在しないため、関連付けられたdefaultinvariantappendsパラメータの設定は、上記の表にリストされているパラメータセットを使用してリクエストパラメータAPIを介して編集できます。ただし、SearchHandlerコンポーネントを含む他のパラメータは変更できません。暗黙的な設定で指定された不変要素と追加要素は上書きできません。