Golang SQL database driver for Yandex ClickHouse. Supported by Kinescope.
Key features
database/sqldatabase/sqlbegin->prepare->(in loop exec)->commit
Context
- Query ID
- Quota Key
- Settings
- OpenTelemetry
- Execution events:
- Logs
- Progress
- Profile info
- Profile events
OpenDB
conn := clickhouse.OpenDB(&clickhouse.Options{ Addr: []string{"127.0.0.1:9999"}, Auth: clickhouse.Auth{ Database: "default", Username: "default", Password: "", }, TLS: &tls.Config{ InsecureSkipVerify: true, }, Settings: clickhouse.Settings{ "max_execution_time": 60, }, DialTimeout: 5 * time.Second, Compression: &clickhouse.Compression{ clickhouse.CompressionLZ4, }, Debug: true, }) conn.SetMaxIdleConns(5) conn.SetMaxOpenConns(10) conn.SetConnMaxLifetime(time.Hour)
DSN
- hosts - comma-separated list of single address hosts for load-balancing and failover
- username/password - auth credentials
- database - select the current default database
- dial_timeout - a duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix such as "300ms", "1s". Valid time units are "ms", "s", "m".
- connection_open_strategy - random/in_order (default random).
- round-robin - choose a round-robin server from the set
- in_order - first live server is chosen in specified order
- debug - enable debug output (boolean value)
- compress - enable lz4 compression (boolean value)
SSL/TLS parameters:
- secure - establish secure connection (default is false)
- skip_verify - skip certificate verification (default is false)
Example:
clickhouse://username:password@host1:9000,host2:9000/database?dial_timeout=200ms&max_execution_time=60
Benchmark
1.218s | 924.390ms | 675.721ms |
1.899s | 1.177s | 699.203ms | 661.973ms |
Install
go get -u github.com/ClickHouse/clickhouse-go/v2
Examples
native interface
package main import ( "context" "fmt" "log" "time" "github.com/ClickHouse/clickhouse-go/v2" ) func example() error { conn, err := clickhouse.Open(&clickhouse.Options{ Addr: []string{"127.0.0.1:9000"}, Auth: clickhouse.Auth{ Database: "default", Username: "default", Password: "", }, //Debug: true, DialTimeout: time.Second, MaxOpenConns: 10, MaxIdleConns: 5, ConnMaxLifetime: time.Hour, Compression: &clickhouse.Compression{ Method: clickhouse.CompressionLZ4, }, Settings: clickhouse.Settings{ "max_execution_time": 60, }, }) if err != nil { return err } ctx := clickhouse.Context(context.Background(), clickhouse.WithSettings(clickhouse.Settings{ "max_block_size": 10, }), clickhouse.WithProgress(func(p *clickhouse.Progress) { fmt.Println("progress: ", p) })) if err := conn.Ping(ctx); err != nil { if exception, ok := err.(*clickhouse.Exception); ok { fmt.Printf("Catch exception [%d] %s \n%s\n", exception.Code, exception.Message, exception.StackTrace) } return err } if err := conn.Exec(ctx, `DROP TABLE IF EXISTS example`); err != nil { return err } err = conn.Exec(ctx, ` CREATE TABLE IF NOT EXISTS example ( Col1 UInt8, Col2 String, Col3 DateTime ) engine=Memory `) if err != nil { return err } batch, err := conn.PrepareBatch(ctx, "INSERT INTO example (Col1, Col2, Col3)") if err != nil { return err } for i := 0; i < 10; i++ { if err := batch.Append(uint8(i), fmt.Sprintf("value_%d", i), time.Now()); err != nil { return err } } if err := batch.Send(); err != nil { return err } rows, err := conn.Query(ctx, "SELECT Col1, Col2, Col3 FROM example WHERE Col1 >= $1 AND Col2 <> $2 AND Col3 <= $3", 0, "xxx", time.Now()) if err != nil { return err } for rows.Next() { var ( col1 uint8 col2 string col3 time.Time ) if err := rows.Scan(&col1, &col2, &col3); err != nil { return err } fmt.Printf("row: col1=%d, col2=%s, col3=%s\n", col1, col2, col3) } rows.Close() return rows.Err() } func main() { if err := example(); err != nil { log.Fatal(err) } }
database/sql
package main import ( "context" "database/sql" "fmt" "log" "time" "github.com/ClickHouse/clickhouse-go/v2" ) func example() error { conn, err := sql.Open("clickhouse", "clickhouse://127.0.0.1:9000?dial_timeout=1s&compress=true&max_execution_time=60") if err != nil { return err } conn.SetMaxIdleConns(5) conn.SetMaxOpenConns(10) conn.SetConnMaxLifetime(time.Hour) ctx := clickhouse.Context(context.Background(), clickhouse.WithSettings(clickhouse.Settings{ "max_block_size": 10, }), clickhouse.WithProgress(func(p *clickhouse.Progress) { fmt.Println("progress: ", p) })) if err := conn.PingContext(ctx); err != nil { if exception, ok := err.(*clickhouse.Exception); ok { fmt.Printf("Catch exception [%d] %s \n%s\n", exception.Code, exception.Message, exception.StackTrace) } return err } if _, err := conn.ExecContext(ctx, `DROP TABLE IF EXISTS example`); err != nil { return err } _, err = conn.ExecContext(ctx, ` CREATE TABLE IF NOT EXISTS example ( Col1 UInt8, Col2 String, Col3 DateTime ) engine=Memory `) if err != nil { return err } scope, err := conn.Begin() if err != nil { return err } { batch, err := scope.PrepareContext(ctx, "INSERT INTO example (Col1, Col2, Col3)") if err != nil { return err } for i := 0; i < 10; i++ { if _, err := batch.Exec(uint8(i), fmt.Sprintf("value_%d", i), time.Now()); err != nil { return err } } } if err := scope.Commit(); err != nil { return err } rows, err := conn.QueryContext(ctx, "SELECT Col1, Col2, Col3 FROM example WHERE Col1 >= $1 AND Col2 <> $2", 0, "xxx") if err != nil { return err } for rows.Next() { var ( col1 uint8 col2 string col3 time.Time ) if err := rows.Scan(&col1, &col2, &col3); err != nil { return err } fmt.Printf("row: col1=%d, col2=%s, col3=%s\n", col1, col2, col3) } rows.Close() return rows.Err() } func main() { if err := example(); err != nil { log.Fatal(err) } }