io.greptime

Interface Write

All Known Implementing Classes:

GreptimeDB, WriteClient

public interface Write

Write API: writes data to the database.

Method Summary

Modifier and Type	Method and Description
default StreamWriter<Table,WriteOk>	streamWriter()
default StreamWriter<Table,WriteOk>	streamWriter(int maxPointsPerSecond)
StreamWriter<Table,WriteOk>	streamWriter(int maxPointsPerSecond, Context ctx) Create a `Stream` to continuously write data to the database, typically used in data import scenarios.
default CompletableFuture<Result<WriteOk,Err>>	write(Collection<Table> tables)
default CompletableFuture<Result<WriteOk,Err>>	write(Collection<Table> tables, WriteOp writeOp)
CompletableFuture<Result<WriteOk,Err>>	write(Collection<Table> tables, WriteOp writeOp, Context ctx) Write multiple rows of data (which can belong to multiple tables) to the database at once.
default CompletableFuture<Result<WriteOk,Err>>	write(Table... tables)

Method Detail

write

default CompletableFuture<Result<WriteOk,Err>> write(Table... tables)

Parameters:

tables - the tables to write

Returns:

a future that completes with the write result

See Also:

write(Collection, WriteOp, Context)

write

default CompletableFuture<Result<WriteOk,Err>> write(Collection<Table> tables)

Parameters:

tables - the tables to write

Returns:

a future that completes with the write result

See Also:

write(Collection, WriteOp, Context)

write

default CompletableFuture<Result<WriteOk,Err>> write(Collection<Table> tables,
                                                     WriteOp writeOp)

Parameters:

tables - the tables to write

writeOp - the write operation

Returns:

a future that completes with the write result

See Also:

write(Collection, WriteOp, Context)

write

CompletableFuture<Result<WriteOk,Err>> write(Collection<Table> tables,
                                             WriteOp writeOp,
                                             Context ctx)

Write multiple rows of data (which can belong to multiple tables) to the database at once.

Parameters:

tables - a collection of data to be written, classified by table

writeOp - write operation(insert or delete)

ctx - invoke context

Returns:

write result

streamWriter

default StreamWriter<Table,WriteOk> streamWriter()

Returns:

a stream writer instance

See Also:

streamWriter(int, Context)

streamWriter

default StreamWriter<Table,WriteOk> streamWriter(int maxPointsPerSecond)

Parameters:

maxPointsPerSecond - the max number of points that can be written per second, exceeding which may cause blockage

Returns:

a stream writer instance

See Also:

streamWriter(int, Context)

streamWriter

StreamWriter<Table,WriteOk> streamWriter(int maxPointsPerSecond,
                                         Context ctx)

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.

Parameters:

maxPointsPerSecond - the max number of points that can be written per second, exceeding which may cause blockage

ctx - invoke context

Returns:

a stream writer instance