Safe Haskell	None

Database.Cassandra.CQL

Contents

Initialization
Monads
Type used in operations
Queries
Operations
Value types

Description

Haskell client for Cassandra's CQL protocol

This module isn't properly documented yet. For now, take a look at tests/example.hs.

Credentials are not implemented yet.

Here's the correspondence between Haskell and CQL types. Not all Cassandra data types supported as yet: Haskell types listed below have been implemented.

ascii - ByteString
bigint - Int64
blob - Blob
boolean - Bool
counter - Counter
decimal - Integer
double - Double
float - Float
int - Int
text - Text
timestamp - UTCTime
uuid - UUID
varchar
varint
timeuuid - TimeUUID
inet - SockAddr
list<a> - [a]
map<a, b> - Map a b
set<a> - Set b

Synopsis

Initialization

type Server = (HostName, ServiceName)Source

createCassandraPool :: [Server] -> Keyspace -> IO CPool Source

data CPool Source

Monads

class MonadCatchIO m => MonadCassandra m Source

Instances

MonadCassandra Cas

data Cas a Source

Instances

Monad Cas
Functor Cas
Applicative Cas
MonadCatchIO Cas
MonadIO Cas
MonadCassandra Cas

runCas :: CPool -> Cas a -> IO aSource

data TransportDirection Source

Constructors

TransportSending
TransportReceiving

Instances

Show TransportDirection

Type used in operations

newtype Keyspace Source

Constructors

Keyspace Text

Instances

Eq Keyspace
Ord Keyspace
Show Keyspace
IsString Keyspace

data Result vs Source

Constructors

Void
RowsResult Metadata [vs]
SetKeyspace Text
Prepared PreparedQueryID Metadata
SchemaChange Change Keyspace Table

Instances

Functor Result
Show vs => Show (Result vs)

data TableSpec Source

Constructors

TableSpec Keyspace Table

Instances

Show TableSpec

data ColumnSpec Source

Constructors

ColumnSpec TableSpec Text CType

Instances

Show ColumnSpec

data Metadata Source

Constructors

Metadata [ColumnSpec]

Instances

Show Metadata

data CType Source

Instances

Eq CType
Ord CType
Show CType

data Change Source

Constructors

CREATED
UPDATED
DROPPED

Instances

Eq Change
Ord Change
Show Change

newtype Table Source

Constructors

Table Text

Instances

Eq Table
Ord Table
Show Table
IsString Table

data Consistency Source

Constructors

ANY
ONE
TWO
THREE
QUORUM
ALL
LOCAL_QUORUM
EACH_QUORUM

Instances

Bounded Consistency
Enum Consistency
Eq Consistency
Ord Consistency
Show Consistency

Queries

data Query Source

Instances

Show (Query $a $b $c)
IsString (Query style i o)

query :: Text -> Query style i oSource

data Style Source

Constructors

Rows
Write
Schema

Operations

executeRows :: (MonadCassandra m, CasValues i, CasValues o) => Consistency -> Query Rows i o -> i -> m [o]Source

Execute a query that returns rows

executeRow :: (MonadCassandra m, CasValues i, CasValues o) => Consistency -> Query Rows i o -> i -> m (Maybe o)Source

Helper for executeRows useful in situations where you are only expecting one row to be returned.

executeWrite :: (MonadCassandra m, CasValues i) => Consistency -> Query Write i () -> i -> m ()Source

Execute a write operation that returns void

executeSchema :: (MonadCassandra m, CasValues i) => Consistency -> Query Schema i () -> i -> m (Change, Keyspace, Table)Source

Execute a schema change, such as creating or dropping a table.

executeRaw :: (MonadCassandra m, CasValues i) => Query style any_i any_o -> i -> Consistency -> m (Result [ByteString])Source

Value types

class CasType a whereSource

Methods

getCas :: Get aSource

putCas :: a -> Put Source

casType :: a -> CType Source

Instances

CasType Bool
CasType Double
CasType Float
CasType Int
CasType Int64
CasType Integer
CasType ByteString
CasType SockAddr
CasType Text
CasType UTCTime
CasType UUID
CasType TimeUUID
CasType Counter
CasType Blob
CasType a => CasType [a]
(CasType a, Ord a) => CasType (Set a)
(CasType a, Ord a, CasType b) => CasType (Map a b)

