com.feedzai.commons.sql.abstraction.batch

Interface PdbBatch

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractBatch, AbstractPdbBatch, DefaultBatch, DefaultBatch, MultithreadedBatch

public interface PdbBatch
extends AutoCloseable

Interface specifying a batch that periodically flushes pending insertions to the database.

Author:

José Fidalgo (jose.fidalgo@feedzai.com)

Implementation Requirements:

Implementations are expected to have a constructor annotated with Inject, so that instances can be generated from config using Guice injection.

Method Summary

Modifier and Type	Method and Description
void	add(BatchEntry batchEntry) Adds the entry to the batch.
void	add(String entityName, EntityEntry ee) Adds the entry to the batch.
void	flush() Flushes the pending batches.
CompletableFuture<Void>	flushAsync() Flushes the pending batches asynchronously, if the implementation allows it; otherwise, by default, this should simply call flush() and return the future when done.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

add

void add(String entityName,
         EntityEntry ee)
  throws Exception

Adds the entry to the batch.

Parameters:

entityName - The table name.

ee - The entity entry.

Throws:

Exception - If an error occurs while adding to the batch.

add

void add(BatchEntry batchEntry)
  throws Exception

Adds the entry to the batch.

Parameters:

batchEntry - The batch entry.

Throws:

Exception - If an error occurs while adding to the batch.

flush

void flush()
    throws Exception

Flushes the pending batches.

Throws:

Exception - If an error occurs while flushing.

flushAsync

CompletableFuture<Void> flushAsync()
                            throws Exception

Flushes the pending batches asynchronously, if the implementation allows it; otherwise, by default, this should simply call flush() and return the future when done.

Returns:

A void CompletableFuture that completes when the flush action finishes.

Throws:

Exception