ch

package module
v0.5.1 Latest Latest
Warning

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

 Go to latest Published: Dec 23, 2021 License: Apache-2.0 Imports: 17 Imported by: 0

README

ch experimental

TCP ClickHouse client in Go. Designed for very fast data streaming with low network, cpu and memory overhead.

Work in progress, please leave feedback on package API or features.

go get github.com/go-faster/ch

Example

package main

import (
  "context"
  "fmt"

  "github.com/go-faster/ch"
  "github.com/go-faster/ch/proto"
)

func main() {
  ctx := context.Background()
  c, err := ch.Dial(ctx, "localhost:9000", ch.Options{})
  if err != nil {
    panic(err)
  }
  var (
    numbers int
    data    proto.ColUInt64
  )
  if err := c.Query(ctx, ch.Query{
    Body: "SELECT number FROM system.numbers LIMIT 500000000",
    OnResult: func(ctx context.Context, b proto.Block) error {
      numbers += len(data)
      return nil
    },
    Result: proto.Results{
      {Name: "number", Data: &data},
    },
  }); err != nil {
    panic(err)
  }
  fmt.Println("numbers:", numbers)
}

750ms 0.5B rows  4GB 5.3GB/s 1 job
 1.3s 2.5B rows 20GB  15GB/s 5 jobs
Results
Automatic result inference
var result proto.Results
q := ch.Query{
  Body:   "SELECT * FROM table",
  Result: result.Auto(),
}
Single result with column name inference
var res proto.ColBool
q := ch.Query{
  Body:   "SELECT v FROM test_table",
  Result: proto.ResultColumn{Data: &res},
}

Features

  • OpenTelemetry support
  • No reflection or interface{}
  • Generics (go1.18) for ArrayOf[T], LowCardinaliyOf[T], EnumOf[T]
  • Column-first design
    • Dramatically more efficient
    • Up to 50x faster than row-first design around sql
    • Up to 500x faster than HTTP API
    • Low memory overhead (column blocks are slices, i.e. continuous memory)
    • Highly efficient input and output streaming
    • As close to ClickHouse as possible
  • Structured query execution telemetry streaming
  • LZ4, ZSTD or None (just checksums) compression
  • External data support
  • Rigorously tested
    • ARM64, Windows, Mac, Linux (also x86)
    • Unit tests for encoding and decoding
      • ClickHouse Server in Go for faster tests
      • Golden files for all packets, columns
      • Both server and client structures
      • Ensuring that partial read leads to failure
    • End-to-end tests
      • 21.8.11.4-lts
      • 21.9.6.24-stable
      • 21.10.4.26-stable
      • 21.11.4.14-stable
      • 21.11.7.9-stable
      • 21.12.2.17-stable
    • Fuzzing

Supported types

  • UInt8, UInt16, UInt32, UInt64, UInt128, UInt256
  • Int8, Int16, Int32, Int64, Int128, Int256
  • Date, Date32, DateTime, DateTime64
  • Decimal32, Decimal64, Decimal128, Decimal256
  • IPv4, IPv6
  • String, FixedString(N)
  • UUID
  • Array(T)
  • Enum8, Enum16
  • LowCardinality(T)
  • Map(K, V)
  • Bool
  • Tuple(T1, T2, ..., Tn)
  • Nullable(T)

TODO

  • Pooling
  • API UX Improvements (with 1.18 generics?)
    • Enum
    • LowCardinality
    • Array(T)
    • FixedString(N)
    • Map(K, V)
    • Decimal(P, S)
    • Nullable(T)
    • Tuple?
  • Code generation from DDL
    • Parser
    • Code generator for SELECT/INSERT
    • Query builder
  • DSL for DDL
  • Reading and writing Native format dumps

Reference

License

Apache License 2.0

Documentation

Overview

Package ch implements ClickHouse client.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CompressionStrings 

func CompressionStrings() []string

