Search API upgrade guide
はじめに
To provide you with more agnostic options for search tooling, we’re adding an abstraction layer to Jira’s search functionality. This change is key to enable future OpenSearch support, and is the start of our plans to remove Lucene from public APIs. Search and indexing performance will remain consistent with the existing Lucene implementation, ensuring a smooth transition.
This page documents Lucene-specific API and components that have been deprecated in favor of the platform-agnostic search API. We’ll add further information as the feature progresses.
必要に応じて、FieldIndexer の移行詳細ページとカスタム フィールド ソートで詳細を確認できます。また、OpenRewrite を使用して検索 API 移行を特定することもできます。
Migrating deprecated code to Search API
Due to the length of some of the strings in the table below, you might not see the full table width. To see more to the right or left, hover your mouse over the table before using it to scroll.
Module | 廃止 | 手順 |
|---|---|---|
jira-api |
| Use
|
jira-api |
| Use com
|
jira-api | com Also deprecated, related searcher SPIs:
| The deprecated class is used for two use cases: sorting, and loading field values from the index. Depending on the use case, replace
Migrate related searcher SPIs to the corresponding replacements:
Remove implementations of |
Lucene |
| 代わりに Use one of the subtypes that corresponds with the legacy FieldComparatorSource:
|
jira-api |
Base classes:
Deprecated indexers are registered into Jira by the following SPI which is also deprecated:
| Implement
Use the following SPI to register new indexers:
|
Lucene |
| To read indexed documents, use To index into a document, use
|
Lucene |
| 代わりに 非推奨の実装では、空のクエリは「一致なし」のクエリになります。新しい検索 API では、空のクエリは「すべてに一致」のクエリになります。空の Lucene クエリを |
jira-api |
| 代わりに |
jira-api |
| Use these following methods that return a
|
jira-api |
| No replacements. These methods are Lucene specific, not relevant on OpenSearch going forward. |
jira-core |
| Use these interfaces instead:
|
Lucene |
| 代わりに |
jira-lucene-dmz |
| 代わりに |
jira-lucene-dmz |
|
Then get |
jira-lucene-dmz |
| No replacement. These methods are Lucene specific, not relevant on OpenSearch going forward. |
jira-lucene-dmz |
| No replacement. These methods are Lucene specific, not relevant on OpenSearch going forward. |
jira-core |
| No replacements. This class is Lucene specific, not relevant on OpenSearch going forward. |
jira-lucene-dmz |
| Use |
jira-lucene-dmz |
| 代わりに |
jira-lucene-dmz |
| This class only supports Lucene index which is deprecated. No replacements to support other search platforms such as OpenSearch. |
Lucene |
| 代わりに This will scan through all the matching documents from the index. We do not recommend this for performing aggregations (e.g. count, sum, etc) because it will perform poorly when running on OpenSearch, since it would result in transferring an unnecessarily large amount of data over the network. We’re currently working on introducing aggregation support on Jira’s search API which utilizes OpenSearch's aggregation API to do this in an efficient manner. This will come in a future version of Jira 10. |
REST API | PUT: | No replacements. This endpoint is Lucene specific, not relevant for the Search API or OpenSearch going forward. |
jira-api | このモジュールは Jira 10.5 で非推奨になりました。
| 非推奨の ソート機能付きのカスタム フィールド サーチャーをすでに使用しているカスタム フィールドでは、追加の変更なしで 同等のカスタム フィールド サーチャーの実装を次に示します。
|
jira-core | このモジュールは Jira 10.5 で非推奨になりました。
| 上記の |