com.marklogic.flux.api.RdfFilesExporter 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.function.Consumer;

/**
 * Read triples from MarkLogic and write them to a local filesystem, HDFS, or S3.
 */
public interface RdfFilesExporter extends Executor {

    interface ReadTriplesDocumentsOptions {

        ReadTriplesDocumentsOptions graphs(String... graphs);

        ReadTriplesDocumentsOptions stringQuery(String stringQuery);

        ReadTriplesDocumentsOptions uris(String... uris);

        ReadTriplesDocumentsOptions query(String query);

        ReadTriplesDocumentsOptions options(String options);

        ReadTriplesDocumentsOptions collections(String... collections);

        ReadTriplesDocumentsOptions directory(String directory);

        ReadTriplesDocumentsOptions baseIri(String baseIri);

        ReadTriplesDocumentsOptions batchSize(int batchSize);

        ReadTriplesDocumentsOptions partitionsPerForest(int partitionsPerForest);

        ReadTriplesDocumentsOptions logProgress(int interval);

        /**
         * Read documents at multiple points in time, as opposed to using a consistent snapshot.
         *
         * @since 1.1.2
         */
        ReadTriplesDocumentsOptions noSnapshot();
    }

    interface WriteRdfFilesOptions extends WriteFilesOptions {
        WriteRdfFilesOptions format(String format);

        WriteRdfFilesOptions graphOverride(String graphOverride);

        WriteRdfFilesOptions gzip();
    }

    RdfFilesExporter from(Consumer consumer);

    RdfFilesExporter to(Consumer consumer);

    RdfFilesExporter to(String path);
}