io.greptime

Class BulkWriteClient

java.lang.Object

io.greptime.BulkWriteClient

All Implemented Interfaces:

BulkWrite, Display, Lifecycle<BulkWriteOptions>, Health

public class BulkWriteClient
extends Object
implements BulkWrite, Health, Lifecycle<BulkWriteOptions>, Display

Client for bulk writing data to GreptimeDB. This client provides high-performance data ingestion capabilities through Arrow Flight protocol.

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

Constructor Summary

Constructors

Constructor and Description
BulkWriteClient()

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()
void	display(Display.Printer out)
boolean	init(BulkWriteOptions opts)
void	shutdownGracefully()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.greptime.BulkWrite

bulkStreamWriter, bulkStreamWriter, bulkStreamWriter

Methods inherited from interface io.greptime.common.Lifecycle

ensureInitialized

Constructor Detail

BulkWriteClient

public BulkWriteClient()

Method Detail

init

public boolean init(BulkWriteOptions opts)

Specified by:

init in interface Lifecycle<BulkWriteOptions>

shutdownGracefully

public void shutdownGracefully()

Specified by:

shutdownGracefully in interface Lifecycle<BulkWriteOptions>

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