CompressionStrings returns a slice of all String values of the enum

func IsErr 

func IsErr(err error, codes ...proto.Error) bool

IsErr reports whether err is error with provided exception codes.

func IsException 

func IsException(err error) bool

IsException reports whether err is Exception.

func ProfileEventTypeStrings added in v0.5.0 

func ProfileEventTypeStrings() []string

ProfileEventTypeStrings returns a slice of all String values of the enum

Types

type Client 

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

Client implements ClickHouse binary protocol client on top of single TCP connection.

func Connect 

func Connect(ctx context.Context, conn net.Conn, opt Options) (*Client, error)

Connect performs handshake with ClickHouse server and initializes application level connection.

func Dial 

func Dial(ctx context.Context, addr string, opt Options) (*Client, error)

Dial dials requested address and establishes TCP connection to ClickHouse server, performing handshake.

func (*Client) Close 

func (c *Client) Close() error

Close closes underlying connection and frees all resources, rendering Client to unusable state.

func (*Client) Location 

func (c *Client) Location() *time.Location

Location returns current server timezone.

func (*Client) Ping 

func (c *Client) Ping(ctx context.Context) error

func (*Client) Query 

func (c *Client) Query(ctx context.Context, q Query) error

Query performs Query on ClickHouse server.

type Compression 

type Compression byte

Compression setting.

Trade bandwidth for CPU. 

const (
	// CompressionDisabled disables compression. Lowest CPU overhead.
	CompressionDisabled Compression = iota
	// CompressionLZ4 enables LZ4 compression for data. Medium CPU overhead.
	CompressionLZ4
	// CompressionZSTD enables ZStandard compression. High CPU overhead.
	CompressionZSTD
	// CompressionNone uses no compression but data has checksums.
	CompressionNone
)

func CompressionString 

func CompressionString(s string) (Compression, error)

CompressionString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func CompressionValues 

func CompressionValues() []Compression

CompressionValues returns all values of the enum

func (Compression) IsACompression 

func (i Compression) IsACompression() bool

IsACompression returns "true" if the value is listed in the enum definition. "false" otherwise

func (Compression) String 

func (i Compression) String() string

type CorruptedDataErr added in v0.5.0 

type CorruptedDataErr struct {
	Actual    city.U128
	Reference city.U128
	RawSize   int
	DataSize  int
}

CorruptedDataErr means that provided hash mismatch with calculated.

func (*CorruptedDataErr) Error added in v0.5.0 

func (c *CorruptedDataErr) Error() string

type Exception 

type Exception struct {
	Code    proto.Error
	Name    string
	Message string
	Stack   string
	Next    []Exception // non-nil only for top exception
}

Exception is server-side error.

func AsException 

func AsException(err error) (*Exception, bool)

AsException finds first *Exception in err chain.

func (*Exception) Error 

func (e *Exception) Error() string

func (*Exception) IsCode 

func (e *Exception) IsCode(codes ...proto.Error) bool

type Log added in v0.4.0 

type Log struct {
	Time     time.Time
	Host     string
	QueryID  string
	ThreadID uint64
	Priority int8
	Source   string
	Text     string
}

Log from server.

type Options 

type Options struct {
	Logger      *zap.Logger
	Database    string
	User        string
	Password    string
	Settings    []Setting
	Compression Compression
}

Options for Client.

type ProfileEvent added in v0.5.0 

type ProfileEvent struct {
	ThreadID uint64
	Host     string
	Time     time.Time
	Type     ProfileEventType
	Name     string
	Value    int64
}

ProfileEvent is detailed profiling event from Server.

type ProfileEventType added in v0.5.0 

type ProfileEventType byte
const (
	ProfileIncrement ProfileEventType = 1
	ProfileGauge     ProfileEventType = 2
)

func ProfileEventTypeString added in v0.5.0 

func ProfileEventTypeString(s string) (ProfileEventType, error)

