com.marklogic.client.datamovement

Interface Batcher

All Known Subinterfaces:

QueryBatcher, WriteBatcher

public interface Batcher

The base class (shared methods) for QueryBatcher and WriteBatcher.

Method Summary

Modifier and Type	Method and Description
int	getBatchSize()
ForestConfiguration	getForestConfig()
String	getJobName()
JobTicket	getJobTicket() After the job has been started, returns the JobTicket generated when the job was started.
int	getThreadCount()
boolean	isStopped() true if the job is terminated (e.g.
Batcher	withBatchSize(int batchSize) The size of each batch (usually 50-500).
Batcher	withForestConfig(ForestConfiguration forestConfig) Updates the ForestConfiguration used by this job to spread the writes or reads.
Batcher	withJobName(String jobName) Sets the name of the job to help with managing multiple concurrent jobs.
Batcher	withThreadCount(int threadCount) The number of threads to be used internally by this job to perform concurrent tasks on batches (usually > 10).

Method Detail

withJobName

Batcher withJobName(String jobName)

Sets the name of the job to help with managing multiple concurrent jobs.

Parameters:

jobName - the name you would like to assign to this job

Returns:

this instance (for method chaining)

getJobName

String getJobName()

Returns:

the job name

withBatchSize

Batcher withBatchSize(int batchSize)

The size of each batch (usually 50-500). With some experimentation with your custom job, this value can be tuned. Tuning this value is one of the best ways to achieve optimal throughput.

This method cannot be called after the job has started.

Parameters:

batchSize - the batch size – must be 1 or greater

Returns:

this instance (for method chaining)

getBatchSize

int getBatchSize()

Returns:

the batch size

withThreadCount

Batcher withThreadCount(int threadCount)

The number of threads to be used internally by this job to perform concurrent tasks on batches (usually > 10). With some experimentation with your custom job and client environment, this value can be tuned. Tuning this value is one of the best ways to achieve optimal throughput or to throttle the server resources used by this job. Setting this to 1 does not guarantee that batches will be processed sequentially because the calling thread will sometimes also process batches.

This method cannot be called after the job has started.

Returns:

this instance (for method chaining)

getThreadCount

int getThreadCount()

Returns:

the thread count

getForestConfig

ForestConfiguration getForestConfig()

Returns:

the forest configuration in use by this job

withForestConfig

Batcher withForestConfig(ForestConfiguration forestConfig)

Updates the ForestConfiguration used by this job to spread the writes or reads. This can be called mid-job in order to accommodate for node failures or other changes without requiring a restart of this job. Ideally, this ForestConfiguration will come from DataMovementManager.readForestConfig(), perhaps wrapped by something like FilteredForestConfiguration.

Returns:

this instance (for method chaining)

isStopped

boolean isStopped()

true if the job is terminated (e.g. DataMovementManager.stopJob was called), false otherwise

Returns:

true if the job is terminated (e.g. DataMovementManager.stopJob was called), false otherwise

getJobTicket

JobTicket getJobTicket()

After the job has been started, returns the JobTicket generated when the job was started.

Returns:

the JobTicket generated when this job was started

Throws:

IllegalStateException - if this job has not yet been started