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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flux-api Show documentation

Flux API for data movement with MarkLogic

There is a newer version: 1.1.3

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

import java.util.Map;
import java.util.function.Consumer;

/**
 * Read delimited text files from local, HDFS, and S3 locations using
 * Spark's CSV support,
 * and write JSON or XML documents to MarkLogic.
 */
public interface DelimitedFilesImporter extends Executor {

    DelimitedFilesImporter from(Consumer consumer);

    DelimitedFilesImporter from(String... paths);

    DelimitedFilesImporter to(Consumer consumer);

    interface ReadDelimitedFilesOptions extends ReadFilesOptions {
        ReadDelimitedFilesOptions delimiter(String delimiter);

        ReadDelimitedFilesOptions additionalOptions(Map options);

        ReadDelimitedFilesOptions groupBy(String columnName);

        ReadDelimitedFilesOptions aggregateColumns(String newColumnName, String... columns);

        ReadDelimitedFilesOptions encoding(String encoding);

        ReadDelimitedFilesOptions uriIncludeFilePath(boolean value);
    }
}