clickhouse

Documentation

Index

• Variables
• func HandleError(w http.ResponseWriter, err error) (status int, queueFail bool)
• func NewErrWithDescr(err string, data string) error
• func Post(ctx context.Context, dsn string, query string, postBody io.Reader, ...) ([]byte, int64, int64, error)
• func PostGzip(ctx context.Context, dsn string, query string, postBody io.Reader, ...) ([]byte, int64, int64, error)
• func PostWithEncoding(ctx context.Context, dsn string, query string, postBody io.Reader, ...) ([]byte, int64, int64, error)
• func Query(ctx context.Context, dsn string, query string, opts Options, ...) ([]byte, int64, int64, error)
• func ReadUvarint(array []byte) (uint64, int, error)
• type Column
  • func (c *Column) String() string
• type ContentEncoding
• type ErrWithDescr
  • func (e *ErrWithDescr) Error() string
  • func (e *ErrWithDescr) PrependDescription(test string)
• type ExternalData
  • func NewExternalData(tables ...ExternalTable) *ExternalData
  • func (e *ExternalData) SetDebug(debugDir string, perm os.FileMode)
• type ExternalTable
• type LoggedReader
  • func Reader(ctx context.Context, dsn string, query string, opts Options, ...) (*LoggedReader, error)
  • func (r *LoggedReader) ChReadBytes() int64
  • func (r *LoggedReader) ChReadRows() int64
  • func (r *LoggedReader) Close() error
  • func (r *LoggedReader) Read(p []byte) (int, error)
• type Options

Variables

var ErrClickHouseResponse = errors.New("Malformed response from clickhouse")

var ErrInvalidTimeRange = errors.New("Invalid or empty time range")

var ErrUvarintOverflow = errors.New("ReadUvarint: varint overflows a 64-bit integer")

var ErrUvarintRead = errors.New("ReadUvarint: Malformed array")

Functions

func HandleError

func HandleError(w http.ResponseWriter, err error) (status int, queueFail bool)

func NewErrWithDescr

func NewErrWithDescr(err string, data string) error

func Post

func Post(ctx context.Context, dsn string, query string, postBody io.Reader, opts Options, extData *ExternalData) ([]byte, int64, int64, error)

func PostGzip

func PostGzip(ctx context.Context, dsn string, query string, postBody io.Reader, opts Options, extData *ExternalData) ([]byte, int64, int64, error)

Deprecated: use PostWithEncoding instead

func PostWithEncoding

func PostWithEncoding(ctx context.Context, dsn string, query string, postBody io.Reader, encoding ContentEncoding, opts Options, extData *ExternalData) ([]byte, int64, int64, error)

func Query

func Query(ctx context.Context, dsn string, query string, opts Options, extData *ExternalData) ([]byte, int64, int64, error)

func ReadUvarint

func ReadUvarint(array []byte) (uint64, int, error)

Types

type Column

type Column struct {
	Name string
	// ClickHouse data type
	Type string
}

Column is a pair of Name and Type for temporary table structure

func (*Column) String

func (c *Column) String() string

type ContentEncoding

type ContentEncoding string

const (
	ContentEncodingNone ContentEncoding = "none"
	ContentEncodingGzip ContentEncoding = "gzip"
	ContentEncodingZstd ContentEncoding = "zstd"
)

type ErrWithDescr

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

func (*ErrWithDescr) Error

func (e *ErrWithDescr) Error() string

func (*ErrWithDescr) PrependDescription

func (e *ErrWithDescr) PrependDescription(test string)

type ExternalData

type ExternalData struct {
	Tables []ExternalTable
	// contains filtered or unexported fields
}

ExternalData is a type to use ClickHouse external data feature. You could use it to pass multiple temporary tables for a query.

func NewExternalData

func NewExternalData(tables ...ExternalTable) *ExternalData

NewExternalData returns the `*ExternalData` object for `tables`

func (*ExternalData) SetDebug

func (e *ExternalData) SetDebug(debugDir string, perm os.FileMode)

SetDebug sets the directory and file permission for an external table data dump. Works only if both `debugDir` and `perm` are set

type ExternalTable

type ExternalTable struct {
	// Table name
	Name    string
	Columns []Column
	// ClickHouse input/output format
	Format string
	Data   []byte
}

ExternalTable is a structure to use ClickHouse feature that creates a temporary table for a query

type LoggedReader

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

func Reader

func Reader(ctx context.Context, dsn string, query string, opts Options, extData *ExternalData) (*LoggedReader, error)

func (*LoggedReader) ChReadBytes

func (r *LoggedReader) ChReadBytes() int64

func (*LoggedReader) ChReadRows

func (r *LoggedReader) ChReadRows() int64

func (*LoggedReader) Close

func (r *LoggedReader) Close() error

func (*LoggedReader) Read

func (r *LoggedReader) Read(p []byte) (int, error)

type Options

type Options struct {
	TLSConfig      *tls.Config
	Timeout        time.Duration
	ConnectTimeout time.Duration
}