io.greptime

Interface WriteObject

All Known Implementing Classes:

GreptimeDB

public interface WriteObject

Write POJO object API: writes data in POJO object format to the DB.

Method Summary

Modifier and Type	Method and Description
default StreamWriter<List<?>,WriteOk>	objectsStreamWriter()
default StreamWriter<List<?>,WriteOk>	objectsStreamWriter(int maxPointsPerSecond)
StreamWriter<List<?>,WriteOk>	objectsStreamWriter(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>>	writeObjects(Collection<List<?>> objects)
default CompletableFuture<Result<WriteOk,Err>>	writeObjects(Collection<List<?>> objects, WriteOp writeOp)
CompletableFuture<Result<WriteOk,Err>>	writeObjects(Collection<List<?>> objects, 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>>	writeObjects(List<?>... objects)

Method Detail

writeObjects

default CompletableFuture<Result<WriteOk,Err>> writeObjects(List<?>... objects)

Parameters:

objects - the objects to write

Returns:

a future that completes with the write result

See Also:

writeObjects(Collection, WriteOp, Context)

writeObjects

default CompletableFuture<Result<WriteOk,Err>> writeObjects(Collection<List<?>> objects)

Parameters:

objects - the objects to write

Returns:

a future that completes with the write result

See Also:

writeObjects(Collection, WriteOp, Context)

writeObjects

default CompletableFuture<Result<WriteOk,Err>> writeObjects(Collection<List<?>> objects,
                                                            WriteOp writeOp)

Parameters:

objects - the objects to write

writeOp - the write operation

Returns:

a future that completes with the write result

See Also:

writeObjects(Collection, WriteOp, Context)

writeObjects

CompletableFuture<Result<WriteOk,Err>> writeObjects(Collection<List<?>> objects,
                                                    WriteOp writeOp,
                                                    Context ctx)

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

Parameters:

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

writeOp - write operation(insert or delete)

ctx - invoke context

Returns:

write result

objectsStreamWriter

default StreamWriter<List<?>,WriteOk> objectsStreamWriter()

Returns:

a stream writer instance

See Also:

objectsStreamWriter(int, Context)

objectsStreamWriter

default StreamWriter<List<?>,WriteOk> objectsStreamWriter(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:

objectsStreamWriter(int, Context)

objectsStreamWriter

StreamWriter<List<?>,WriteOk> objectsStreamWriter(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.

It is important to note that each write operation can write a List of POJOs. However, the POJO objects in the List must have the same type. If you need to write different types of POJO objects, you can perform multiple write operations on the `Stream`, dividing them into separate writes when you obtain the `Stream`.

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