Package | Description |
---|---|
com.marklogic.client.datamovement |
The MarkLogic Data Movement SDK supports
long-running write, read, delete, or transform jobs.
|
Modifier and Type | Method | Description |
---|---|---|
QueryBatcher |
QueryBatchException.getBatcher() |
The QueryBatcher assocated with this
event--useful for modifying the
ForestConfiguration or calling
DataMovementManager.stopJob(Batcher) if
needed. |
QueryBatcher |
QueryEvent.getBatcher() |
A reference to the batcher--useful for modifying
the
ForestConfiguration or calling
DataMovementManager.stopJob(Batcher) if
needed. |
QueryBatcher |
DataMovementManager.newQueryBatcher(CtsQueryDefinition query) |
Create a new QueryBatcher instance configured to
retrieve uris that match this query.
|
QueryBatcher |
DataMovementManager.newQueryBatcher(RawCombinedQueryDefinition query) |
Create a new QueryBatcher instance configured to
retrieve uris that match this query.
|
QueryBatcher |
DataMovementManager.newQueryBatcher(RawCtsQueryDefinition query) |
Create a new QueryBatcher instance configured to
retrieve uris that match this Cts query.
|
QueryBatcher |
DataMovementManager.newQueryBatcher(RawStructuredQueryDefinition query) |
Create a new QueryBatcher instance configured to
retrieve uris that match this query.
|
QueryBatcher |
DataMovementManager.newQueryBatcher(StringQueryDefinition query) |
Create a new QueryBatcher instance configured to
retrieve uris that match this query.
|
QueryBatcher |
DataMovementManager.newQueryBatcher(StructuredQueryDefinition query) |
Create a new QueryBatcher instance configured to
retrieve uris that match this query.
|
QueryBatcher |
DataMovementManager.newQueryBatcher(java.util.Iterator<java.lang.String> iterator) |
Create a new QueryBatcher instance configured to
retrieve uris from this Iterator.
|
QueryBatcher |
QueryBatcher.onJobCompletion(QueryBatcherListener listener) |
Add a listener to run when the Query job is
completed i.e.
|
QueryBatcher |
QueryBatcher.onQueryFailure(QueryFailureListener listener) |
Add a listener to run each time there is an
exception retrieving a batch of uris.
|
QueryBatcher |
QueryBatcher.onUrisReady(QueryBatchListener listener) |
Add a listener to run each time a batch of uris
is ready.
|
QueryBatcher |
QueryBatcher.withBatchSize(int docBatchSize) |
Sets the number of documents processed in a
batch.
|
QueryBatcher |
QueryBatcher.withBatchSize(int docBatchSize,
int docToUriBatchRatio) |
Sets the number of documents processed in a
batch and the ratio of the document processing batch to the
document uri collection batch.
|
QueryBatcher |
QueryBatcher.withConsistentSnapshot() |
Specifies that matching uris should be retrieved
as they were when this QueryBatcher job started.
|
QueryBatcher |
QueryBatcher.withForestConfig(ForestConfiguration forestConfig) |
If the server forest configuration changes
mid-job, it can be re-fetched with
DataMovementManager.readForestConfig() then set
via withForestConfig. |
QueryBatcher |
QueryBatcher.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.
|
QueryBatcher |
QueryBatcher.withJobName(java.lang.String jobName) |
Sets the job name.
|
QueryBatcher |
QueryBatcher.withThreadCount(int threadCount) |
Sets the number of threads added to the internal
thread pool for this instance to use for retrieving or processing
batches of uris.
|
Modifier and Type | Method | Description |
---|---|---|
void |
ApplyTransformListener.initializeListener(QueryBatcher queryBatcher) |
This implementation of initializeListener adds
this instance of ApplyTransformListener to the two RetryListener's
in this QueryBatcher so they will retry any batches that fail
during the apply-transform request.
|
void |
DeleteListener.initializeListener(QueryBatcher queryBatcher) |
This implementation of initializeListener adds
this instance of DeleteListener to the two RetryListener's in this
QueryBatcher so they will retry any batches that fail during the
delete request.
|
void |
ExportListener.initializeListener(QueryBatcher queryBatcher) |
This implementation of initializeListener adds
this instance of ExportListener to the two RetryListener's in this
QueryBatcher so they will retry any batches that fail during the
read request.
|
void |
ExportToWriterListener.initializeListener(QueryBatcher queryBatcher) |
This implementation of initializeListener adds
this instance of ExportToWriterListener to the two RetryListener's
in this QueryBatcher so they will retry any batches that fail
during the read request.
|
void |
ExtractRowsViaTemplateListener.initializeListener(QueryBatcher queryBatcher) |
|
void |
ProgressListener.initializeListener(QueryBatcher queryBatcher) |
Initializes the start time so that each
ProgressUpdate knows how long it occurred after the job was
started.
|
default void |
QueryBatchListener.initializeListener(QueryBatcher queryBatcher) |
This default method should be implemented by
custom listeners that should be retried in case of failover.
|
void |
UrisToWriterListener.initializeListener(QueryBatcher queryBatcher) |
This implementation of initializeListener adds
this instance of UrisToWriterListener to the two RetryListener's in
this QueryBatcher so they will retry any batches that fail during
the uris request.
|
void |
QueryBatcherListener.processEvent(QueryBatcher batcher) |
The method called by QueryBatcher to run your
custom code at the QueryBatcher level.
|
JobTicket |
DataMovementManager.startJob(QueryBatcher batcher) |
Starts the QueryBatcher job.
|
Copyright © 2022 MarkLogic Corporation