com.datastax.oss.dsbulk.executor.api

Class AbstractBulkExecutorBuilder<T extends BulkExecutor>

java.lang.Object

com.datastax.oss.dsbulk.executor.api.AbstractBulkExecutorBuilder<T>

All Implemented Interfaces:

BulkExecutorBuilder<T>

Direct Known Subclasses:

ContinuousReactorBulkExecutorBuilder, DefaultReactorBulkExecutorBuilder

public abstract class AbstractBulkExecutorBuilder<T extends BulkExecutor>
extends Object
implements BulkExecutorBuilder<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	failFast
protected ExecutionListener	listener
protected int	maxInFlightRequests
protected int	maxRequestsPerSecond
protected CqlSession	session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBulkExecutorBuilder(CqlSession session)

Method Summary

Modifier and Type	Method and Description
AbstractBulkExecutorBuilder<T>	failSafe() Switches on fail-safe mode.
AbstractBulkExecutorBuilder<T>	withExecutionListener(ExecutionListener listener) Sets an optional ExecutionListener.
AbstractBulkExecutorBuilder<T>	withMaxInFlightRequests(int maxInFlightRequests) Sets the maximum number of in-flight requests.
AbstractBulkExecutorBuilder<T>	withMaxRequestsPerSecond(int maxRequestsPerSecond) Sets the maximum number of concurrent requests per second.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.datastax.oss.dsbulk.executor.api.BulkExecutorBuilder

build

Field Detail

session

protected final CqlSession session

failFast

protected boolean failFast

maxInFlightRequests

protected int maxInFlightRequests

maxRequestsPerSecond

protected int maxRequestsPerSecond

listener

protected ExecutionListener listener

Constructor Detail

AbstractBulkExecutorBuilder

protected AbstractBulkExecutorBuilder(CqlSession session)

Method Detail

failSafe

public AbstractBulkExecutorBuilder<T> failSafe()

Description copied from interface: BulkExecutorBuilder

Switches on fail-safe mode.

By default, executors are created in fail-fast mode, i.e. any execution error stops the whole operation. In fail-fast mode, the error is wrapped within a BulkExecutionException that conveys the failed Statement. With synchronous operations, the exception is thrown directly; with asynchronous ones, the returned future is completed exceptionally. Important: in fail-fast mode, if a statement execution fails, all pending requests are abandoned; there is no guarantee that all previously submitted statements will complete before the executor stops.

In fail-safe mode, the error is converted into a WriteResult or ReadResult and passed on to consumers, along with the failed Statement; then the execution resumes at the next statement. The Result interface exposes two useful methods when operating in fail-safe mode:

1. Result.isSuccess() tells if the statement was executed successfully.
2. Result.getError() can be used to retrieve the error.

Specified by:

failSafe in interface BulkExecutorBuilder<T extends BulkExecutor>

Returns:

this builder (for method chaining).

withMaxInFlightRequests

public AbstractBulkExecutorBuilder<T> withMaxInFlightRequests(int maxInFlightRequests)

Description copied from interface: BulkExecutorBuilder

Sets the maximum number of in-flight requests. In other words, sets the maximum number of concurrent uncompleted requests waiting for a response from the server. If that limit is reached, the executor will block until the number of in-flight requests drops below the threshold. This feature should not be used in a fully non-blocking application.

This acts as a safeguard against workflows that generate more requests than they can handle. The default is AbstractBulkExecutor.DEFAULT_MAX_IN_FLIGHT_REQUESTS. Setting this option to any negative value will disable it.

Specified by:

withMaxInFlightRequests in interface BulkExecutorBuilder<T extends BulkExecutor>

Parameters:

maxInFlightRequests - the maximum number of in-flight requests.

Returns:

this builder (for method chaining).

withMaxRequestsPerSecond

public AbstractBulkExecutorBuilder<T> withMaxRequestsPerSecond(int maxRequestsPerSecond)

Description copied from interface: BulkExecutorBuilder

Sets the maximum number of concurrent requests per second. If that limit is reached, the executor will block until the number of requests per second drops below the threshold. This feature should not be used in a fully non-blocking application.

This acts as a safeguard against workflows that could overwhelm the cluster with more requests than it can handle. The default is AbstractBulkExecutor.DEFAULT_MAX_REQUESTS_PER_SECOND. Setting this option to any negative value will disable it.

Specified by:

withMaxRequestsPerSecond in interface BulkExecutorBuilder<T extends BulkExecutor>

Parameters:

maxRequestsPerSecond - the maximum number of concurrent requests per second.

Returns:

this builder (for method chaining).

withExecutionListener

public AbstractBulkExecutorBuilder<T> withExecutionListener(ExecutionListener listener)

Description copied from interface: BulkExecutorBuilder

Sets an optional ExecutionListener.

Specified by:

withExecutionListener in interface BulkExecutorBuilder<T extends BulkExecutor>

Parameters:

listener - the ExecutionListener to use.

Returns:

this builder (for method chaining).