clickhouse

Documentation

Index

• Variables
• func HandleError(w http.ResponseWriter, err error)
• func NewErrDataParse(err string, data string) error
• func NewErrorWithCode(err string, code int) error
• func Post(ctx context.Context, dsn string, query string, postBody io.Reader, ...) ([]byte, error)
• func PostGzip(ctx context.Context, dsn string, query string, postBody io.Reader, ...) ([]byte, error)
• func Query(ctx context.Context, dsn string, query string, opts Options, ...) ([]byte, error)
• func ReadUvarint(array []byte) (uint64, int, error)
• func Reader(ctx context.Context, dsn string, query string, opts Options, ...) (io.ReadCloser, error)
• type Column
  • func (c *Column) String() string
• type ErrDataParse
  • func (e *ErrDataParse) Error() string
  • func (e *ErrDataParse) PrependDescription(test string)
• type ErrorWithCode
  • func (e *ErrorWithCode) Error() string
• type ExternalData
  • func NewExternalData(tables ...ExternalTable) *ExternalData
  • func (e *ExternalData) SetDebug(debugDir string, perm os.FileMode)
• type ExternalTable
• type Options
• type TestHandler
  • func (h *TestHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type TestRequest
• type TestServer
  • func NewTestServer() *TestServer
  • func (srv *TestServer) Requests() []TestRequest

Variables

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

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)

func NewErrDataParse

func NewErrDataParse(err string, data string) error

func NewErrorWithCode

func NewErrorWithCode(err string, code int) error

func Post

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

func PostGzip

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

func Query

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

func ReadUvarint

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

func Reader

func Reader(ctx context.Context, dsn string, query string, opts Options, extData *ExternalData) (io.ReadCloser, 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 ErrDataParse

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

func (*ErrDataParse) Error

func (e *ErrDataParse) Error() string

func (*ErrDataParse) PrependDescription

func (e *ErrDataParse) PrependDescription(test string)

type ErrorWithCode

type ErrorWithCode struct {
	Code int // error code
	// contains filtered or unexported fields
}

func (*ErrorWithCode) Error

func (e *ErrorWithCode) Error() 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 Options

type Options struct {
	Timeout        time.Duration
	ConnectTimeout time.Duration
}

type TestHandler

type TestHandler struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*TestHandler) ServeHTTP

func (h *TestHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type TestRequest

type TestRequest struct {
	Query []byte
}

type TestServer

type TestServer struct {
	*httptest.Server
	// contains filtered or unexported fields
}

func NewTestServer

func NewTestServer() *TestServer

func (*TestServer) Requests

func (srv *TestServer) Requests() []TestRequest