proto

Documentation

Index

• Constants
• type Block
  • func (b *Block) AddColumn(name string, ct column.Type) error
  • func (b *Block) Append(v ...interface{}) (err error)
  • func (b *Block) ColumnsNames() []string
  • func (b *Block) Decode(reader *proto.Reader, revision uint64) (err error)
  • func (b *Block) Encode(buffer *proto.Buffer, revision uint64) error
  • func (b *Block) Reset()
  • func (b *Block) Rows() int
• type BlockError
  • func (e *BlockError) Error() string
• type ClientHandshake
  • func (ClientHandshake) Encode(buffer *chproto.Buffer)
  • func (ClientHandshake) String() string
• type Exception
  • func (e *Exception) Decode(reader *proto.Reader) (err error)
  • func (e *Exception) Error() string
• type ProfileInfo
  • func (p *ProfileInfo) Decode(reader *chproto.Reader, revision uint64) (err error)
  • func (p *ProfileInfo) String() string
• type Progress
  • func (p *Progress) Decode(reader *chproto.Reader, revision uint64) (err error)
  • func (p *Progress) String() string
• type Query
  • func (q *Query) Encode(buffer *chproto.Buffer, revision uint64) error
• type ServerHandshake
  • func (srv *ServerHandshake) Decode(reader *chproto.Reader) (err error)
  • func (srv ServerHandshake) String() string
• type Setting
• type Settings
  • func (s Settings) Encode(buffer *chproto.Buffer, revision uint64) error
• type TableColumns
  • func (t *TableColumns) Decode(reader *chproto.Reader, revision uint64) (err error)
  • func (t *TableColumns) String() string

Constants

const (
	DBMS_MIN_REVISION_WITH_CLIENT_INFO                        = 54032
	DBMS_MIN_REVISION_WITH_SERVER_TIMEZONE                    = 54058
	DBMS_MIN_REVISION_WITH_QUOTA_KEY_IN_CLIENT_INFO           = 54060
	DBMS_MIN_REVISION_WITH_SERVER_DISPLAY_NAME                = 54372
	DBMS_MIN_REVISION_WITH_VERSION_PATCH                      = 54401
	DBMS_MIN_REVISION_WITH_CLIENT_WRITE_INFO                  = 54420
	DBMS_MIN_REVISION_WITH_SETTINGS_SERIALIZED_AS_STRINGS     = 54429
	DBMS_MIN_REVISION_WITH_INTERSERVER_SECRET                 = 54441
	DBMS_MIN_REVISION_WITH_OPENTELEMETRY                      = 54442
	DBMS_MIN_PROTOCOL_VERSION_WITH_DISTRIBUTED_DEPTH          = 54448
	DBMS_MIN_PROTOCOL_VERSION_WITH_INITIAL_QUERY_START_TIME   = 54449
	DBMS_MIN_PROTOCOL_VERSION_WITH_INCREMENTAL_PROFILE_EVENTS = 54451
	DBMS_MIN_REVISION_WITH_PARALLEL_REPLICAS                  = 54453
	DBMS_TCP_PROTOCOL_VERSION                                 = DBMS_MIN_REVISION_WITH_PARALLEL_REPLICAS
)

see https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/Protocol.h

const (
	ClientHello  = 0
	ClientQuery  = 1
	ClientData   = 2
	ClientCancel = 3
	ClientPing   = 4
)

const (
	ClientQueryNone      = 0
	ClientQueryInitial   = 1
	ClientQuerySecondary = 2
)

const (
	CompressEnable  uint64 = 1
	CompressDisable uint64 = 0
)

const (
	ServerHello               = 0
	ServerData                = 1
	ServerException           = 2
	ServerProgress            = 3
	ServerPong                = 4
	ServerEndOfStream         = 5
	ServerProfileInfo         = 6
	ServerTotals              = 7
	ServerExtremes            = 8
	ServerTablesStatus        = 9
	ServerLog                 = 10
	ServerTableColumns        = 11
	ServerPartUUIDs           = 12
	ServerReadTaskRequest     = 13
	ServerProfileEvents       = 14
	ServerTreeReadTaskRequest = 15
)

