com.datastax.oss.dsbulk.executor.api

Interface BulkExecutorBuilder<T extends BulkExecutor>

All Known Implementing Classes:

AbstractBulkExecutorBuilder, ContinuousReactorBulkExecutorBuilder, DefaultReactorBulkExecutorBuilder

public interface BulkExecutorBuilder<T extends BulkExecutor>

A builder for BulkExecutor instances.

Method Summary

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

Method Detail

failSafe

BulkExecutorBuilder<T> failSafe()

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.

Returns:

this builder (for method chaining).

withMaxInFlightRequests

BulkExecutorBuilder<T> withMaxInFlightRequests(int maxInFlightRequests)

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.

Parameters:

maxInFlightRequests - the maximum number of in-flight requests.

Returns:

this builder (for method chaining).

withMaxRequestsPerSecond

BulkExecutorBuilder<T> withMaxRequestsPerSecond(int maxRequestsPerSecond)

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.

Parameters:

maxRequestsPerSecond - the maximum number of concurrent requests per second.

Returns:

this builder (for method chaining).

withExecutionListener

BulkExecutorBuilder<T> withExecutionListener(ExecutionListener listener)

Sets an optional ExecutionListener.

Parameters:

listener - the ExecutionListener to use.

Returns:

this builder (for method chaining).

build

T build()

Builds a new instance.

Returns:

the newly-created instance.