clickhouse

Documentation

Overview

Package clickhouse provides a framework-level ClickHouse connection helper following the Optional-init pattern established by pkg/broker/kafka.

Usage:

conn, err := clickhouse.NewConnOptional(ctx, cfg, logger)
if err != nil {
    // configured but failed to connect — fail-fast or degrade
}
if conn == nil {
    // not configured — handle gracefully
}
defer conn.Close()

Index

• func NewConnOptional(ctx context.Context, cfg *conf.Data, l logger.Logger) (driver.Conn, error)

Functions

func NewConnOptional

func NewConnOptional(ctx context.Context, cfg *conf.Data, l logger.Logger) (driver.Conn, error)

NewConnOptional opens a ClickHouse connection from the Data config.

Return semantics:

• (nil, nil) — ClickHouse is not configured (Data.ClickHouse absent or no addrs).
• (nil, err) — configured but connection/ping failed; callers can fail-fast or degrade.
• (conn, nil) — connected successfully.

The caller is responsible for closing the connection via conn.Close().