Package com.atlassian.confluence.search.v2

Interface SearchIndexWriter

All Known Implementing Classes:

OpenSearchBulkIndexWriter

public interface SearchIndexWriter

A mean to write to or remove a document from a search index.

Since:

7.16

Method Summary

Modifier and Type	Method	Description
void	add(AtlassianDocument document)
void	delete(SearchQuery searchQuery)
void	deleteAll()
void	postOptimize()
void	preOptimize()
void	update(String documentId, AtlassianDocument document)	Applies partial updates to the document with the given id.

Method Details

add

void add(AtlassianDocument document)
  throws IOException

Throws:

IOException

delete

void delete(SearchQuery searchQuery)
     throws IOException

Throws:

IOException

deleteAll

void deleteAll()
        throws IOException

Throws:

IOException

preOptimize

void preOptimize()
          throws IOException

Throws:

IOException

postOptimize

void postOptimize()
           throws IOException

Throws:

IOException

update

void update(String documentId,
 AtlassianDocument document)
     throws IOException

Applies partial updates to the document with the given id. The updates applied are the fields specified in the document passed as an argument. OpenSearch Only. DO NOT USE for Lucene.

Parameters:

documentId - ID of the existing document to be updated

document - The partial update to be applied to the existing document

Throws:

IOException

Since:

9.2.5