Database.ClickHouseDriver.Client

This module provides implementations of user's APIs

Data Fetch and Insert

query

Arguments

:: Env () w

Haxl environment for connection

-> String

Query command for SELECT and SHOW only

-> IO (Either String (Vector (Vector ClickhouseType)))

query command

queryWithInfo :: String -> Env () w -> IO (Either String CKResult)

query result contains query information.

deploySettings :: TCPConnection -> IO (Env () w)

insertMany :: Env () w -> String -> [[ClickhouseType]] -> IO ByteString

insertOneRow

Arguments

:: Env () w

-> String

SQL command

-> [ClickhouseType]

a row of local clickhouse data type to be serialized and inserted.

-> IO ByteString

The resulting bytestring indicates success or failure.

ping :: Env () w -> IO ()

ping pong

withQuery

Arguments

:: Env () w

enviroment i.e. the database resource

-> String

sql statement

-> (Either String (Vector (Vector ClickhouseType)) -> IO a)

callback function that returns type a

-> IO a

type a wrapped in IO monad.

fetch

Arguments

:: String

SQL SELECT command

-> GenHaxl u w (Either String (Vector (Vector ClickhouseType)))

result wrapped in Haxl monad for other tasks run with concurrency.

Fetch data

fetchWithInfo :: String -> GenHaxl u w (Either String CKResult)

fetch data alone with query information

execute :: Env u w -> GenHaxl u w a -> IO a

For general use e.g. creating table, multiple queries, multiple insertions.

Communication

createClient :: ConnParams -> IO (Env () w)

create client with given information such as username, host name and password etc.

defaultClient :: IO (Env () w)

closeClient :: Env () w -> IO ()

close connection

Connection pool

defaultClientPool

Arguments

:: Int

number of stripes

-> NominalDiffTime

idle time for each stripe

-> Int

maximum resources for reach stripe

-> IO (Env () w)

Haxl env wrapped in IO monad.

createClientPool

Arguments

:: ConnParams

parameters for connection settings

-> Int

number of stripes

-> NominalDiffTime

idle time for each stripe

-> Int

maximum resources for reach stripe

-> IO (Env () w)

retrieve settings

client

Arguments

:: Resource a

=> Either String a

Either wrong message of resource with type a

-> IO (Env () w)