Safe Haskell	None
Language	Haskell2010

Database.ClickHouseDriver.Types

Description

Implementation of data types for internal use Most users should import ClickHouseDriver.Core instead.

Documentation

data ServerInfo Source #

Constructors

ServerInfo
Fields name :: !ByteString version_major :: !Word version_minor :: !Word version_patch :: !Word revision :: !Word timezone :: Maybe ByteString display_name :: !ByteString

Instances

Instances details

Show ServerInfo Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> ServerInfo -> ShowS # show :: ServerInfo -> String # showList :: [ServerInfo] -> ShowS #

data TCPConnection Source #

Constructors

TCPConnection

Fields

tcpHost :: !ByteString
host name, default = "localhost"
tcpPort :: !ByteString
port number, default = "8123"
tcpUsername :: !ByteString
username, default = "default"
tcpPassword :: !ByteString
password, dafault = ""
tcpSocket :: !Socket
socket for communication
tcpSockAdrr :: !SockAddr
context :: !Context
server and client informations
tcpCompression :: !Word
should the data be compressed or not. Not applied yet.

Instances

Instances details

Show TCPConnection Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> TCPConnection -> ShowS # show :: TCPConnection -> String # showList :: [TCPConnection] -> ShowS #

getServerInfo :: TCPConnection -> Maybe ServerInfo Source #

getClientInfo :: TCPConnection -> Maybe ClientInfo Source #

getClientSetting :: TCPConnection -> Maybe ClientSetting Source #

data ClientInfo Source #

Constructors

ClientInfo
Fields client_name :: !ByteString interface :: Interface client_version_major :: !Word client_version_minor :: !Word client_version_patch :: !Word client_revision :: !Word initial_user :: !ByteString initial_query_id :: !ByteString initial_address :: !ByteString quota_key :: !ByteString query_kind :: QueryKind

Instances

Instances details

Show ClientInfo Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> ClientInfo -> ShowS # show :: ClientInfo -> String # showList :: [ClientInfo] -> ShowS #

data ClientSetting Source #

Constructors

ClientSetting
Fields insert_block_size :: !Word strings_as_bytes :: !Bool strings_encoding :: !ByteString

Instances

Instances details

Show ClientSetting Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> ClientSetting -> ShowS # show :: ClientSetting -> String # showList :: [ClientSetting] -> ShowS #

data Context Source #

Constructors

Context
Fields client_info :: Maybe ClientInfo server_info :: Maybe ServerInfo client_setting :: Maybe ClientSetting

Instances

Instances details

Show Context Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> Context -> ShowS # show :: Context -> String # showList :: [Context] -> ShowS #

data Interface Source #

Constructors

TCP
HTTP

Instances

Instances details

Eq Interface Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods (==) :: Interface -> Interface -> Bool # (/=) :: Interface -> Interface -> Bool #
Show Interface Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> Interface -> ShowS # show :: Interface -> String # showList :: [Interface] -> ShowS #

data QueryKind Source #

Constructors

NO_QUERY
INITIAL_QUERY
SECOND_QUERY

Instances

Instances details

Eq QueryKind Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods (==) :: QueryKind -> QueryKind -> Bool # (/=) :: QueryKind -> QueryKind -> Bool #
Show QueryKind Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> QueryKind -> ShowS # show :: QueryKind -> String # showList :: [QueryKind] -> ShowS #

getDefaultClientInfo :: ByteString -> ClientInfo Source #

data Packet Source #

Constructors

Block
Fields queryData :: !Block
Progress
Fields prog :: !Progress
StreamProfileInfo
Fields profile :: !BlockStreamProfileInfo
MultiString !(ByteString, ByteString)
ErrorMessage !String
Hello
EndOfStream

Instances

Instances details

Show Packet Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> Packet -> ShowS # show :: Packet -> String # showList :: [Packet] -> ShowS #

readProgress :: Word -> Reader Progress Source #

readBlockStreamProfileInfo :: Reader BlockStreamProfileInfo Source #

data QueryInfo Source #

Constructors

QueryInfo
Fields profile_info :: !BlockStreamProfileInfo progress :: !Progress elapsed :: !Word

Instances

Instances details

Show QueryInfo Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> QueryInfo -> ShowS # show :: QueryInfo -> String # showList :: [QueryInfo] -> ShowS #
Default QueryInfo Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods def :: QueryInfo #

data Progress Source #

Constructors

Prog
Fields rows :: !Word bytes :: !Word total_rows :: !Word written_rows :: !Word written_bytes :: !Word

Instances

Instances details

Show Progress Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> Progress -> ShowS # show :: Progress -> String # showList :: [Progress] -> ShowS #
Default Progress Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods def :: Progress #

data BlockStreamProfileInfo Source #

Constructors

