io.greptime

Class GreptimeDB

java.lang.Object

io.greptime.GreptimeDB

All Implemented Interfaces:

BulkWrite, Display, Lifecycle<GreptimeOptions>, Health, Write, WriteObject

public class GreptimeDB
extends Object
implements Write, WriteObject, BulkWrite, Health, Lifecycle<GreptimeOptions>, Display

The GreptimeDB client.

Nested Class Summary

Nested classes/interfaces inherited from interface io.greptime.BulkWrite

BulkWrite.Config

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

Display.DefaultPrinter, Display.Printer

Field Summary

Fields inherited from interface io.greptime.BulkWrite

DEFAULT_ALLOCATOR_INIT_RESERVATION, DEFAULT_ALLOCATOR_MAX_ALLOCATION, DEFAULT_MAX_REQUESTS_IN_FLIGHT, DEFAULT_TIMEOUT_MS_PER_MESSAGE

Method Summary

Modifier and Type	Method and Description
BulkStreamWriter	bulkStreamWriter(TableSchema schema, long allocatorInitReservation, long allocatorMaxAllocation, long timeoutMsPerMessage, int maxRequestsInFlight, Context ctx) Creates a bulk stream writer for efficiently writing data to the server.
CompletableFuture<Map<Endpoint,Boolean>>	checkHealth()
static GreptimeDB	create(GreptimeOptions opts) Creates a new GreptimeDB instance.
void	display(Display.Printer out)
void	ensureInitialized()
boolean	init(GreptimeOptions opts)
static List<GreptimeDB>	instances() Gets all instances of GreptimeDB.
StreamWriter<List<?>,WriteOk>	objectsStreamWriter(int maxPointsPerSecond, Context ctx) Create a `Stream` to continuously write data to the database, typically used in data import scenarios.
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.
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.

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.WriteObject

objectsStreamWriter, objectsStreamWriter, writeObjects, writeObjects, writeObjects

Methods inherited from interface io.greptime.BulkWrite

bulkStreamWriter, bulkStreamWriter, bulkStreamWriter

Method Detail

instances

public static List<GreptimeDB> instances()

Gets all instances of GreptimeDB.

Returns:

all instances of GreptimeDB

create

public static GreptimeDB create(GreptimeOptions opts)

Creates a new GreptimeDB instance.

Parameters:

opts - the options for the GreptimeDB client

Returns:

a new GreptimeDB instance

Throws:

RuntimeException - if the GreptimeDB client fails to start

init

public boolean init(GreptimeOptions opts)

Specified by:

init in interface Lifecycle<GreptimeOptions>

shutdownGracefully

public void shutdownGracefully()

Specified by:

shutdownGracefully in interface Lifecycle<GreptimeOptions>

ensureInitialized

public void ensureInitialized()

Specified by:

ensureInitialized in interface Lifecycle<GreptimeOptions>

writeObjects

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

Description copied from interface: WriteObject

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

Specified by:

writeObjects in interface WriteObject

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

public StreamWriter<List<?>,WriteOk> objectsStreamWriter(int maxPointsPerSecond,
                                                         Context ctx)

Description copied from interface: WriteObject

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`.

Specified by:

objectsStreamWriter in interface WriteObject

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

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

bulkStreamWriter

public BulkStreamWriter bulkStreamWriter(TableSchema schema,
                                         long allocatorInitReservation,
                                         long allocatorMaxAllocation,
                                         long timeoutMsPerMessage,
                                         int maxRequestsInFlight,
                                         Context ctx)

Description copied from interface: BulkWrite

Creates a bulk stream writer for efficiently writing data to the server.

Specified by:

bulkStreamWriter in interface BulkWrite

Parameters:

schema - the schema of the table

allocatorInitReservation - the initial space reservation (obtained from this allocator)

allocatorMaxAllocation - the maximum amount of space the new child allocator can allocate

timeoutMsPerMessage - the timeout in milliseconds for each message

maxRequestsInFlight - the max in-flight requests in the stream

ctx - invoke context

Returns:

a bulk 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