clickhouseinfra

Documentation

Overview

Package clickhouseinfra provides a set of functions to interact with ClickHouse containers.

Index

• Constants
• func WithCerts(caCert, clientCerts *tlscert.Certificate) testcontainers.CustomizeRequestOption
• type ColInfo
  • func GetCurrentCols(ctx context.Context, chConn clickhouse.Conn, tableName string) ([]ColInfo, error)
• type Container
  • func CreateClickHouseContainer(ctx context.Context, userName, password string) (*Container, error)
  • func (c *Container) ConnectionHost(ctx context.Context) (string, error)
  • func (c *Container) GetClickHouseAsConn() (clickhouse.Conn, error)
  • func (c *Container) GetClickhouseAsDB(ctx context.Context) (*sql.DB, error)
  • func (c *Container) Terminate(ctx context.Context)

Constants

const (
	SecureNativePort = nat.Port("9440/tcp")
)

Functions

func WithCerts

func WithCerts(caCert, clientCerts *tlscert.Certificate) testcontainers.CustomizeRequestOption

WithCerts is a customize request option that adds the certificates to the clickhouse container.

Types

type ColInfo

type ColInfo struct {
	Name    string
	Type    string
	Comment string
}

ColInfo is a struct that holds the column meta information.

func GetCurrentCols

func GetCurrentCols(ctx context.Context, chConn clickhouse.Conn, tableName string) ([]ColInfo, error)

GetCurrentCols returns the current columns of the table.

type Container

type Container struct {
	*chmodule.ClickHouseContainer
	RootCAs *x509.CertPool
}

Container is a struct that holds the clickhouse and zookeeper containers.

func CreateClickHouseContainer

func CreateClickHouseContainer(ctx context.Context, userName, password string) (*Container, error)

CreateClickHouseContainer function starts and testcontainer for clickhouse. The caller is responsible for terminating the container.

func (*Container) ConnectionHost

func (c *Container) ConnectionHost(ctx context.Context) (string, error)

ConnectionHost returns the host and port of the clickhouse container, using the default, native 9000 port, and obtaining the host and exposed port from the container

func (*Container) GetClickHouseAsConn

func (c *Container) GetClickHouseAsConn() (clickhouse.Conn, error)

GetClickHouseAsConn function returns a clickhouse.Conn connection which uses native ClickHouse protocol.

func (*Container) GetClickhouseAsDB

func (c *Container) GetClickhouseAsDB(ctx context.Context) (*sql.DB, error)

GetClickhouseAsDB function returns a sql.DB connection which allows interfaceing with the stdlib database/sql package.

func (*Container) Terminate

func (c *Container) Terminate(ctx context.Context)

Terminate function terminates the clickhouse containers. If an error occurs, it will be printed to stderr.