dev branch: bulk read: Unable to retrieve metadata by uri

[kcoleman-marklogic]

When I try to fetch just metadata or both content and metadata using a bulk read by URI, I get a MarkLogicInternalException telling me that "Metadata and content parts should always come in pairs!"

Exception in thread "main" com.marklogic.client.MarkLogicInternalException: Metadata and content parts should always come in pairs!
at com.marklogic.client.impl.JerseyServices.convertToDocumentPage(JerseyServices.java:730)
at com.marklogic.client.impl.JerseyServices.getBulkDocuments(JerseyServices.java:702)
at com.marklogic.client.impl.DocumentManagerImpl.read(DocumentManagerImpl.java:331)
at com.marklogic.client.impl.JSONDocumentImpl.read(JSONDocumentImpl.java:1)
at com.marklogic.client.impl.DocumentManagerImpl.read(DocumentManagerImpl.java:313)
at com.marklogic.client.impl.JSONDocumentImpl.read(JSONDocumentImpl.java:1)
at examples.ReadExamples.example2(ReadExamples.java:47)
at examples.ReadExamples.main(ReadExamples.java:60)

I'll paste my example function in the next comment, but I was basically attempting to do the moral equivalent of this REST request:

curl --anyauth --user admin:adm1n -X GET 'http://localhost:8003/v1/documents?uri=doc1.json&uri=doc2.json&uri=doc3.json&category=quality'

I tried with and without also fetching content. I tried both a JSON and an XML DocumentManager. All give the same result.

[kcoleman-marklogic]

// Sample code that demonstrates the problem:
package examples;

import com.marklogic.client.io.*;
import com.marklogic.client.document.DocumentPage;
import com.marklogic.client.document.DocumentRecord;
import com.marklogic.client.document.JSONDocumentManager;
import com.marklogic.client.document.DocumentManager.Metadata;
import com.marklogic.client.DatabaseClientFactory;
import com.marklogic.client.DatabaseClient;


public class standalone {
    // replace with your MarkLogic Server connection information
    static String HOST = "kim-3.marklogic.com";
    static int PORT = 8003;
    static String USER = "admin";
    static String PASSWORD = "adm1n";
    static  DatabaseClient client = DatabaseClientFactory.newClient(
            HOST, PORT, 
            USER, PASSWORD, 
            DatabaseClientFactory.Authentication.DIGEST);

    public static void example2() { 
        JSONDocumentManager jdm = client.newJSONDocumentManager();
        jdm.setMetadataCategories(Metadata.QUALITY);
        DocumentPage documents = jdm.read("doc1.json", "doc2.json", "doc3.json");
        while (documents.hasNext()) {
            DocumentRecord document = documents.next();
            System.out.print(document.getUri() + ": ");
//          StringHandle content = document.getContent(new StringHandle());
            DocumentMetadataHandle metadata = document.getMetadata(new DocumentMetadataHandle());
            System.out.println(document.getUri() + ": " + metadata.getQuality());
//          System.out.println(content.toString());
        }
    }   


    public static void main(String[] args) {
        example2();
    }
}

[kcoleman-marklogic]

p.s. I forgot to say, it should be reproducible with any documents, but I had inserted mine with the following function, which you can probably drop into the same package and run, +/- an import or two.

    public static void exampleA() {
        // Synthesize input content
        StringHandle doc1 = new StringHandle(
                "{\"number\": 1}").withFormat(Format.JSON);
        StringHandle doc2 = new StringHandle(
                "{\"number\": 2}").withFormat(Format.JSON);
        StringHandle doc3 = new StringHandle(
                "{\"number\": 3}").withFormat(Format.JSON);
        StringHandle doc4 = new StringHandle(
                "{\"number\": 4}").withFormat(Format.JSON);
        StringHandle doc5 = new StringHandle(
                "{\"number\": 5}").withFormat(Format.JSON);

        // Synthesize input metadata
        DocumentMetadataHandle defaultMetadata1 = 
                new DocumentMetadataHandle().withQuality(1);
        DocumentMetadataHandle defaultMetadata2 = 
                new DocumentMetadataHandle().withQuality(2);
        DocumentMetadataHandle docSpecificMetadata = 
                new DocumentMetadataHandle().withCollections("myCollection");

        // Create and build up the batch
        JSONDocumentManager jdm = client.newJSONDocumentManager();
        DocumentWriteSet batch = jdm.newWriteSet();

        // use system default metadata
        batch.add("doc1.json", doc1);       // system default metadata

        // using batch default metadata
        batch.addDefault(defaultMetadata1);  // XXX this needs a name change
        batch.add("doc2.json", doc2);       // batch default metadata
        batch.add("doc3.json", docSpecificMetadata, doc3); // XXX add back when bug fixed
        batch.add("doc4.json", doc4);       // batch default metadata

        // replace batch default metadata with new metadata
        batch.addDefault(defaultMetadata2); // XXX this needs a name change
        batch.add("doc5.json", doc5);       // batch default 

        // Execute the write operation
        jdm.write(batch);

        // Check the results
        // Doc1 should have the system default quality of 0
        System.out.println("doc1 quality: Expected=0, Actual=" + 
                jdm.readMetadata("doc1.json", new DocumentMetadataHandle()).getQuality()
                );
        // Doc2 should use the first batch default metadata, with quality 1
        System.out.println("doc2 quality: Expected=" +
                defaultMetadata1.getQuality() + ", Actual=" + 
                jdm.readMetadata("doc2.json", new DocumentMetadataHandle()).getQuality()
                );

        // Doc3 should have the system default document quality (0) because quality
        // was not included in the document-specific metadata. It should be in the
        // collection "myCollection", from the document-specific metadata.
        DocumentMetadataHandle doc3Metadata =  
                jdm.readMetadata("doc3.json", new DocumentMetadataHandle());
        System.out.println("doc3 quality: Expected=0, Actual=" + doc3Metadata.getQuality());
        System.out.print("doc3 collections: Expected: myCollection, Actual=");
        for (String collection : doc3Metadata.getCollections()) {
            System.out.print(collection + " ");
        }
        System.out.println();

        // Doc 4 should also use the 1st batch default metadata, with quality 1
        System.out.println("doc4 quality: Expected=" +
                defaultMetadata1.getQuality() + ", Actual=" + 
                jdm.readMetadata("doc4.json", new DocumentMetadataHandle()).getQuality()
                );
        // Doc5 should use the 2nd batch default metadata, with quality 2
        System.out.println("doc5 quality: Expected=" + 
                defaultMetadata2.getQuality() + ", Actual=" + 
                jdm.readMetadata("doc5.json", new DocumentMetadataHandle()).getQuality()
                );
    }

[kcoleman-marklogic]

Gah, lunchtime food coma. Sorry. THIS REST request:

curl --anyauth --user admin:adm1n -H "Accept: multipart/mixed; boundary=BOUNDARY" -X GET http://localhost:8003/v1/documents?uri=doc1.json&uri=doc2.json&uri=doc3.json&category=quality

(The one in the original problem description was missing Accept headers).

[kcoleman-marklogic]

Set status to Fix on behalf of bugtrack integration.

Should this still be assigned to Charles now that Sam is back? For some reason, I actually thought this had been fixed, though I haven't tried it to confirm.