io.greptime

Interface BulkWrite

All Known Implementing Classes:

BulkWriteClient, GreptimeDB

public interface BulkWrite

BulkWrite API: writes data to the database in bulk.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BulkWrite.Config

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_ALLOCATOR_INIT_RESERVATION The default allocator init reservation bytes.
static long	DEFAULT_ALLOCATOR_MAX_ALLOCATION The default allocator max allocation bytes.
static int	DEFAULT_MAX_REQUESTS_IN_FLIGHT The default max in-flight requests in the stream.
static long	DEFAULT_TIMEOUT_MS_PER_MESSAGE The default timeout in milliseconds for each message.

Method Summary

Modifier and Type	Method and Description
default BulkStreamWriter	bulkStreamWriter(TableSchema schema)
default BulkStreamWriter	bulkStreamWriter(TableSchema schema, BulkWrite.Config config)
default BulkStreamWriter	bulkStreamWriter(TableSchema schema, BulkWrite.Config config, Context ctx)
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.

Field Detail

DEFAULT_TIMEOUT_MS_PER_MESSAGE

static final long DEFAULT_TIMEOUT_MS_PER_MESSAGE

The default timeout in milliseconds for each message.

See Also:

Constant Field Values

DEFAULT_ALLOCATOR_INIT_RESERVATION

static final long DEFAULT_ALLOCATOR_INIT_RESERVATION

The default allocator init reservation bytes.

See Also:

Constant Field Values

DEFAULT_ALLOCATOR_MAX_ALLOCATION

static final long DEFAULT_ALLOCATOR_MAX_ALLOCATION

The default allocator max allocation bytes.

See Also:

Constant Field Values

DEFAULT_MAX_REQUESTS_IN_FLIGHT

static final int DEFAULT_MAX_REQUESTS_IN_FLIGHT

The default max in-flight requests in the stream. This value should be determined based on the size of each request packet. A higher value means more in-flight requests, which could potentially saturate network bandwidth or exceed the actual processing capacity of the database.

See Also:

Constant Field Values

Method Detail

bulkStreamWriter

default BulkStreamWriter bulkStreamWriter(TableSchema schema)

bulkStreamWriter

default BulkStreamWriter bulkStreamWriter(TableSchema schema,
                                          BulkWrite.Config config)

bulkStreamWriter

default BulkStreamWriter bulkStreamWriter(TableSchema schema,
                                          BulkWrite.Config config,
                                          Context ctx)

bulkStreamWriter

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.

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