sirius.db.es

Class BulkContext

java.lang.Object

sirius.db.es.BulkContext

All Implemented Interfaces:

Closeable, AutoCloseable

@NotThreadSafe
public class BulkContext
extends Object
implements Closeable

Simplifies bulk inserts, updates and deletes against Elasticsearch.

Permits to execute an arbitrary number of requests. Which will internally executed as blocks using the bulk API of Elasticsearch.

Note that this instance isn't threadsafe.

Note that AfterSave and BaseEntityRef.OnDelete handlers are not executed!

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BulkContext(LowLevelClient client) Creates a new instance using the given client.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the bulk context and executes all statements which are still queued.
boolean	commit() Forces the execution of a bulk update (if statements are queued).
BulkContext	forceDelete(ElasticEntity entity) Queues an BaseMapper.forceDelete(BaseEntity) in the batch context.
Set<String>	getFailedIds() Returns all _id-fields of sub-requests which failed within this bulk request.
String	getFailureMessage() Returns the failure message for this bulk request.
boolean	isEmpty() Returns whether any executable commands are queued.
BulkContext	overwrite(ElasticEntity entity) Queues an BaseMapper.override(BaseEntity) in the batch context.
BulkContext	tryDelete(ElasticEntity entity) Queues an BaseMapper.tryDelete(BaseEntity) in the batch context.
BulkContext	tryUpdate(ElasticEntity entity) Queues an BaseMapper.tryUpdate(BaseEntity) in the batch context.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkContext

protected BulkContext(LowLevelClient client)

Creates a new instance using the given client.

Parameters:

client - the client used to execute the bulk requests

See Also:

Elastic.batch()

Method Detail

tryUpdate

public BulkContext tryUpdate(ElasticEntity entity)

Queues an BaseMapper.tryUpdate(BaseEntity) in the batch context.

Parameters:

entity - the entity to create or update

Returns:

the batch context itself for fluent method calls

overwrite

public BulkContext overwrite(ElasticEntity entity)

Queues an BaseMapper.override(BaseEntity) in the batch context.

Parameters:

entity - the entity to create or update

Returns:

the batch context itself for fluent method calls

tryDelete

public BulkContext tryDelete(ElasticEntity entity)

Queues an BaseMapper.tryDelete(BaseEntity) in the batch context.

Parameters:

entity - the entity to delete

Returns:

the batch context itself for fluent method calls

forceDelete

public BulkContext forceDelete(ElasticEntity entity)

Queues an BaseMapper.forceDelete(BaseEntity) in the batch context.

Parameters:

entity - the entity to delete

Returns:

the batch context itself for fluent method calls

commit

public boolean commit()

Forces the execution of a bulk update (if statements are queued).

Returns:

true if errors occurred, false otherwise

getFailedIds

public Set<String> getFailedIds()

Returns all _id-fields of sub-requests which failed within this bulk request.

Returns:

a Set of _ids for which the bulk request failed.

getFailureMessage

public String getFailureMessage()

Returns the failure message for this bulk request.

Returns:

the failure message if errors occured. Otherwise an empty string.

isEmpty

public boolean isEmpty()

Returns whether any executable commands are queued.

Returns:

true if executable commands are queued, false otherwise.

close

public void close()

Closes the bulk context and executes all statements which are still queued.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable