com.arakelian.elastic.bulk

Class BulkIndexer

java.lang.Object

com.arakelian.elastic.bulk.BulkIndexer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class BulkIndexer
extends java.lang.Object
implements java.io.Closeable

Indexes or deletes a group of documents from one or more Elastic indexes using the Elastic Bulk Index API.

Constructor Summary

Constructors

Constructor and Description
BulkIndexer(BulkIndexerConfig config, RefreshLimiter refreshLimiter)

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.util.concurrent.Future<java.lang.Boolean>>	add(BulkOperation op, boolean forceFlush) Adds a bulk operation to the pending batch, and returns a ListenableFuture that represents that bulk update (or null if a batch operation is not available yet).
void	close() Called during shutdown to terminate the scheduled executor thread.
void	delete(java.util.Collection<?> documents) Deletes a list of documents from their respective Elastic indexes.
void	delete(java.lang.Object document) Delete specified document from Elastic index.
com.google.common.util.concurrent.ListenableFuture<BulkResponse>	flush() Flushes any pending bulk operations to Elastic asynchronously, and returns a future that corresponds to the batch (or null if no batch operation is required).
BulkIndexerConfig	getConfig()
RefreshLimiter	getRefreshLimiter()
BulkIndexerStats	getStats()
void	index(java.util.Collection<?> documents) Adds a list of documents to the Elastic index without immediate index refresh and optional flush.
void	index(java.lang.Object document) Adds a document to the Elastic index.
boolean	isClosed() Returns true if indexer has closed
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkIndexer

public BulkIndexer(BulkIndexerConfig config,
                   RefreshLimiter refreshLimiter)

Method Detail

add

public java.util.Optional<java.util.concurrent.Future<java.lang.Boolean>> add(BulkOperation op,
                                                                              boolean forceFlush)
                                                                       throws java.util.concurrent.RejectedExecutionException

Adds a bulk operation to the pending batch, and returns a ListenableFuture that represents that bulk update (or null if a batch operation is not available yet).

Parameters:

op - bulk operation

forceFlush - true if flush operation should be forced, even if batch is not full

Returns:

a Future that represents the batch, or null if batch is not flushed

Throws:

java.util.concurrent.RejectedExecutionException - if indexer is closed or background queue is full

close

public void close()
           throws BulkIndexerFailed

Called during shutdown to terminate the scheduled executor thread.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

BulkIndexerFailed - if exception occurs while closing indexer

delete

public void delete(java.util.Collection<?> documents)
            throws java.util.concurrent.RejectedExecutionException,
                   java.io.IOException

Deletes a list of documents from their respective Elastic indexes.

Parameters:

documents - list of documents to be removed

Throws:

java.util.concurrent.RejectedExecutionException - if indexer is closed or background queue is full

java.io.IOException - if document could not be serialized

delete

public void delete(java.lang.Object document)
            throws java.util.concurrent.RejectedExecutionException,
                   java.io.IOException

Delete specified document from Elastic index.

Parameters:

document - document to be deleted

Throws:

java.util.concurrent.RejectedExecutionException - if indexer is closed or background queue is full

java.io.IOException - if document could not be serialized

flush

public com.google.common.util.concurrent.ListenableFuture<BulkResponse> flush()
                                                                       throws java.util.concurrent.RejectedExecutionException

Flushes any pending bulk operations to Elastic asynchronously, and returns a future that corresponds to the batch (or null if no batch operation is required).

Returns:

returns a future that corresponds to the batch, or null if no batch operation required

Throws:

java.util.concurrent.RejectedExecutionException - if indexer is closed (and we have pending operations) or background queue is full

getConfig

public final BulkIndexerConfig getConfig()

getRefreshLimiter

public RefreshLimiter getRefreshLimiter()

getStats

public BulkIndexerStats getStats()

index

public void index(java.util.Collection<?> documents)
           throws java.util.concurrent.RejectedExecutionException,
                  java.io.IOException

Adds a list of documents to the Elastic index without immediate index refresh and optional flush.

Parameters:

documents - list of documents to index

Throws:

java.util.concurrent.RejectedExecutionException - if indexer is closed or background queue is full

java.io.IOException - if document could not be serialized

index

public void index(java.lang.Object document)
           throws java.util.concurrent.RejectedExecutionException,
                  java.io.IOException

Adds a document to the Elastic index.

Parameters:

document - document to be indexed

Throws:

java.util.concurrent.RejectedExecutionException - if indexer is closed or background queue is full

java.io.IOException - if document could not be serialized

isClosed

public boolean isClosed()

Returns true if indexer has closed

Returns:

true if indexer has closed

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object