Package org.hibernate.search.backend.elasticsearch.work.execution.impl

Class ElasticsearchIndexIndexingPlan

java.lang.Object

org.hibernate.search.backend.elasticsearch.work.execution.impl.ElasticsearchIndexIndexingPlan

All Implemented Interfaces:

IndexIndexingPlan

public class ElasticsearchIndexIndexingPlan
extends Object
implements IndexIndexingPlan

Constructor Summary

Constructors

Constructor	Description
ElasticsearchIndexIndexingPlan(ElasticsearchWorkFactory workFactory, ElasticsearchSerialWorkOrchestrator orchestrator, WorkExecutionIndexManagerContext indexManagerContext, BackendSessionContext sessionContext, DocumentRefreshStrategy refreshStrategy)

Method Summary

Modifier and Type	Method	Description
void	add(DocumentReferenceProvider referenceProvider, DocumentContributor documentContributor)	Add a document to the index, assuming that the document is absent from the index.
void	addOrUpdate(DocumentReferenceProvider referenceProvider, DocumentContributor documentContributor)	Update a document in the index, or add it if it's absent from the index.
void	delete(DocumentReferenceProvider referenceProvider)	Delete a document from the index.
void	discard()	Discard all works that are present in this plan.
CompletableFuture<MultiEntityOperationExecutionReport>	executeAndReport(OperationSubmitter operationSubmitter)	Start executing all the works in this plan, and clear the plan so that it can be re-used.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.engine.backend.work.execution.spi.IndexIndexingPlan

execute

Constructor Detail

ElasticsearchIndexIndexingPlan

public ElasticsearchIndexIndexingPlan(ElasticsearchWorkFactory workFactory,
                                      ElasticsearchSerialWorkOrchestrator orchestrator,
                                      WorkExecutionIndexManagerContext indexManagerContext,
                                      BackendSessionContext sessionContext,
                                      DocumentRefreshStrategy refreshStrategy)

Method Detail

add

public void add(DocumentReferenceProvider referenceProvider,
                DocumentContributor documentContributor)

Description copied from interface: IndexIndexingPlan

Add a document to the index, assuming that the document is absent from the index.

Specified by:

add in interface IndexIndexingPlan

Parameters:

referenceProvider - A source of information about the identity of the document to add.

documentContributor - A contributor to the document, adding fields to the indexed document.

addOrUpdate

public void addOrUpdate(DocumentReferenceProvider referenceProvider,
                        DocumentContributor documentContributor)

Description copied from interface: IndexIndexingPlan

Update a document in the index, or add it if it's absent from the index.

Specified by:

addOrUpdate in interface IndexIndexingPlan

Parameters:

referenceProvider - A source of information about the identity of the document to update.

documentContributor - A contributor to the document, adding fields to the indexed document.

delete

public void delete(DocumentReferenceProvider referenceProvider)

Description copied from interface: IndexIndexingPlan

Delete a document from the index.

Specified by:

delete in interface IndexIndexingPlan

Parameters:

referenceProvider - A source of information about the identity of the document to delete.

executeAndReport

public CompletableFuture<MultiEntityOperationExecutionReport> executeAndReport(OperationSubmitter operationSubmitter)

Description copied from interface: IndexIndexingPlan

Start executing all the works in this plan, and clear the plan so that it can be re-used.

Specified by:

executeAndReport in interface IndexIndexingPlan

Parameters:

operationSubmitter - How to handle request to submit operation when the queue is full

Returns:

A CompletableFuture that will hold an execution report when all the works are complete. The future will be completed normally even if a work failed, but the report will contain an exception.

discard

public void discard()

Description copied from interface: IndexIndexingPlan

Discard all works that are present in this plan.

Specified by:

discard in interface IndexIndexingPlan