clickhouseinfra

package

v0.1.2 Latest Latest Go to latest Published: Apr 25, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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

This section is empty.

This section is empty.

func GetClickHouseAsConn(container *chmodule.ClickHouseContainer) (clickhouse.Conn, error)

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

func GetClickhouseAsDB(ctx context.Context, container *chmodule.ClickHouseContainer) (*sql.DB, error)

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

func StartZooKeeperContainer(ctx context.Context) (testcontainers.Container, string, error)

StartZooKeeperContainer function starts a zookeeper container. The caller is responsible for terminating the container.

type ColInfo struct {
	Name    string
	Type    string
	Comment string
}

ColInfo is a struct that holds the column meta information.

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

GetCurrentCols returns the current columns of the table.

type Container struct {
	*chmodule.ClickHouseContainer
	ZooKeeperContainer testcontainers.Container
}

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

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 (c *Container) Terminate(ctx context.Context)

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