Uses of Package
com.marklogic.client.datamovement

Packages that use com.marklogic.client.datamovement

Package	Description
com.marklogic.client	The package provides the core classes, interfaces and exceptions for working with the database.
com.marklogic.client.datamovement	The MarkLogic Data Movement SDK supports long-running write, read, delete, or transform jobs.

Classes in com.marklogic.client.datamovement used by com.marklogic.client

Class and Description
DataMovementManager DataMovementManager is the starting point for getting new instances of QueryBatcher and WriteBatcher, configured with a DatabaseClient and ForestConfiguration.

Classes in com.marklogic.client.datamovement used by com.marklogic.client.datamovement

Class and Description
ApplyTransformListener Modifies documents in-place in the database by applying a server-side transform.
ApplyTransformListener.ApplyResult Either ApplyTransformListener.ApplyResult.REPLACE each document with the result of the transform, or run the transform with each document as input, but ApplyTransformListener.ApplyResult.IGNORE the result.
Batch A group of items (generally documents or uris) and context representing a completed action in a datamovement job.
Batcher The base class (shared methods) for QueryBatcher and WriteBatcher.
BatchFailureListener A generic interface for listeners which process failures on batches.
BatchListener Runs processEvent on each batch as it is ready during a QueryBatcher or WriteBatcher job.
DataMovementManager DataMovementManager is the starting point for getting new instances of QueryBatcher and WriteBatcher, configured with a DatabaseClient and ForestConfiguration.
DeleteListener Sends a Java API bulk delete request for all the documents from each batch.
ExportListener Reads document contents (and optionally metadata) for each batch, then sends each document to any listeners registered with onDocumentReady for further processing or writing to any target supported by Java.
ExportToWriterListener An extension of ExportListener which facilitates writing all documents to a single Writer output stream.
ExportToWriterListener.OutputListener The listener interface required by onGenerateOutput.
FailureListener A generic base interface for listeners implemented by QueryFailureListener for processing a Throwable that caused a failure.
FilteredForestConfiguration A utility class for wrapping a ForestConfiguration retrieved from DataMovementManager.readForestConfig().
Forest Some details about a MarkLogic forest.
ForestConfiguration A reflection of the forest configuration associated with the specified database (or the default database for the specified port) in the MarkLogic cluster.
HostAvailabilityListener HostAvailabilityListener is automatically registered with all QueryBatcher and WriteBatcher instances to monitor for failover scenarios.
JobReport A Job report is used to report status on a WriteBatcher or a QueryBatcher job at any point of time after it is started and provide a snapshot of the job’s status at that time.
JobTicket JobTicket is used to uniquely identify a job.
JobTicket.JobType
QueryBatch A group of uris retrieved from the Iterator or matches to the QueryDefinition for this QueryBatcher job.
QueryBatcher To facilitate long-running read, update, and delete use cases, coordinates threads to process batches of uris matching a query or coming from an Iterator.
QueryBatchException An exception which occurred when attempting to retrieve a batch of matches to a query.
QueryBatchListener Runs processEvent on each batch as it is ready during a QueryBatcher job.
QueryEvent The context for a QueryBatch passed to QueryBatchListener or an exception passed to QueryFailureListener, indicating the state at the time this event occurred.
QueryFailureListener A listener which can process an exception which occurred when attempting to retrieve a batch of matches to a query.
UrisToWriterListener Facilitates writing uris to a file when necessary because setting merge timestamp and withConsistentSnapshot is not an option, but you need to run DeleteListener or ApplyTransformListener.
UrisToWriterListener.OutputListener
WriteBatch A batch of documents written successfully.
WriteBatcher To facilitate long-running write jobs, batches documents added by many external threads and coordinates internal threads to send the batches round-robin to all appropriate hosts in the cluster.
WriteBatchListener Runs processEvent on each batch as it is ready during a WriteBatcher job.
WriteEvent Each WriteBatch is composed of many WriteEvents, each of which represents all the information about a single document which was written to the server.
WriteFailureListener The listener interface for handling exceptions occurring withing WriteBatcher.