com.marklogic.client.datamovement

Interface Batcher

All Known Subinterfaces:

QueryBatcher, RowBatcher<T>, 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()
java.util.Calendar	getJobEndTime() Gets the time at which the Batcher was stopped
java.lang.String	getJobId()
java.lang.String	getJobName()
java.util.Calendar	getJobStartTime() Gets the time at which the Batcher was started
JobTicket	getJobTicket() After the job has been started, returns the JobTicket generated when the job was started.
DatabaseClient	getPrimaryClient() Gets the primary DatabaseClient associated with the batcher
int	getThreadCount()
boolean	isStarted() true if the job is started (e.g.
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	withJobId(java.lang.String jobId) Sets the unique id of the job to help with managing multiple concurrent jobs and start the job with the specified job id.
Batcher	withJobName(java.lang.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(java.lang.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

java.lang.String getJobName()

Returns:

the job name

withJobId

Batcher withJobId(java.lang.String jobId)

Sets the unique id of the job to help with managing multiple concurrent jobs and start the job with the specified job id.

Parameters:

jobId - the unique id you would like to assign to this job

Returns:

this instance (for method chaining)

getJobId

java.lang.String getJobId()

Returns:

the unique job id of the job

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.

Unless otherwise noted by a subclass, this method cannot be called after the job has started.

Parameters:

threadCount - the number of threads to use in this Batcher

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.

Parameters:

forestConfig - the updated list of forests with thier hosts, etc.

Returns:

this instance (for method chaining)

isStarted

boolean isStarted()

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

Returns:

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

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:

java.lang.IllegalStateException - if this job has not yet been started

getJobStartTime

java.util.Calendar getJobStartTime()

Gets the time at which the Batcher was started

Returns:

the Calendar instance and null if the job hasn't started yet

getJobEndTime

java.util.Calendar getJobEndTime()

Gets the time at which the Batcher was stopped

Returns:

the Calendar instance and null if the job hasn't ended yet

getPrimaryClient

DatabaseClient getPrimaryClient()

Gets the primary DatabaseClient associated with the batcher

Returns:

the primary DatabaseClient instance