io.greptime.Write 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 io.greptime.models.Err;
import io.greptime.models.Result;
import io.greptime.models.Table;
import io.greptime.models.WriteOk;
import io.greptime.rpc.Context;
import java.util.Arrays;
import java.util.Collection;
import java.util.concurrent.CompletableFuture;

/**
 * Write API: writes data to the database.
 */
public interface Write {
    /**
     * @see #write(Collection, WriteOp, Context)
     */
    default CompletableFuture> write(Table... tables) {
        return write(Arrays.asList(tables));
    }

    /**
     * @see #write(Collection, WriteOp, Context)
     */
    default CompletableFuture> write(Collection tables) {
        return write(tables, WriteOp.Insert, Context.newDefault());
    }

    /**
     * @see #write(Collection, WriteOp, Context)
     */
    default CompletableFuture> write(Collection tables, WriteOp writeOp) {
        return write(tables, writeOp, Context.newDefault());
    }

    /**
     * Write multiple rows of data (which can belong to multiple tables) to the database at once.
     *
     * @param tables a collection of data to be written, classified by table
     * @param writeOp write operation(insert or delete)
     * @param ctx invoke context
     * @return write result
     */
    CompletableFuture> write(Collection tables, WriteOp writeOp, Context ctx);

    /**
     * @see #streamWriter(int, Context)
     */
    default StreamWriter streamWriter() {
        return streamWriter(-1);
    }

    /**
     * @see #streamWriter(int, Context)
     */
    default StreamWriter streamWriter(int maxPointsPerSecond) {
        return streamWriter(maxPointsPerSecond, Context.newDefault());
    }

    /**
     * Create a `Stream` 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.
     *
     * @param maxPointsPerSecond the max number of points that can be written per second,
     *                           exceeding which may cause blockage
     * @param ctx invoke context
     * @return a stream writer instance
     */
    StreamWriter streamWriter(int maxPointsPerSecond, Context ctx);
}
    

    







    © 2015 - 2024 Weber Informatics LLC | Privacy Policy