汎用 Lucene インデックスの削除 generic-lucene-index-removal

アドビでは、Adobe Experience Manager as a Cloud Service から「汎用 Lucene」インデックス（/oak:index/lucene-*）を削除する予定です。このインデックスは AEM 6.5 以降で非推奨（廃止予定）となりました。このドキュメントでは、この決定の影響と、AEM インスタンスが影響を受けるかどうかを調べる方法の詳細について説明します。また、汎用の Lucene インデックスなしでもクエリが引き続き機能するようにクエリを変更する方法についても触れます。

背景 background

AEM では、フルテキストクエリは次の関数を使用します。

このようなクエリでは、インデックスを使用せずに結果を返すことはできません。パスまたはプロパティの制限のみを含んだクエリとは異なり、インデックスが見つからない（したがってトラバーサルが実行される）フルテキスト制限を含んだクエリは、常にゼロの結果を返します。

汎用の Lucene インデックス（/oak:index/lucene-*）は、ほとんどのリポジトリ階層に対するフルテキスト検索機能を提供するために AEM 6.0／Oak 1.0 以降からありましたが、/jcr:system や /var など、一部のパスは常にこの階層から除外されてきました。ただし、このインデックスは、より具体的なノードタイプのインデックス（例：dam:Asset ノードタイプの damAssetLucene-*）にほとんど置き換わっており、後継のインデックスでは、フルテキスト検索とプロパティ検索の両方をサポートしています。

AEM 6.5 で汎用 Lucene インデックスは非推奨（廃止予定）としてマークされ、今後のバージョンで削除されることが明示されました。それ以降は、次のログスニペットで示すように、このインデックスが使用された場合に、警告が記録されてきました。

