Package com.atlassian.jira.search.index

Interface IndexWriter

All Known Implementing Classes:

OpenSearchIndexWriter

@Internal
public interface IndexWriter

Implementations provide access to the search index to create, update and delete documents. It's only supported for OpenSearch.

Since:

10.4

Method Summary

Modifier and Type	Method	Description
void	delete(DeleteRequest deleteRequest)	Deletes a document based on the provided DeleteRequest.
void	deleteBulk(Set<DeleteRequest> deleteRequests)	Delete a bulk of documents based on the provided Set of DeleteRequest objects.
void	deleteByQuery(DeleteByQueryRequest deleteByQueryRequest)	Delete documents satisfying the given DeleteByQueryRequest filter.
void	put(IndexRequest indexRequest)	Creates or updates a document for the provided identifier and fields in the IndexRequest Document.
void	updateBulk(UpdateBulkRequest request)	Update a bulk of documents based on the UpdateBulkRequest.

Method Details

delete

void delete(DeleteRequest deleteRequest)
     throws IndexOperationException

Deletes a document based on the provided DeleteRequest.

Parameters:

deleteRequest - the delete request

Throws:

IndexOperationException - if the operation has failed

deleteBulk

void deleteBulk(Set<DeleteRequest> deleteRequests)
         throws BulkIndexOperationsException

Delete a bulk of documents based on the provided Set of DeleteRequest objects.

Parameters:

deleteRequests - the delete requests

Throws:

BulkIndexOperationsException - if one or more requested operations have failed

deleteByQuery

void deleteByQuery(DeleteByQueryRequest deleteByQueryRequest)
            throws IndexOperationException

Delete documents satisfying the given DeleteByQueryRequest filter.

Parameters:

deleteByQueryRequest - the delete by query request

Throws:

IndexOperationException - if the operation has failed

put

void put(IndexRequest indexRequest)
  throws IndexOperationException

Creates or updates a document for the provided identifier and fields in the IndexRequest Document. If a document with the same ID exists then it performs an update, otherwise it will create a new document.

Parameters:

indexRequest - the index request

Throws:

IndexOperationException - if the operation has failed

updateBulk

void updateBulk(UpdateBulkRequest request)
         throws BulkIndexOperationsException

Update a bulk of documents based on the UpdateBulkRequest.

Parameters:

request - contains documents to be updated

Throws:

BulkIndexOperationsException - if one or more requested operations have failed