const (
	ClientVersionMajor       = 2
	ClientVersionMinor       = 3
	ClientTCPProtocolVersion = DBMS_TCP_PROTOCOL_VERSION
)

const ClientName = "Golang SQLDriver"

const (
	StateComplete = 2
)

Types

type Block

type Block struct {
	Packet   byte
	Columns  []column.Interface
	Timezone *time.Location
	// contains filtered or unexported fields
}

func (*Block) AddColumn

func (b *Block) AddColumn(name string, ct column.Type) error

func (*Block) Append

func (b *Block) Append(v ...interface{}) (err error)

func (*Block) ColumnsNames

func (b *Block) ColumnsNames() []string

func (*Block) Decode

func (b *Block) Decode(reader *proto.Reader, revision uint64) (err error)

func (*Block) Encode

func (b *Block) Encode(buffer *proto.Buffer, revision uint64) error

func (*Block) Reset

func (b *Block) Reset()

func (*Block) Rows

func (b *Block) Rows() int

type BlockError

type BlockError struct {
	Op         string
	Err        error
	ColumnName string
}

func (*BlockError) Error

func (e *BlockError) Error() string

type ClientHandshake

type ClientHandshake struct{}

func (ClientHandshake) Encode

func (ClientHandshake) Encode(buffer *chproto.Buffer)

func (ClientHandshake) String

func (ClientHandshake) String() string

type Exception

type Exception struct {
	Code       int32
	Name       string
	Message    string
	StackTrace string
	Nested     []Exception
	// contains filtered or unexported fields
}

func (*Exception) Decode

func (e *Exception) Decode(reader *proto.Reader) (err error)

func (*Exception) Error

func (e *Exception) Error() string

type ProfileInfo

type ProfileInfo struct {
	Rows                      uint64
	Bytes                     uint64
	Blocks                    uint64
	AppliedLimit              bool
	RowsBeforeLimit           uint64
	CalculatedRowsBeforeLimit bool
}

func (*ProfileInfo) Decode

func (p *ProfileInfo) Decode(reader *chproto.Reader, revision uint64) (err error)

func (*ProfileInfo) String

func (p *ProfileInfo) String() string

type Progress

type Progress struct {
	Rows       uint64
	Bytes      uint64
	TotalRows  uint64
	WroteRows  uint64
	WroteBytes uint64
	// contains filtered or unexported fields
}

func (*Progress) Decode

func (p *Progress) Decode(reader *chproto.Reader, revision uint64) (err error)

func (*Progress) String

func (p *Progress) String() string

type Query

type Query struct {
	ID             string
	Span           trace.SpanContext
	Body           string
	QuotaKey       string
	Settings       Settings
	Compression    bool
	InitialUser    string
	InitialAddress string
}

func (*Query) Encode

func (q *Query) Encode(buffer *chproto.Buffer, revision uint64) error

type ServerHandshake

type ServerHandshake struct {
	Name        string
	DisplayName string
	Revision    uint64
	Version     struct {
		Major uint64
		Minor uint64
		Patch uint64
	}
	Timezone *time.Location
}

func (*ServerHandshake) Decode

func (srv *ServerHandshake) Decode(reader *chproto.Reader) (err error)

func (ServerHandshake) String

func (srv ServerHandshake) String() string

type Setting

type Setting struct {
	Key   string
	Value interface{}
}

type Settings

type Settings []Setting

func (Settings) Encode

func (s Settings) Encode(buffer *chproto.Buffer, revision uint64) error

type TableColumns

type TableColumns struct {
	First  string
	Second string
}

func (*TableColumns) Decode

func (t *TableColumns) Decode(reader *chproto.Reader, revision uint64) (err error)

func (*TableColumns) String

func (t *TableColumns) String() string