Support of MarkLogic for Java


Supported Libraries

LibraryVersionSupported
MarkLogic Java Client APIUp to: 8.x

Supported Operations

OperationMethods supported
Insertcom.marklogic.client.document.DocumentManager.write
com.marklogic.client.document.DocumentManager.create
com.marklogic.client.document.TextDocumentManager.write
com.marklogic.client.document.XMLDocumentManager.write
com.marklogic.client.document.JSONDocumentManager.write
com.marklogic.client.document.BinaryDocumentManager.write
Selectcom.marklogic.client.document.DocumentManager.read
com.marklogic.client.document.DocumentManager.search
com.marklogic.client.document.TextDocumentManager.read
com.marklogic.client.document.TextDocumentManager.search
com.marklogic.client.document.XMLDocumentManager.read
com.marklogic.client.document.XMLDocumentManager.search
com.marklogic.client.document.JSONDocumentManager.read
com.marklogic.client.document.JSONDocumentManager.search
com.marklogic.client.document.BinaryDocumentManager.read
com.marklogic.client.document.BinaryDocumentManager.search
Deletecom.marklogic.client.document.DocumentManager.delete
com.marklogic.client.document.TextDocumentManager.delete
com.marklogic.client.document.XMLDocumentManager.delete
com.marklogic.client.document.JSONDocumentManager.delete
com.marklogic.client.document.BinaryDocumentManager.delete
Updatecom.marklogic.client.document.DocumentManager.writeMetadata
com.marklogic.client.document.TextDocumentManager.writeMetadata
com.marklogic.client.document.XMLDocumentManager.writeMetadata
com.marklogic.client.document.JSONDocumentManager.writeMetadata
com.marklogic.client.document.BinaryDocumentManager.writeMetadata

Objects

IconDescription
Java MarkLogic database
Java MarkLogic collection
Java unknown MarkLogic database
Java unknown MarkLogic collection
Link typeSource and destination of linkMethods supported
belongsToFrom Java MarkLogic collection to Java MarkLogic database object-
useLinkBetween the caller Java Method objects (constructors also) and Java MarkLogic Collection Object-
useSelectLinkBetween the caller Java Method objects (constructors also) and Java MarkLogic Collection Objectread
search
useUpdateLinkBetween the caller Java Method objects (constructors also) and Java MarkLogic Collection ObjectwriteMetadata
useDeleteLinkBetween the caller Java Method objects (constructors also) and Java MarkLogic Collection Objectdelete
useInsertLinkBetween the caller Java Method objects (constructors also) and Java MarkLogic Collection Objectwrite
create

What results can you expect?

Some example scenarios are shown below:

MarkLogic databse and collection

public class MarkLogicSimpleCrud {
    private DatabaseClient client;
    private TextDocumentManager docManager;

    public MarkLogicSimpleCrud() {
        this.client = DatabaseClientFactory.newClient("productdb", 8000, "productdb");
        this.docManager = client.newTextDocumentManager();
    }

    
     
    public void createProduct() {
        DocumentMetadataHandle metadata = new DocumentMetadataHandle()
            .withCollections("products");

Insert Operation

    public void createProduct() {
        DocumentMetadataHandle metadata = new DocumentMetadataHandle()
            .withCollections("products");

        docManager.write("products", metadata, new StringHandle("Laptop data"));
    }

Select Operation

 public void readProduct() {
        docManager.read("products", new StringHandle());
    }

Update Operation

public void updateProduct() {
        docManager.patch("products", null);
    }

Delete Operation

    public void deleteProduct() {
        docManager.delete("products");
    }

Known Limitations

  • If collection name is not resolved in the CRUD API, then link is created with unknown collection object.