org.apache.jackrabbit.oak.plugins.index.lucene.LucenePropertyIndex This index is deprecated: /oak:index/lucene-2; it is used for query Filter(query=select [jcr:path], [jcr:score], * from [nt:base] as a where contains(*, 'search term') and isdescendantnode(a, '/content/mysite') /* xpath: /jcr:root/content/mysite//*[jcr:contains(.,"search term")] */ fullText="search" "term", path=/content/mysite//*). Change the query or the index definitions.

最近の AEM バージョンでは、ごく少数の機能をサポートするために汎用 Lucene インデックスが使用されてきました。これらは、他のインデックスを使用するように修正されつつあるか、このインデックスへの依存をなくすために変更されつつあります。

例えば、次の例にあるような参照ルックアップクエリでは、/oak:index/pathreference でインデックスを使用するようになりました。これは、JCR パスを探す正規表現に一致する String プロパティ値に対してのみインデックスを作成します。

//*[jcr:contains(., '"/content/dam/mysite"')]

アドビは、大規模な顧客データボリュームをサポートするために、新しい AEM as a Cloud Service 環境での汎用 Lucene インデックスの作成を終了します。さらに、既存のリポジトリからインデックスを削除します。詳しくは、このドキュメントの末尾で示されているタイムラインを参照してください。

アドビでは、costPerEntry および costPerExecution プロパティを使用してインデックスコストを既に調整しており、/oak:index/pathreference などの他のインデックスが可能な限り環境設定で使用されるようにしています。

このインデックスにまだ依存しているクエリを使用する顧客アプリケーションは、他の既存のインデックスを利用するように直ちに更新してください。既存のインデックスは、必要に応じてカスタマイズできます。または、新しいカスタムインデックスを顧客アプリケーションに追加できます。AEM as a Cloud Service でのインデックス管理の詳しい手順については、インデックス作成に関するドキュメントを参照してください。

影響を受けるユーザー are-you-affected

汎用 Lucene インデックスは、現在、他のフルテキストインデックスでクエリに対応できない場合のフォールバックとして使用されています。この非推奨のインデックスを使用すると、次のようなメッセージが WARN レベルで記録されます。

org.apache.jackrabbit.oak.plugins.index.lucene.LucenePropertyIndex This index is deprecated: /oak:index/lucene-2; it is used for query Filter(query=select [jcr:path], [jcr:score], * from [nt:base] as a where contains(*, 'test') /* xpath: //*[jcr:contains(.,"test")] */ fullText="test", path=*). Change the query or the index definitions.

状況によっては、Oak が別のフルテキストインデックス（/oak:index/pathreference など）を使用してフルテキストクエリをサポートしようとする可能性がありますが、クエリ文字列がインデックス定義の正規表現と一致しない場合は、メッセージが WARN レベルで記録され、クエリは結果を返さない可能性があります。

org.apache.jackrabbit.oak.query.QueryImpl Potentially improper use of index /oak:index/pathReference with queryFilterRegex (["']|^)/ to search for value "test"

汎用 Lucene インデックスが削除されると、フルテキストクエリで適切なインデックス定義が見つからない場合、次に示すようなメッセージが WARN レベルで記録されます。

org.apache.jackrabbit.oak.query.QueryImpl Fulltext query without index for filter Filter(query=select [jcr:path], [jcr:score], * from [nt:base] as a where contains(*, 'test') /* xpath: //*[jcr:contains(.,"test")] */ fullText="test", path=*); no results are returned

汎用 Lucene インデックスに対する可能性のある依存関係 potential-dependencies

アプリケーションや AEM インストールが、オーサーインスタンスであってもパブリッシュインスタンスであっても、汎用 Lucene インデックスに依存する可能性がある領域はいくつかあります。

パブリッシュインスタンス publish-instance

カスタムアプリケーションクエリ custom-application-queries

パブリッシュインスタンスで汎用 Lucene インデックスを使用するクエリの最も一般的なソースは、カスタムアプリケーションクエリです。

最も簡単なケースは、例えば、クエリにノードタイプの指定がないので nt:base が暗示される場合や、nt:base が明示的に指定される場合です。

/jcr:root/content/mysite//*[jcr:contains(., 'search term')]
/jcr:root/content/mysite//element(*, nt:base)[jcr:contains(., 'search term')]

例えば、cq:Page node 下のページや任意の集計に一致する結果を返すように、クエリを変更することができます。この場合、クエリは次のようになります。

/jcr:root/content/mysite//element(*, cq:Page)[jcr:contains(., 'search term')]

他には、クエリにノードタイプが指定されているものの、別のフルテキストインデックスでは処理できないフルテキスト制限が含まれている場合もあります。例えば、次のような場合です。

/jcr:root/content/dam//element(*, dam:Asset)[jcr:contains(jcr:content/metadata/@cq:tags, 'NewsTopics:cateogries/domestic'))]

この場合、クエリはノードタイプが dam:Asset ですが、関連する jcr:content/metadata/@cq:tags プロパティに対するフルテキスト制限を含んでいます。

このプロパティは、damAssetLucene インデックスで分析済みとしてマークされていません。このインデックスは、dam:Asset ノードタイプに対するクエリで最も一般的に使用されるフルテキストインデックスです。したがって、このインデックスはこのクエリには使用できません。

その結果、クエリは汎用のフルテキストインデックスにフォールバックし、含まれているすべてのプロパティが、/oak:index/lucene-2/indexRules/nt:base/properties/prop のワイルドカード一致によって分析済みとしてマークされます。

オーサーインスタンス author-instance

顧客アプリケーションサーブレット、OSGi コンポーネントおよびレンダリングスクリプトでのクエリに加えて、汎用 Lucene インデックスには作成者固有のいくつかの用途が考えられます。

参照検索 reference-search

従来、汎用 Lucene インデックスは、参照検索つまり別のコンテンツパスへの参照を含んだコンテンツの検索をサポートするために使用されてきました。このようなクエリは、新しい /oak:index/pathreference インデックスを使用するように既に更新されています。

パスフィールドピッカー検索 picker-search

AEM には、granite/ui/components/coral/foundation/form/pathfield の Sling リソースタイプを持つカスタムダイアログコンポーネントが含まれています。これは、別の AEM パスを選択するためのブラウザー／ピッカーとなります。デフォルトのパスフィールドピッカーは、カスタムの pickerSrc プロパティがコンテンツ構造で定義されていない場合に使用されるもので、ポップアップダイアログボックスに検索バーをレンダリングします。

検索対象となるノードタイプは、nodeTypes プロパティを使用して指定できます。

現在のところ、nodeTypes プロパティが存在しない場合、基になる検索クエリでは nt:base ノードタイプを使用するので、汎用 Lucene インデックスが使用される可能性が高く、通常は、次のような WARN メッセージがログに記録されます。

20.01.2022 18:56:06.412 *WARN* [127.0.0.1 [1642704966377] POST /mnt/overlay/granite/ui/content/coral/foundation/form/pathfield/picker.result.single.html HTTP/1.1] org.apache.jackrabbit.oak.plugins.index.lucene.LucenePropertyIndex This index is deprecated: /oak:index/lucene-2; it is used for query Filter(query=select [jcr:path], [jcr:score], * from [nt:base] as a where contains(*, 'test') and isdescendantnode(a, '/content') /* xpath: /jcr:root/content//element(*, nt:base)[(jcr:contains(., 'test'))] order by @jcr:score descending */ fullText="test", path=/content//*). Change the query or the index definitions.

汎用 Lucene インデックスが削除される前に、デフォルトのピッカーを使用しているコンポーネントに検索ボックスが表示されないように pathfield コンポーネントが更新されます。このようなコンポーネントは nodeTypes プロパティを提供しません。

検索機能を持つパスフィールドピッカー

検索機能を持たないパスフィールドピッカー

汎用 Lucene インデックスの削除のタイムライン timeline

アドビでは、2 段階アプローチで汎用 Lucene インデックスを削除します。

アドビでは前述のログメッセージを監視し、汎用 Lucene インデックスをまだ利用しているお客様への連絡を試みます。

短期的な緩和策として、アドビでは、必要に応じて、カスタムインデックス定義を直接お客様のシステムに追加して、汎用 Lucene インデックスの削除に起因する機能の問題やパフォーマンスの問題を防止します。

このような場合、お客様には、更新されたインデックス定義が提供され、Cloud Manager を使用してアプリケーションの今後のリリースにそれを組み込むように助言されます。