• Home
• com.marklogic
• flux-api
• 1.0.0
• source code
• WriteStructuredDocumentsOptions.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.marklogic.flux.api.WriteStructuredDocumentsOptions Maven / Gradle / Ivy

/*
 * Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
 */
package com.marklogic.flux.api;

/**
 * Defines options for writing "structured" documents - i.e. JSON or XML documents created from all the columns in
 * the rows returned by a reader (as opposed to "document" rows where the document is defined by the "content" column).
 */
public interface WriteStructuredDocumentsOptions extends WriteDocumentsOptions {

    WriteStructuredDocumentsOptions jsonRootName(String jsonRootName);

    WriteStructuredDocumentsOptions xmlRootName(String xmlRootName);

    WriteStructuredDocumentsOptions xmlNamespace(String xmlNamespace);

    /**
     * @param value Ignore fields with null values in the data source when writing JSON or XML documents to MarkLogic.
     *              Fields with null values are included by default.
     * @return an instance of these options.
     */
    WriteStructuredDocumentsOptions ignoreNullFields(boolean value);
}