tech.ytsaurus.client.TableWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ytsaurus-client Show documentation

YTsaurus client

The newest version!

package tech.ytsaurus.client;

import java.io.IOException;
import java.util.List;
import java.util.concurrent.CompletableFuture;


import tech.ytsaurus.core.tables.TableSchema;

/**
 * Prefer to use {@link AsyncWriter} instead of it. See {@link ApiServiceClient#writeTableV2}.
 * @param  row type.
 */
public interface TableWriter {
    TableSchema getSchema();

    /**
     * Attempts to write a bunch of #rows. If false is returned then the rows
     * are not accepted and the client must invoke {@link #readyEvent} and wait.
     */
    boolean write(List rows, TableSchema schema) throws IOException;

    default boolean write(List rows) throws IOException {
        return write(rows, getSchema());
    }

    /**
     * Returns an asynchronous flag enabling to wait until data is written.
     */
    CompletableFuture readyEvent();

    /**
     * Closes the writer. Must be the last call to the writer.
     */
    CompletableFuture close();

    /**
     * Returns the schema to be used for constructing rows.
     */
    CompletableFuture getTableSchema();

    void cancel();
}