Package com.atlassian.confluence.plugins.opensearch.indexmanager

Class OpenSearchIndexPerformanceTuner

java.lang.Object

com.atlassian.confluence.plugins.opensearch.indexmanager.OpenSearchIndexPerformanceTuner

@ParametersAreNonnullByDefault
public class OpenSearchIndexPerformanceTuner
extends Object

Tunes OpenSearch index performance for a specific context, following recommendations from https://opensearch.org/docs/latest/search-plugins/knn/performance-tuning

Since:

9.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpenSearchIndexPerformanceTuner.Restorable	Provides the ability to restore index settings to the original state

Constructor Summary

Constructors

Constructor	Description
OpenSearchIndexPerformanceTuner(org.opensearch.client.opensearch.OpenSearchClient client)

Method Summary

Modifier and Type	Method	Description
OpenSearchIndexPerformanceTuner.Restorable	tuneForReindexing(String index)	Tune the specified index to improve performance when indexing a large number of documents, using settings recommended in https://opensearch.org/docs/latest/search-plugins/knn/performance-tuning#indexing-performance-tuning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenSearchIndexPerformanceTuner

public OpenSearchIndexPerformanceTuner(org.opensearch.client.opensearch.OpenSearchClient client)

Method Details

tuneForReindexing

public OpenSearchIndexPerformanceTuner.Restorable tuneForReindexing(String index)
                                                             throws IOException

Tune the specified index to improve performance when indexing a large number of documents, using settings recommended in https://opensearch.org/docs/latest/search-plugins/knn/performance-tuning#indexing-performance-tuning

Parameters:

index -

Returns:

a OpenSearchIndexPerformanceTuner.Restorable for restoring index to its original settings

Throws:

IOException