tammyhale / ml-javaclient-util-issue-136 Goto Github PK

ml-javaclient-util is a library of Java classes that provide some useful functionality on top of the MarkLogic Java Client API. Those features include:

• Support for loading modules via the REST API
• Basic integration with Spring via a Spring FactoryBean
• Library for parallelizing batched writes
• Spring-style template/callback library for XCC
• Support for generating MarkLogic 9 Entity Services modules
• Support for [importing/exporting qconsole workspaces] (https://github.com/rjrudin/ml-javaclient-util/tree/master/src/main/java/com/marklogic/client/qconsole)

This is a lower-level library that is primarily used via ml-app-deployer and ml-gradle and ml-junit. But you can use it by itself too.

Here's a sample of loading modules - though it's best to look at the aforementioned projects to see all the ways this can be done:

DatabaseClient client = DatabaseClientFactory.newClient(...); // Use the ML Java Client API
XccAssetLoader assetLoader = new XccAssetLoader(client); // Can use XCC or the REST API to load asset modules
DefaultModulesLoader modulesLoader = new DefaultModulesLoader(assetLoader);
File modulesDir = new File("src/main/ml-modules");
ModulesFinder modulesFinder = new DefaultModulesFinder(); // Allows for adjusting where modules are stored on a filesystem
modulesLoader.loadModules(modulesDir, modulesFinder, client);

The BatchWriter library was created primarily for applications using marklogic-spring-batch. But it can be used in any environment. It provides the following features:

1. Uses Spring's TaskExecutor library for parallelizing writes
2. Supports writes via the REST API or XCC

Via Spring's TaskExecutor library, you can essentially throw an infinite number of documents at this interface. The library will default to a sensible implementation of ThreadPoolTaskExecutor, but you can override that with any TaskExecutor implementation you like.

Once MarkLogic 9 is available, an implementation will be used that depends on the new Data Movement SDK, which is being added to the MarkLogic Java Client API.

Here's a sample using two DatabaseClient instances:

	// This is all basic Java Client API stuff
DatabaseClient client1 = DatabaseClientFactory.newClient("host1", ...);
DatabaseClient client2 = DatabaseClientFactory.newClient("host2", ...);
DocumentWriteOperation doc1 = new DocumentWriteOperationImpl("test1.xml", ...);
DocumentWriteOperation doc2 = new DocumentWriteOperationImpl("test2.xml", ...);

// Here's how BatchWriter works
BatchWriter writer = new RestBatchWriter(Arrays.asList(client1, client2));
writer.initialize();
writer.write(Arrays.asList(doc1, doc2));
writer.waitForCompletion();