ProfileEventTypeString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func ProfileEventTypeValues added in v0.5.0 

func ProfileEventTypeValues() []ProfileEventType

ProfileEventTypeValues returns all values of the enum

func (ProfileEventType) IsAProfileEventType added in v0.5.0 

func (i ProfileEventType) IsAProfileEventType() bool

IsAProfileEventType returns "true" if the value is listed in the enum definition. "false" otherwise

func (ProfileEventType) String added in v0.5.0 

func (i ProfileEventType) String() string

type Query 

type Query struct {
	// Body of query, like "SELECT 1".
	Body string
	// QueryID is ID of query, defaults to new UUIDv4.
	QueryID string
	// QuotaKey of query, optional.
	QuotaKey string

	// Input columns for INSERT operations.
	Input []proto.InputColumn
	// OnInput is called to allow ingesting more data to Input.
	//
	// The io.EOF reports that no more input should be ingested.
	//
	// Optional, single block is ingested from Input if not provided,
	// but query will fail if Input is set but has zero rows.
	OnInput func(ctx context.Context) error

	// Result columns for SELECT operations.
	Result proto.Result
	// OnResult is called when Result is filled with result block.
	//
	// Optional, but query will fail of more than one block is received
	// and no OnResult is provided.
	OnResult func(ctx context.Context, block proto.Block) error

	// OnProgress is optional progress handler. The progress value contain
	// difference, so progress should be accumulated if needed.
	OnProgress func(ctx context.Context, p proto.Progress) error
	// OnProfile is optional handler for profiling data.
	OnProfile func(ctx context.Context, p proto.Profile) error
	// OnProfileEvent is optional handler for profiling event stream data.
	OnProfileEvent func(ctx context.Context, e ProfileEvent) error
	// OnLog is optional handler for server log entry.
	OnLog func(ctx context.Context, l Log) error

	// Settings are optional query-scoped settings. Can override client settings.
	Settings []Setting

	// ExternalData is optional data for server to load.
	//
	// https://clickhouse.com/docs/en/engines/table-engines/special/external-data/
	ExternalData []proto.InputColumn
	// ExternalTable name. Defaults to _data.
	ExternalTable string
}

Query to ClickHouse.

type Server added in v0.4.0 

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

Server is basic ClickHouse server.

func NewServer added in v0.4.0 

func NewServer(opt ServerOptions) *Server

NewServer returns new ClickHouse Server.

func (*Server) Serve added in v0.4.0 

func (s *Server) Serve(ln net.Listener) error

Serve connections on net.Listener.

type ServerConn added in v0.4.0 

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

ServerConn wraps Server connection.

func (*ServerConn) Handle added in v0.4.0 

func (c *ServerConn) Handle() error

Handle connection.

type ServerOptions added in v0.4.0 

type ServerOptions struct {
	Logger   *zap.Logger
	Timezone *time.Location
	OnError  func(err error)
}

ServerOptions wraps possible Server configuration.

type Setting 

type Setting struct {
	Key, Value string
	Important  bool
}

Setting to send to server.

Source Files

View all Source files

Directories

Path Synopsis
internal
cht
Package cht implements ClickHouse testing utilities, primarily end to end.
 Package cht implements ClickHouse testing utilities, primarily end to end.
cmd/ch-arr
cmd/ch-bench-numbers
cmd/ch-bench-rnd
cmd/ch-bench-trace-id
cmd/ch-compression
cmd/ch-ex-numbers
cmd/ch-low-cord
cmd/ch-map
cmd/ch-nullable
compress
Package compress implements compression support.
 Package compress implements compression support.
e2e
Package e2e implements end to end testing utilities.
 Package e2e implements end to end testing utilities.
gold
Package gold implements golden files.
 Package gold implements golden files.
Package proto implements ClickHouse wire protocol.
 Package proto implements ClickHouse wire protocol.
cmd/ch-gen-col

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.