DataMovementManager (MarkLogic Java Client API 8.1.0)

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

SEARCH:

All Superinterfaces:: AutoCloseable, Closeable

public interface DataMovementManagerextends Closeable

DataMovementManager is the starting point for getting new instances of QueryBatcher, WriteBatcher and RowBatcher, configured with a DatabaseClient and ForestConfiguration. On instantiation, it will immediately call readForestConfig to obtain the ForestConfiguration from which it can create host-specific DatabaseClient instances for each applicable host. Applicable hosts are those with forests for the database specified in the DatabaseClient. If not specified, the database is the default database for the port in the DatabaseClient. Call dataMovementMangaer.release() when you're done with your DataMovementManager instance to free resources associated with those host-specific DatabaseClient instances.

Sample Usage:


     DataMovementManager dataMovementManager = databaseClient.newDataMovementManager();
     WriteBatcher batcher = dataMovementManager.newWriteBatcher();
     dataMovementManager.startJob(batcher);
     . . .
     dataMovementManager.stopJob(batcher);
     dataMovementManager.release();

Method Summary

Modifier and Type

Method

Description

default void

close()

JobTicket

getActiveJob(String jobId)

Gets the job ticket for an active job that has not been stopped by calling stopJob method.

DatabaseClient.ConnectionType

getConnectionType()

Identify whether the DataMovementManager connects directly to each MarkLogic host with a forest for the database or whether the DataMovementManager uses a gateway such as a load balancer to communicate with the MarkLogic hosts.

JobReport

getJobReport(JobTicket ticket)

Get a snapshot report of the state of the job when the call is made.

QueryBatcher

newQueryBatcher(CtsQueryDefinition query)

Create a new QueryBatcher instance configured to retrieve uris that match this query.

QueryBatcher

newQueryBatcher(RawCombinedQueryDefinition query)

Create a new QueryBatcher instance configured to retrieve uris that match this query.

QueryBatcher

newQueryBatcher(RawCtsQueryDefinition query)

Create a new QueryBatcher instance configured to retrieve uris that match this Cts query.

QueryBatcher

newQueryBatcher(RawStructuredQueryDefinition query)

Create a new QueryBatcher instance configured to retrieve uris that match this query.

QueryBatcher

newQueryBatcher(StringQueryDefinition query)

Create a new QueryBatcher instance configured to retrieve uris that match this query.

QueryBatcher

newQueryBatcher(StructuredQueryDefinition query)

Create a new QueryBatcher instance configured to retrieve uris that match this query.

QueryBatcher

newQueryBatcher(Iterator<String> iterator)

Create a new QueryBatcher instance configured to retrieve uris from this Iterator.

<T> RowBatcher<T>

newRowBatcher(ContentHandle<T> rowsHandle)

Create a new RowBatcher instance to export all of the rows from a view in batches.

WriteBatcher

newWriteBatcher()

Create a new WriteBatcher instance.

ForestConfiguration

readForestConfig()

Update the ForestConfiguration with the latest from the server.

void

release()

Calls release() on all host-specific DatabaseClient instances (but not on the DatabaseClient instance used to create this DataMovementManager instance).

JobTicket

startJob(QueryBatcher batcher)

Starts the QueryBatcher job.

JobTicket

startJob(RowBatcher<?> batcher)

Starts the RowBatcher job.

JobTicket

startJob(WriteBatcher batcher)

Begins job tracking on the WriteBatcher.

void

stopJob(Batcher batcher)

Immediately cancel all queued tasks, prevent new tasks from being added to the queue, and begin to free all resources.

void

stopJob(JobTicket ticket)

Immediately cancel all queued tasks, prevent new tasks from being added to the queue, and begin to free all resources.

Method Details
- close
  
  default void close()
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in interface Closeable
  
  Since:
  
  8.1.0
- release
  
  void release()
  
  Calls release() on all host-specific DatabaseClient instances (but not on the DatabaseClient instance used to create this DataMovementManager instance).
- startJob
  
  JobTicket startJob(WriteBatcher batcher)
  
  Begins job tracking on the WriteBatcher. Calling startJob is not required on a WriteBatcher if you don't intend to ever call stopJob or look at the JobReport.
  
  Parameters:
  
  batcher - the WriteBatcher instance which has to be started
  
  Returns:
  
  a JobTicket which can be used to track the job
- startJob
  
  JobTicket startJob(QueryBatcher batcher)
  
  Starts the QueryBatcher job.
  
  Parameters:
  
  batcher - the QueryBatcher instance which has to be started
  
  Returns:
  
  a JobTicket which can be used to track the job
- startJob
  
  JobTicket startJob(RowBatcher<?> batcher)
  
  Starts the RowBatcher job.
  
  Parameters:
  
  batcher - the RowBatcher instance to start
  
  Returns:
  
  a JobTicket which can be used to track the job
- getJobReport
  
  JobReport getJobReport(JobTicket ticket)
  
  Get a snapshot report of the state of the job when the call is made. Depends on some pre-installed listeners attached to the job to collect the details.
  
  Parameters:
  
  ticket - the JobTicket for which the report has to be generated
  
  Returns:
  
  the report for the job
