io.jmix.search.index.queue

Interface IndexingQueueManager

All Known Implementing Classes:

JpaIndexingQueueManager

public interface IndexingQueueManager

Provides functionality for enqueuing entity instances and processing queue.

Method Summary

Modifier and Type	Method and Description
int	emptyQueue() Removes all queue items.
int	emptyQueue(java.lang.String entityName) Removes all queue items related to provided entity.
int	enqueueDelete(java.lang.Object entityInstance) Sends provided entity instance to indexing queue in order to delete it from index.
int	enqueueDeleteByEntityId(io.jmix.core.Id<?> entityId) Sends entity instance to indexing queue by provided ID in order to delete it from index.
int	enqueueDeleteCollection(java.util.Collection<java.lang.Object> entityInstances) Sends provided entity instances to indexing queue in order to delete them from index.
int	enqueueDeleteCollectionByEntityIds(java.util.Collection<io.jmix.core.Id<?>> entityIds) Sends entity instances to indexing queue by provided IDs in order to delete them from index.
int	enqueueIndex(java.lang.Object entityInstance) Sends provided entity instance to indexing queue in order to store it to index.
int	enqueueIndexAll() Sends all instances of all index-configured entities to indexing queue.
int	enqueueIndexAll(java.lang.String entityName) Sends all instances of provided entity to indexing queue.
int	enqueueIndexByEntityId(io.jmix.core.Id<?> entityId) Sends entity instance to indexing queue by provided ID in order to store it to index.
int	enqueueIndexCollection(java.util.Collection<java.lang.Object> entityInstances) Sends provided entity instances to indexing queue in order to store them to index.
int	enqueueIndexCollectionByEntityIds(java.util.Collection<io.jmix.core.Id<?>> entityIds) Sends entity instances to indexing queue by provided IDs in order to store them to index.
int	processEntireQueue() Retrieves items from indexing queue and processes them - store/remove related documents in index.
int	processNextBatch() Retrieves next batch of items from indexing queue and processes them - store/remove related documents in index.
int	processNextBatch(int batchSize) Retrieves next batch of items from indexing queue and processes them - store/remove related documents in index.

Method Detail

emptyQueue

int emptyQueue()

Removes all queue items.

Returns:

amount of deleted items

emptyQueue

int emptyQueue(java.lang.String entityName)

Removes all queue items related to provided entity.

Parameters:

entityName - entity

Returns:

amount of deleted items

enqueueIndex

int enqueueIndex(java.lang.Object entityInstance)

Sends provided entity instance to indexing queue in order to store it to index.

Parameters:

entityInstance - instance

Returns:

amount of enqueued instances

enqueueIndexCollection

int enqueueIndexCollection(java.util.Collection<java.lang.Object> entityInstances)

Sends provided entity instances to indexing queue in order to store them to index.

Parameters:

entityInstances - instances

Returns:

amount of enqueued instances

enqueueIndexByEntityId

int enqueueIndexByEntityId(io.jmix.core.Id<?> entityId)

Sends entity instance to indexing queue by provided ID in order to store it to index.

Parameters:

entityId - ID of entity instance

Returns:

amount of enqueued instances

enqueueIndexCollectionByEntityIds

int enqueueIndexCollectionByEntityIds(java.util.Collection<io.jmix.core.Id<?>> entityIds)

Sends entity instances to indexing queue by provided IDs in order to store them to index.

Parameters:

entityIds - IDs of entity instances

Returns:

amount of enqueued instances

enqueueIndexAll

int enqueueIndexAll()

Sends all instances of all index-configured entities to indexing queue.

Returns:

amount of enqueued instances

enqueueIndexAll

int enqueueIndexAll(java.lang.String entityName)

Sends all instances of provided entity to indexing queue.

Parameters:

entityName - entity name

Returns:

amount of enqueued instances

enqueueDelete

int enqueueDelete(java.lang.Object entityInstance)

Sends provided entity instance to indexing queue in order to delete it from index.

Parameters:

entityInstance - instance

Returns:

amount of enqueued instances

enqueueDeleteCollection

int enqueueDeleteCollection(java.util.Collection<java.lang.Object> entityInstances)

Sends provided entity instances to indexing queue in order to delete them from index.

Parameters:

entityInstances - instances

Returns:

amount of enqueued instances

enqueueDeleteByEntityId

int enqueueDeleteByEntityId(io.jmix.core.Id<?> entityId)

Sends entity instance to indexing queue by provided ID in order to delete it from index.

Parameters:

entityId - ID of entity instance

Returns:

amount of enqueued instances

enqueueDeleteCollectionByEntityIds

int enqueueDeleteCollectionByEntityIds(java.util.Collection<io.jmix.core.Id<?>> entityIds)

Sends entity instances to indexing queue by provided IDs in order to delete them from index.

Parameters:

entityIds - IDs of entity instances

Returns:

amount of enqueued instances

processNextBatch

int processNextBatch()

Retrieves next batch of items from indexing queue and processes them - store/remove related documents in index.

Returns:

amount of processed queue items

processNextBatch

int processNextBatch(int batchSize)

Retrieves next batch of items from indexing queue and processes them - store/remove related documents in index.

Parameters:

batchSize - amount of queue items to process

Returns:

amount of processed queue items

processEntireQueue

int processEntireQueue()

Retrieves items from indexing queue and processes them - store/remove related documents in index.

Returns:

amount of processed queue items