ProfileInfo
Fields number_rows :: !Word blocks :: !Word number_bytes :: !Word applied_limit :: !Bool rows_before_limit :: !Word calculated_rows_before_limit :: !Bool

Instances

Instances details

Show BlockStreamProfileInfo Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> BlockStreamProfileInfo -> ShowS # show :: BlockStreamProfileInfo -> String # showList :: [BlockStreamProfileInfo] -> ShowS #
Default BlockStreamProfileInfo Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods def :: BlockStreamProfileInfo #

storeElasped :: QueryInfo -> Word -> QueryInfo Source #

storeProfile :: QueryInfo -> BlockStreamProfileInfo -> QueryInfo Source #

storeProgress :: QueryInfo -> Progress -> QueryInfo Source #

defaultProfile :: BlockStreamProfileInfo Source #

defaultProgress :: Progress Source #

defaultQueryInfo :: QueryInfo Source #

data ClickhouseType Source #

Constructors

CKInt8 Int8
CKInt16 Int16
CKInt32 Int32
CKInt64 Int64
CKInt128 Int64 Int64
CKUInt8 Word8
CKUInt16 Word16
CKUInt32 Word32
CKUInt64 Word64
CKUInt128 Word64 Word64
CKString ByteString
CKTuple (Vector ClickhouseType)
CKArray (Vector ClickhouseType)
CKDecimal Float
CKDecimal32 Float
CKDecimal64 Double
CKDecimal128 Double
CKIPv4 (Word8, Word8, Word8, Word8)
CKIPv6 (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16)
CKDate
Fields year :: !Integer month :: !Int day :: !Int
CKNull

Instances

Instances details

Eq ClickhouseType Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods (==) :: ClickhouseType -> ClickhouseType -> Bool # (/=) :: ClickhouseType -> ClickhouseType -> Bool #
Show ClickhouseType Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> ClickhouseType -> ShowS # show :: ClickhouseType -> String # showList :: [ClickhouseType] -> ShowS #

data BlockInfo Source #

Constructors

Info
Fields is_overflows :: !Bool bucket_num :: !Int32

Instances

Instances details

Show BlockInfo Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> BlockInfo -> ShowS # show :: BlockInfo -> String # showList :: [BlockInfo] -> ShowS #

data Block Source #

Constructors

ColumnOrientedBlock
Fields columns_with_type :: Vector (ByteString, ByteString) cdata :: Vector (Vector ClickhouseType) info :: BlockInfo

Instances

Instances details

Show Block Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> Block -> ShowS # show :: Block -> String # showList :: [Block] -> ShowS #

data CKResult Source #

Constructors

CKResult
Fields query_result :: Vector (Vector ClickhouseType) query_info :: !QueryInfo

Instances

Instances details

Show CKResult Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> CKResult -> ShowS # show :: CKResult -> String # showList :: [CKResult] -> ShowS #

writeBlockInfo :: BlockInfo -> Writer Builder Source #

data ConnParams Source #

Constructors

ConnParams
Fields username' :: !ByteString host' :: !ByteString port' :: !ByteString password' :: !ByteString compression' :: !Bool database' :: !ByteString

Instances

Instances details

Show ConnParams Source #
Instance details Defined in Database.ClickHouseDriver.Types Methods showsPrec :: Int -> ConnParams -> ShowS # show :: ConnParams -> String # showList :: [ConnParams] -> ShowS #
Generic ConnParams Source #
Instance details Defined in Database.ClickHouseDriver.Types Associated Types type Rep ConnParams :: Type -> Type # Methods from :: ConnParams -> Rep ConnParams x # to :: Rep ConnParams x -> ConnParams #
Default ConnParams Source #	default connection parameters (settings)
Instance details Defined in Database.ClickHouseDriver.Pool Methods def :: ConnParams #
type Rep ConnParams Source #
Instance details Defined in Database.ClickHouseDriver.Types type Rep ConnParams = D1 ('MetaData "ConnParams" "Database.ClickHouseDriver.Types" "clickhouse-haskell-0.1.2.4-B18bnGfeDaz1rQvIXNLqEj" 'False) (C1 ('MetaCons "ConnParams" 'PrefixI 'True) ((S1 ('MetaSel ('Just "username'") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :: (S1 ('MetaSel ('Just "host'") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :: S1 ('MetaSel ('Just "port'") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString))) :: (S1 ('MetaSel ('Just "password'") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString) :: (S1 ('MetaSel ('Just "compression'") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "database'") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString)))))

setClientInfo :: Maybe ClientInfo -> TCPConnection -> TCPConnection Source #

setClientSetting :: Maybe ClientSetting -> TCPConnection -> TCPConnection Source #

setServerInfo :: Maybe ServerInfo -> TCPConnection -> TCPConnection Source #