Package | Description |
---|---|
com.marklogic.client.datamovement |
The MarkLogic Data Movement SDK supports long-running write, read,
delete, or transform jobs.
|
com.marklogic.client.example.cookbook.datamovement |
Modifier and Type | Class | Description |
---|---|---|
class |
ApplyTransformListener |
Modifies documents in-place in the database by applying a
server-side transform . |
class |
DeleteListener |
Sends a Java API bulk
delete
request for all the documents from each batch. |
class |
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. |
class |
ExportToWriterListener |
An extension of ExportListener which facilitates writing all documents to a
single Writer output stream.
|
class |
ExtractRowsViaTemplateListener |
This QueryBatchListener takes in one or more uris for templates as defined by
Marklogic TDE (Template Driven Extraction) and applies them to each batch of
documents.
|
class |
ProgressListener |
Reports on progress as batches are processed by sending an instance of the nested ProgressUpdate interface to
instances of java.util.function.Consumer.
|
class |
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. |
Modifier and Type | Method | Description |
---|---|---|
QueryBatchListener[] |
QueryBatcher.getQuerySuccessListeners() |
Deprecated.
(as of 4.0.4) this should have been called getUrisReadyListeners
|
QueryBatchListener[] |
QueryBatcher.getUrisReadyListeners() |
Get the array of QueryBatchListener instances registered via
onUrisReady.
|
Modifier and Type | Method | Description |
---|---|---|
BatchFailureListener<QueryBatch> |
HostAvailabilityListener.initializeRetryListener(QueryBatchListener queryBatchListener) |
Initializes the RetryListener for the given QueryBatchListener.
|
ApplyTransformListener |
ApplyTransformListener.onSkipped(QueryBatchListener listener) |
When documents were not found and therefore not transformed, run this
listener code.
|
ApplyTransformListener |
ApplyTransformListener.onSuccess(QueryBatchListener listener) |
When a batch has been successfully transformed, run this listener code.
|
QueryBatcher |
QueryBatcher.onUrisReady(QueryBatchListener listener) |
Add a listener to run each time a batch of uris is ready.
|
void |
QueryBatcher.retryListener(QueryBatch batch,
QueryBatchListener queryBatchListener) |
Retries processing the listener to the batch of URIs, when the batch has
been successfully retrieved from the server but applying the listener
on the batch failed.
|
void |
QueryBatcher.setUrisReadyListeners(QueryBatchListener... listeners) |
Remove any existing QueryBatchListener instances registered
via onUrisReady and replace them with the provided listeners.
|
Modifier and Type | Class | Description |
---|---|---|
class |
JobInformationRecorder.addQueryBatchSuccessInformationListener |
|
class |
OpticExportListener |
Takes in a Function which takes QueryBatch as argument and converts it into a
Plan and then iterates the row set returned by the constructed Plan and sends
each RowRecord to any listeners registered with
onRowRecordReady for further processing or writing to any target supported
by Java
For example:
Function<QueryBatch, PlanBuilder.Plan> fn = batch -> {
PlanBuilder.Plan plan = convertToOpticPlan(batch);
return plan;
}
where "convertToOpticPlan" is your custom code which converts the QueryBatch
into Optic plan from which records can be retrieved. |
class |
OpticExportToWriterListener |
An extension of OpticExportListener which facilitates writing all row records
from the constructed Plan to a single Writer output stream.
|
Copyright © 2013-2019 MarkLogic Corporation.