MultithreadedBatch (pdb 2.8.18 API)

java.lang.Object
- com.feedzai.commons.sql.abstraction.batch.AbstractPdbBatch
- - com.feedzai.commons.sql.abstraction.batch.impl.MultithreadedBatch

All Implemented Interfaces:

PdbBatch, AutoCloseable
```
public class MultithreadedBatch
extends AbstractPdbBatch
implements PdbBatch
```
A Batch that periodically flushes pending insertions to the database using multiple threads/connections.

Author:

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected BatchListener`	`batchListener` The listener for customized behavior when this batch succeeds or fails to persist data.
`protected int`	`batchSize` The batch size.
`protected long`	`batchTimeoutMs` The batch timeout in milliseconds.
`protected BlockingQueue<BatchEntry>`	`buffer` A buffer of `batch entries`.
`protected long`	`flushRetryDelayMs` The time interval in milliseconds to wait between batch flush retries.
`protected long`	`lastFlush` Timestamp of the last flush.
`protected int`	`maxFlushRetries` The number of times to retry a batch flush upon failure.
`protected String`	`name` The name of the batch.

Constructor Summary

Constructors
Constructor and Description

MultithreadedBatch(DatabaseEngine dbEngine, MultithreadedBatchConfig batchConfig)
Creates a new instance of MultithreadedBatch.

Constructors
Constructor and Description
`MultithreadedBatch(DatabaseEngine dbEngine, MultithreadedBatchConfig batchConfig)` Creates a new instance of `MultithreadedBatch`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(BatchEntry batchEntry)` Adds the entry to the batch.
`void`	`close()` Closes this 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 `PdbBatch.flush()` and return the future when done.

Methods inherited from class com.feedzai.commons.sql.abstraction.batch.AbstractPdbBatch
add, processBatch

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.feedzai.commons.sql.abstraction.batch.PdbBatch
add

- Field Detail
  - batchSize
```
protected final int batchSize
```
    The batch size.
  - batchTimeoutMs
```
protected final long batchTimeoutMs
```
    The batch timeout in milliseconds.
  - lastFlush
```
protected volatile long lastFlush
```
    Timestamp of the last flush.
  - buffer
```
protected BlockingQueue<BatchEntry> buffer
```
    A buffer of batch entries.
  - name
```
protected String name
```
    The name of the batch.
  - batchListener
```
protected final BatchListener batchListener
```
    The listener for customized behavior when this batch succeeds or fails to persist data.
  - maxFlushRetries
```
protected final int maxFlushRetries
```
    The number of times to retry a batch flush upon failure.
  - flushRetryDelayMs
```
protected final long flushRetryDelayMs
```
    The time interval in milliseconds to wait between batch flush retries.
- Constructor Detail
  - MultithreadedBatch
```
@Inject
public MultithreadedBatch(DatabaseEngine dbEngine,
                                  MultithreadedBatchConfig batchConfig)
```
    Creates a new instance of MultithreadedBatch.
    
    Parameters:
    
    dbEngine - The database engine.
    
    batchConfig - The batch configuration.
    
    Implementation Note:
    
    The internal timer task for periodic flushes is started.
- Method Detail
  - close
```
public void close()
```
    Closes this batch.
    
    Specified by:
    
    close in interface AutoCloseable
  - add
```
public void add(BatchEntry batchEntry)
         throws InterruptedException
```
    Description copied from interface: PdbBatch
    
    Adds the entry to the batch.
    
    Specified by:
    
    add in interface PdbBatch
    
    Parameters:
    
    batchEntry - The batch entry.
    
    Throws:
    
    InterruptedException
  - flush
```
public void flush()
           throws ExecutionException,
                  InterruptedException
```
    Description copied from interface: PdbBatch
    
    Flushes the pending batches.
    
    Specified by:
    
    flush in interface PdbBatch
    
    Throws:
    
    ExecutionException
    
    InterruptedException
  - flushAsync
```
public CompletableFuture<Void> flushAsync()
```
    Description copied from interface: PdbBatch
    
    Flushes the pending batches asynchronously, if the implementation allows it; otherwise, by default, this should simply call PdbBatch.flush() and return the future when done.
    
    Specified by:
    
    flushAsync in interface PdbBatch
    
    Overrides:
    
    flushAsync in class AbstractPdbBatch
    
    Returns:
    
    A void CompletableFuture that completes when the flush action finishes.

Class MultithreadedBatch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.feedzai.commons.sql.abstraction.batch.AbstractPdbBatch

Methods inherited from class java.lang.Object

Methods inherited from interface com.feedzai.commons.sql.abstraction.batch.PdbBatch

Field Detail

batchSize

batchTimeoutMs

lastFlush

buffer

name

batchListener

maxFlushRetries

flushRetryDelayMs

Constructor Detail

MultithreadedBatch

Method Detail

close

add

flush

flushAsync