- getActiveJob
  
  JobTicket getActiveJob(String jobId)
  
  Gets the job ticket for an active job that has not been stopped by calling stopJob method. It returns null if there is no such active job.
  
  Parameters:
  
  jobId - the jobId of the active job
  
  Returns:
  
  a JobTicket which can be used to track the job
- stopJob
  
  void stopJob(JobTicket ticket)
  
  Immediately cancel all queued tasks, prevent new tasks from being added to the queue, and begin to free all resources. In-process tasks cannot be cancelled because they talk to the REST server which does not have such a mechanism. This does not block until all in-process tasks are finished, for that use QueryBatcher.awaitCompletion() or WriteBatcher.awaitCompletion().
  
  Parameters:
  
  ticket - indicates the job to stop
- stopJob
  
  void stopJob(Batcher batcher)
  
  Immediately cancel all queued tasks, prevent new tasks from being added to the queue, and begin to free all resources. In-process tasks cannot be cancelled because they talk to the REST server which does not have such a mechanism. This does not block until all in-process tasks are finished, for that use QueryBatcher.awaitCompletion() or WriteBatcher.awaitCompletion().
  
  Parameters:
  
  batcher - the batcher instance to stop
- newWriteBatcher
  
  WriteBatcher newWriteBatcher()
  
  Create a new WriteBatcher instance.
  
  Returns:
  
  the new WriteBatcher instance
- newQueryBatcher
  
  QueryBatcher newQueryBatcher(CtsQueryDefinition query)
  
  Create a new QueryBatcher instance configured to retrieve uris that match this query.
  
  Parameters:
  
  query - the query used to find matching uris
  
  Returns:
  
  the new QueryBatcher instance
- newQueryBatcher
  
  QueryBatcher newQueryBatcher(StructuredQueryDefinition query)
  
  Create a new QueryBatcher instance configured to retrieve uris that match this query.
  
  Parameters:
  
  query - the query used to find matching uris
  
  Returns:
  
  the new QueryBatcher instance
- newQueryBatcher
  
  QueryBatcher newQueryBatcher(RawStructuredQueryDefinition query)
  
  Create a new QueryBatcher instance configured to retrieve uris that match this query.
  
  Parameters:
  
  query - the query used to find matching uris
  
  Returns:
  
  the new QueryBatcher instance
- newQueryBatcher
  
  QueryBatcher newQueryBatcher(StringQueryDefinition query)
  
  Create a new QueryBatcher instance configured to retrieve uris that match this query.
  
  Parameters:
  
  query - the query used to find matching uris
  
  Returns:
  
  the new QueryBatcher instance
- newQueryBatcher
  
  QueryBatcher newQueryBatcher(RawCombinedQueryDefinition query)
  
  Create a new QueryBatcher instance configured to retrieve uris that match this query.
  
  Parameters:
  
  query - the query used to find matching uris
  
  Returns:
  
  the new QueryBatcher instance
- newQueryBatcher
  
  QueryBatcher newQueryBatcher(RawCtsQueryDefinition query)
  
  Create a new QueryBatcher instance configured to retrieve uris that match this Cts query.
  
  Parameters:
  
  query - the query used to find matching uris
  
  Returns:
  
  the new QueryBatcher instance
- newQueryBatcher
  
  QueryBatcher newQueryBatcher(Iterator<String> iterator)
  
  Create a new QueryBatcher instance configured to retrieve uris from this Iterator. This form enables the uris (actually any String) to come from any source, whereas the other form requires the uris to come from the results of a query. This form is helpful when deleting documents when one cannot set the server's merge timestamp. For more discussion, see QueryBatcher.
  
  The Iterator needn't be thread-safe as it is only iterated from one thread.
  
  Parameters:
  
  iterator - the provider of uris
  
  Returns:
  
  the new QueryBatcher instance
- newRowBatcher
  
  <T> RowBatcher<T> newRowBatcher(ContentHandle<T> rowsHandle)
  
  Create a new RowBatcher instance to export all of the rows from a view in batches.
  You pass a sample handle (that is, an adapter for the Java class that should store a batch of retrieved rows). The handle must implement the ContentHandle and StructuredReadHandle interfaces.
  
  Type Parameters:
  
  T - the Java class that stores a batch of retrieved roles
  
  Parameters:
  
  rowsHandle - a sample handle for storing a batch of rows
  
  Returns:
  
  the new RowBatcher instance
- readForestConfig
  
  ForestConfiguration readForestConfig()
  
  Update the ForestConfiguration with the latest from the server.
  
  Returns:
  
  the latest ForestConfiguration from the server
- getConnectionType
  
  DatabaseClient.ConnectionType getConnectionType()
  
  Identify whether the DataMovementManager connects directly to each MarkLogic host with a forest for the database or whether the DataMovementManager uses a gateway such as a load balancer to communicate with the MarkLogic hosts.
  
  Returns:
  
  the connection type

Interface DataMovementManager

Method Summary

Method Details

close

release

startJob

startJob

startJob

getJobReport

getActiveJob

stopJob

stopJob

newWriteBatcher

newQueryBatcher

newQueryBatcher

newQueryBatcher

newQueryBatcher

newQueryBatcher

newQueryBatcher

newQueryBatcher

newRowBatcher

readForestConfig

getConnectionType