io.greptime

Class WriteClient

java.lang.Object

io.greptime.WriteClient

All Implemented Interfaces:

Display, Lifecycle<WriteOptions>, Health, Write

public class WriteClient
extends Object
implements Write, Health, Lifecycle<WriteOptions>, Display

Default Write API impl.

Nested Class Summary

Nested classes/interfaces inherited from interface io.greptime.common.Display

Display.DefaultPrinter, Display.Printer

Constructor Summary

Constructors

Constructor and Description
WriteClient()

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Map<Endpoint,Boolean>>	checkHealth()
void	display(Display.Printer out)
boolean	init(WriteOptions opts)
void	shutdownGracefully()
StreamWriter<Table,WriteOk>	streamWriter(int maxPointsPerSecond, Context ctx) Create a `Stream` to continuously write data to the database, typically used in data import scenarios.
String	toString()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.greptime.Write

streamWriter, streamWriter, write, write, write

Methods inherited from interface io.greptime.common.Lifecycle

ensureInitialized

Constructor Detail

WriteClient

public WriteClient()

Method Detail

init

public boolean init(WriteOptions opts)

Specified by:

init in interface Lifecycle<WriteOptions>

shutdownGracefully

public void shutdownGracefully()

Specified by:

shutdownGracefully in interface Lifecycle<WriteOptions>

write

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

Description copied from interface: Write

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

Specified by:

write in interface Write

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

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

Description copied from interface: Write

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.

Specified by:

streamWriter in interface Write

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

checkHealth

public CompletableFuture<Map<Endpoint,Boolean>> checkHealth()

Specified by:

checkHealth in interface Health

display

public void display(Display.Printer out)

Specified by:

display in interface Display

toString

public String toString()

Overrides:

toString in class Object