io.greptime.StreamWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ingester-protocol Show documentation

The newest version!

/*
 * Copyright 2023 Greptime Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.greptime;

import java.util.concurrent.CompletableFuture;

/**
 * A stream writer to continuously write data to the database,
 * typically used in data import scenarios. After completion,
 * the stream needs to be closed(Call `StreamWriter#completed()`),
 * and the write result can be obtained from the database server.
 */
public interface StreamWriter {

    /**
     * @see #write(Object, WriteOp)
     */
    default StreamWriter write(V val) {
        return write(val, WriteOp.Insert);
    }

    /**
     * Write data to this stream.
     *
     * @param val data value
     * @param writeOp write operation(insert or delete)
     * @return this
     */
    StreamWriter write(V val, WriteOp writeOp);

    /**
     * Tell server that the stream-write has completed.
     *
     * @return the streaming-wrote future result
     */
    CompletableFuture completed();
}