class CasValues v whereSource

Methods

encodeValues :: v -> [CType] -> Either CodingFailure [ByteString]Source

decodeValues :: [(CType, ByteString)] -> Either CodingFailure vSource

Instances

CasValues ()
CasType a => CasValues a
(CasType a, CasType b) => CasValues (a, b)
(CasType a, CasType b, CasType c) => CasValues (a, b, c)
(CasType a, CasType b, CasType c, CasType d) => CasValues (a, b, c, d)
(CasType a, CasType b, CasType c, CasType d, CasType e) => CasValues (a, b, c, d, e)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f) => CasValues (a, b, c, d, e, f)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g) => CasValues (a, b, c, d, e, f, g)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h) => CasValues (a, b, c, d, e, f, g, h)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h, CasType i) => CasValues (a, b, c, d, e, f, g, h, i)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h, CasType i, CasType j) => CasValues (a, b, c, d, e, f, g, h, i, j)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h, CasType i, CasType j, CasType k) => CasValues (a, b, c, d, e, f, g, h, i, j, k)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h, CasType i, CasType j, CasType k, CasType l) => CasValues (a, b, c, d, e, f, g, h, i, j, k, l)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h, CasType i, CasType j, CasType k, CasType l, CasType m) => CasValues (a, b, c, d, e, f, g, h, i, j, k, l, m)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h, CasType i, CasType j, CasType k, CasType l, CasType m, CasType n) => CasValues (a, b, c, d, e, f, g, h, i, j, k, l, m, n)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h, CasType i, CasType j, CasType k, CasType l, CasType m, CasType n, CasType o) => CasValues (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h, CasType i, CasType j, CasType k, CasType l, CasType m, CasType n, CasType o, CasType p) => CasValues (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h, CasType i, CasType j, CasType k, CasType l, CasType m, CasType n, CasType o, CasType p, CasType q) => CasValues (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h, CasType i, CasType j, CasType k, CasType l, CasType m, CasType n, CasType o, CasType p, CasType q, CasType r) => CasValues (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h, CasType i, CasType j, CasType k, CasType l, CasType m, CasType n, CasType o, CasType p, CasType q, CasType r, CasType s) => CasValues (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s)
(CasType a, CasType b, CasType c, CasType d, CasType e, CasType f, CasType g, CasType h, CasType i, CasType j, CasType k, CasType l, CasType m, CasType n, CasType o, CasType p, CasType q, CasType r, CasType s, CasType t) => CasValues (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t)

newtype Blob Source

Constructors

Blob ByteString

Instances

Eq Blob
Ord Blob
Show Blob
CasType Blob

newtype Counter Source

Constructors

Counter Int64

Instances

Eq Counter
Ord Counter
Read Counter
Show Counter
CasType Counter

data TimeUUID Source

Constructors

TimeUUID UUID

Instances

Eq TimeUUID
Data TimeUUID
Ord TimeUUID
Read TimeUUID
Show TimeUUID
Typeable TimeUUID
CasType TimeUUID

metadataTypes :: Metadata -> [CType]Source

LocalProtocolError Text
AuthenticationException Text
ValueMarshallingException TransportDirection Text
ServerError Text
ProtocolError Text
BadCredentials Text
UnavailableException Text Consistency Int Int
Overloaded Text
IsBootstrapping Text
TruncateError Text
WriteTimeout Text Consistency Int Int Text
ReadTimeout Text Consistency Int Int Bool
SyntaxError Text
Unauthorized Text
Invalid Text
ConfigError Text
AlreadyExists Text Keyspace Table
Unprepared Text PreparedQueryID

CCustom Text
CAscii
CBigint
CBlob
CBoolean
CCounter
CDecimal
CDouble
CFloat
CInt
CText
CTimestamp
CUuid
CVarchar
CVarint
CTimeuuid
CInet
CList CType
CMap CType CType
CSet CType

Show CassandraException
Typeable CassandraException
Exception CassandraException