cx

package
v3.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 10, 2022 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Batch

type Batch struct {
	// contains filtered or unexported fields
}

Batch holds information for sending rows batch

func NewBatch

func NewBatch(rows []Vector) *Batch

NewBatch creates new batch

func (*Batch) Rows

func (b *Batch) Rows() []Vector

type Buffer

type Buffer interface {
	Write(Vector)
	Read() []Vector
	Len() int
	Flush()
}

Buffer it is the interface for creating a data buffer (temporary storage). It is enough to implement this interface so that you can use your own temporary storage

type Clickhouse

type Clickhouse interface {
	Insert(context.Context, View, []Vector) (uint64, error)
	Close() error
}

type Client

type Client interface {
	// Options returns the options associated with client
	Options() *Options
	// WriteBatch method of sending data to Clickhouse is used implicitly in a non - blocking record,
	// and explicitly in a blocking record
	WriteBatch(context.Context, View, *Batch) error
	// Writer returns the asynchronous, non-blocking, Writer client.
	// Ensures using a single Writer instance for each table pair.
	Writer(View, Buffer) Writer
	// WriterBlocking returns the synchronous, blocking, WriterBlocking client.
	// Ensures using a single WriterBlocking instance for each table pair.
	WriterBlocking(View) WriterBlocking
	// RetryClient Get retry client
	RetryClient() Retryable
	// Close ensures all ongoing asynchronous write clients finish.
	Close()
}

func NewClient

func NewClient(ctx context.Context, clickhouse Clickhouse) Client

func NewClientWithOptions

func NewClientWithOptions(ctx context.Context, clickhouse Clickhouse, options *Options) Client

type Closable

type Closable interface {
	Close() error
	CloseMessage() string
}

type Countable

type Countable interface {
	Inc() uint64
	Dec() uint64
	Val() uint64
}

type Logger

type Logger interface {
	Log(message interface{})
	Logf(format string, v ...interface{})
}

func NewDefaultLogger

func NewDefaultLogger() Logger

type Options

type Options struct {
	// contains filtered or unexported fields
}

Options holds write configuration properties

func DefaultOptions

func DefaultOptions() *Options

DefaultOptions returns Options object with default values

func (*Options) BatchSize

func (o *Options) BatchSize() uint

BatchSize returns size of batch

func (*Options) FlushInterval

func (o *Options) FlushInterval() uint

FlushInterval returns flush interval in ms

func (*Options) SetBatchSize

func (o *Options) SetBatchSize(batchSize uint) *Options

SetBatchSize sets number of rows sent in single request

func (*Options) SetDebugMode

func (o *Options) SetDebugMode(isDebug bool) *Options

func (*Options) SetFlushInterval

func (o *Options) SetFlushInterval(flushIntervalMs uint) *Options

SetFlushInterval sets flush interval in ms in which is buffer flushed if it has not been already written

func (*Options) SetLogger

func (o *Options) SetLogger(logger Logger) *Options

func (*Options) SetQueueEngine

func (o *Options) SetQueueEngine(queue Queueable) *Options

func (*Options) SetRetryIsEnabled

func (o *Options) SetRetryIsEnabled(enabled bool) *Options

type Queueable

type Queueable interface {
	Queue(packet *RetryPacket)
	Retries() <-chan *RetryPacket
}

func NewImMemoryQueueEngine

func NewImMemoryQueueEngine() Queueable

type RetryPacket

type RetryPacket struct {
	// contains filtered or unexported fields
}

func NewRetryPacket

func NewRetryPacket(view View, batch *Batch) *RetryPacket

type Retryable

type Retryable interface {
	Retry(packet *RetryPacket)
	Metrics() (uint64, uint64, uint64)
}

func NewRetry

func NewRetry(ctx context.Context, engine Queueable, writer Writeable, logger Logger, isDebug bool) Retryable

type Vector

type Vector []interface{}

func (Vector) Encode

func (rw Vector) Encode() ([]byte, error)

Encode turns the Vector type into an array of bytes. This method is used for data serialization and storage in remote buffers, such as redis.Buffer

type VectorDecoded

type VectorDecoded string

func (VectorDecoded) Decode

func (rd VectorDecoded) Decode() (Vector, error)

Decode This method is required to reverse deserialize an array of bytes in a Vector type

type Vectorable

type Vectorable interface {
	Row() Vector
}

Vectorable interface is an assistant in the correct formation of the order of fields in the data before sending it to Clickhouse

type View

type View struct {
	Name    string
	Columns []string
}

func NewView

func NewView(name string, columns []string) View

type Writeable

type Writeable interface {
	Write(ctx context.Context, view View, batch *Batch) (uint64, error)
}

func NewDefaultWriter

func NewDefaultWriter(conn Clickhouse) Writeable

type Writer

type Writer interface {
	// WriteRow writes asynchronously line protocol record into bucket.
	WriteRow(vector Vectorable)
	// Errors returns a channel for reading errors which occurs during async writes.
	Errors() <-chan error
	// Close writer
	Close()
}

Writer is client interface with non-blocking methods for writing rows asynchronously in batches into an Clickhouse server. Writer can be used concurrently. When using multiple goroutines for writing, use a single WriteAPI instance in all goroutines.

func NewWriter

func NewWriter(ctx context.Context, client Client, view View, engine Buffer) Writer

NewWriter returns new non-blocking write client for writing rows to Clickhouse table

type WriterBlocking

type WriterBlocking interface {
	// WriteRow writes row(s) into bucket.
	// WriteRow writes without implicit batching. Batch is created from given number of records
	// Non-blocking alternative is available in the Writer interface
	WriteRow(ctx context.Context, row ...Vectorable) error
}

func NewWriterBlocking

func NewWriterBlocking(client Client, view View) WriterBlocking

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL