Safe Haskell	Safe-Inferred
Language	Haskell2010

Database.CQL.Protocol

Contents

Cql type-class
Basic type definitions
Header
Request
Response
Row, Tuple and Record

Description

The CQL native protocol is a binary frame-based protocol where each frame has a Header, a Length and a body. The protocol distinguishes Requests and Responses.

Some usage examples:

Constructing and Serialising a Request

let q = QueryString "select peer from system.peers where data_center = ? and rack = ?"
    p = QueryParams One False ("uk-1", "r-0") Nothing Nothing Nothing
    r = RqQuery (Query q p :: Query R (Text, Text) (Identity IP))
    i = mkStreamId 0
in pack V3 noCompression False i r

Deserialising a Response

-- assuming bh contains the raw header byte string and bb the raw
-- body byte string.
case header V3 bh of
    Left  e -> ...
    Right h -> unpack noCompression h bb

A generic query processing function

query :: (Tuple a, Tuple b) => Version -> Socket -> QueryString k a b -> QueryParams a -> IO (Response k a b)
query v s q p = do
    let i = mkStreamId 0
    sendToServer s (pack v noCompression False i (RqQuery (Query q p)))
    b <- recv (if v == V3 then 9 else 8) s
    h <- either (throwIO . MyException) return (header v b)
    when (headerType h == RqHeader) $
        throwIO UnexpectedRequestHeader
    let len = lengthRepr (bodyLength h)
    x <- recv (fromIntegral len) s
    case unpack noCompression h x of
        Left e              -> throwIO $ AnotherException e
        Right (RsError _ e) -> throwIO e
        Right response      -> return response

Synopsis

class Cql a where
- ctype :: Tagged a ColumnType
- toCql :: a -> Value
- fromCql :: Value -> Either String a
newtype Keyspace = Keyspace {
- unKeyspace :: Text
}
newtype Table = Table {
- unTable :: Text
}
newtype PagingState = PagingState {
- unPagingState :: ByteString
}
newtype QueryId k a b = QueryId {
- unQueryId :: ByteString
}
newtype QueryString k a b = QueryString {
- unQueryString :: Text
}
data Version
- = V3
- | V4
data CqlVersion
- = Cqlv300
- | CqlVersion !Text
data CompressionAlgorithm
- = Snappy
- | LZ4
- | None
data Compression = Compression {
- algorithm :: !CompressionAlgorithm
- shrink :: ByteString -> Maybe ByteString
- expand :: ByteString -> Maybe ByteString
}
noCompression :: Compression
data Consistency
- = Any
- | One
- | LocalOne
- | Two
- | Three
- | Quorum
- | LocalQuorum
- | All
- | EachQuorum
- | Serial
- | LocalSerial
data OpCode
- = OcError
- | OcStartup
- | OcReady
- | OcAuthenticate
- | OcOptions
- | OcSupported
- | OcQuery
- | OcResult
- | OcPrepare
- | OcExecute
- | OcRegister
- | OcEvent
- | OcBatch
- | OcAuthChallenge
- | OcAuthResponse
- | OcAuthSuccess
data ColumnType
- = CustomColumn !Text
- | AsciiColumn
- | BigIntColumn
- | BlobColumn
- | BooleanColumn
- | CounterColumn
- | DecimalColumn
- | DoubleColumn
- | FloatColumn
- | IntColumn
- | TextColumn
- | TimestampColumn
- | UuidColumn
- | VarCharColumn
- | VarIntColumn
- | TimeUuidColumn
- | InetColumn
- | MaybeColumn !ColumnType
- | ListColumn !ColumnType
- | SetColumn !ColumnType
- | MapColumn !ColumnType !ColumnType
- | TupleColumn [ColumnType]
- | UdtColumn !Text [(Text, ColumnType)]
- | DateColumn
- | TimeColumn
- | SmallIntColumn
- | TinyIntColumn
newtype Ascii = Ascii {
- fromAscii :: Text
}
newtype Blob = Blob {
- fromBlob :: ByteString
}
newtype Counter = Counter {
- fromCounter :: Int64
}
newtype TimeUuid = TimeUuid {
- fromTimeUuid :: UUID
}
newtype Set a = Set {
- fromSet :: [a]
}
newtype Map a b = Map {
- fromMap :: [(a, b)]
}
data Value
- = CqlCustom !ByteString
- | CqlBoolean !Bool
- | CqlInt !Int32
- | CqlBigInt !Int64
- | CqlVarInt !Integer
- | CqlFloat !Float
- | CqlDecimal !Decimal
- | CqlDouble !Double
- | CqlText !Text
- | CqlInet !IP
- | CqlUuid !UUID
- | CqlTimestamp !Int64
- | CqlAscii !Text
- | CqlBlob !ByteString
- | CqlCounter !Int64
- | CqlTimeUuid !UUID
- | CqlMaybe (Maybe Value)
- | CqlList [Value]
- | CqlSet [Value]
- | CqlMap [(Value, Value)]
- | CqlTuple [Value]
- | CqlUdt [(Text, Value)]
- | CqlDate !Int32
- | CqlTime !Int64
- | CqlSmallInt !Int16
- | CqlTinyInt !Int8
newtype Tagged a b = Tagged {
- untag :: b
}
retag :: Tagged a c -> Tagged b c
data R
data W
data S
data ColumnSpec = ColumnSpec {
- keyspace :: !Keyspace
- table :: !Table
- columnName :: !Text
- columnType :: !ColumnType
}
data Header = Header {
- headerType :: !HeaderType
- version :: !Version
- flags :: !Flags
- streamId :: !StreamId
- opCode :: !OpCode
- bodyLength :: !Length
}
data HeaderType
- = RqHeader
- | RsHeader
header :: Version -> ByteString -> Either String Header
newtype Length = Length {
- lengthRepr :: Int32
}
data StreamId
mkStreamId :: Integral i => i -> StreamId
fromStreamId :: StreamId -> Int
data Flags
compress :: Flags
tracing :: Flags
isSet :: Flags -> Flags -> Bool
data Request k a b
- = RqStartup !Startup
- | RqOptions !Options
- | RqRegister !Register
- | RqBatch !Batch
- | RqAuthResp !AuthResponse
- | RqPrepare !(Prepare k a b)
- | RqQuery !(Query k a b)
- | RqExecute !(Execute k a b)
getOpCode :: Request k a b -> OpCode
pack :: Tuple a => Version -> Compression -> Bool -> StreamId -> Request k a b -> Either String ByteString
data Options = Options
data Startup = Startup !CqlVersion !CompressionAlgorithm
newtype AuthResponse = AuthResponse ByteString
newtype Register = Register [EventType]
data EventType
- = TopologyChangeEvent
- | StatusChangeEvent
- | SchemaChangeEvent
data Query k a b = Query !(QueryString k a b) !(QueryParams a)
data QueryParams a = QueryParams {
- consistency :: !Consistency
- skipMetaData :: !Bool
- values :: a
- pageSize :: Maybe Int32
- queryPagingState :: Maybe PagingState
- serialConsistency :: Maybe SerialConsistency
- enableTracing :: Maybe Bool
}
data SerialConsistency
- = SerialConsistency
- | LocalSerialConsistency
data Batch = Batch {
- batchType :: !BatchType
- batchQuery :: [BatchQuery]
- batchConsistency :: !Consistency
- batchSerialConsistency :: Maybe SerialConsistency
}
data BatchQuery where
- BatchQuery :: (Show a, Tuple a, Tuple b) => !(QueryString W a b) -> !a -> BatchQuery
- BatchPrepared :: (Show a, Tuple a, Tuple b) => !(QueryId W a b) -> !a -> BatchQuery
data BatchType
- = BatchLogged
- | BatchUnLogged
- | BatchCounter
newtype Prepare k a b = Prepare (QueryString k a b)
data Execute k a b = Execute !(QueryId k a b) !(QueryParams a)
data Response k a b
- = RsError (Maybe UUID) [Text] !Error
- | RsReady (Maybe UUID) [Text] !Ready
- | RsAuthenticate (Maybe UUID) [Text] !Authenticate
- | RsAuthChallenge (Maybe UUID) [Text] !AuthChallenge
- | RsAuthSuccess (Maybe UUID) [Text] !AuthSuccess
- | RsSupported (Maybe UUID) [Text] !Supported
- | RsResult (Maybe UUID) [Text] !(Result k a b)
- | RsEvent (Maybe UUID) [Text] !Event
warnings :: Response k a b -> [Text]
traceId :: Response k a b -> Maybe UUID
unpack :: (Tuple a, Tuple b) => Compression -> Header -> ByteString -> Either String (Response k a b)
data Ready = Ready
newtype Authenticate = Authenticate Text
newtype AuthChallenge = AuthChallenge (Maybe ByteString)
newtype AuthSuccess = AuthSuccess (Maybe ByteString)
data Result k a b
- = VoidResult
- | RowsResult !MetaData [b]
- | SetKeyspaceResult !Keyspace
- | PreparedResult !(QueryId k a b) !MetaData !MetaData
- | SchemaChangeResult !SchemaChange
data MetaData = MetaData {
- columnCount :: !Int32
- pagingState :: Maybe PagingState
- columnSpecs :: [ColumnSpec]
- primaryKeyIndices :: [Int32]
}
data ColumnSpec = ColumnSpec {
- keyspace :: !Keyspace
- table :: !Table
- columnName :: !Text
- columnType :: !ColumnType
}
data Supported = Supported [CompressionAlgorithm] [CqlVersion]
data Event
- = TopologyEvent !TopologyChange !SockAddr
- | StatusEvent !StatusChange !SockAddr
- | SchemaEvent !SchemaChange
data TopologyChange
- = NewNode
- | RemovedNode
data SchemaChange
- = SchemaCreated !Change
- | SchemaUpdated !Change
- | SchemaDropped !Change
data StatusChange
- = Up
- | Down
data Change
- = KeyspaceChange !Keyspace
- | TableChange !Keyspace !Table
- | TypeChange !Keyspace !Text
- | FunctionChange !Keyspace !Text ![Text]
- | AggregateChange !Keyspace !Text ![Text]
data Error
- = AlreadyExists !Text !Keyspace !Table
- | BadCredentials !Text
- | ConfigError !Text
- | FunctionFailure !Text !Keyspace !Text ![Text]
- | Invalid !Text
- | IsBootstrapping !Text
- | Overloaded !Text
- | ProtocolError !Text
- | ServerError !Text
- | SyntaxError !Text
- | TruncateError !Text
- | Unauthorized !Text
- | Unprepared !Text !ByteString
- | Unavailable {
  - unavailMessage :: !Text
  - unavailConsistency :: !Consistency
  - unavailNumRequired :: !Int32
  - unavailNumAlive :: !Int32
  }
- | ReadFailure {
  - rFailureMessage :: !Text
  - rFailureConsistency :: !Consistency
  - rFailureNumAck :: !Int32
  - rFailureNumRequired :: !Int32
  - rFailureNumFailures :: !Int32
  - rFailureDataPresent :: !Bool
  }
- | ReadTimeout {
  - rTimeoutMessage :: !Text
  - rTimeoutConsistency :: !Consistency
  - rTimeoutNumAck :: !Int32
  - rTimeoutNumRequired :: !Int32
  - rTimeoutDataPresent :: !Bool
  }
- | WriteFailure {
  - wFailureMessage :: !Text
  - wFailureConsistency :: !Consistency
  - wFailureNumAck :: !Int32
  - wFailureNumRequired :: !Int32
  - wFailureNumFailures :: !Int32
  - wFailureWriteType :: !WriteType
  }
- | WriteTimeout {
  - wTimeoutMessage :: !Text
  - wTimeoutConsistency :: !Consistency
  - wTimeoutNumAck :: !Int32
  - wTimeoutNumRequired :: !Int32
  - wTimeoutWriteType :: !WriteType
  }
data WriteType
- = WriteSimple
- | WriteBatch
- | WriteBatchLog
- | WriteUnloggedBatch
- | WriteCounter
- | WriteCas
- | WriteView
- | WriteCdc
class PrivateTuple a => Tuple a
count :: PrivateTuple a => Tagged a Int
check :: PrivateTuple a => Tagged a ([ColumnType] -> [ColumnType])
tuple :: PrivateTuple a => Version -> [ColumnSpec] -> Get a
store :: PrivateTuple a => Version -> Putter a
data Row
mkRow :: [(Value, ColumnType)] -> Row
fromRow :: Cql a => Int -> Row -> Either String a
columnTypes :: Row -> [ColumnType]
rowLength :: Row -> Int
class Record a where
- asTuple :: a -> TupleType a
- asRecord :: TupleType a -> a
type family TupleType a
recordInstance :: Name -> Q [Dec]

Cql type-class

class Cql a where Source #

A type that can be converted from and to some CQL Value.

This type-class is used to map custom types to Cassandra data-types. For example:

newtype MyType = MyType Int32

instance Cql MyType where
    ctype              = Tagged IntColumn
    toCql (MyType i)   = CqlInt i
    fromCql (CqlInt i) = Right (MyType i)
    fromCql _          = Left "Expected CqlInt"

Methods

ctype :: Tagged a ColumnType Source #

the column-type of a

toCql :: a -> Value Source #

map a to some CQL data-type

fromCql :: Value -> Either String a Source #

map a CQL value back to a

Instances

Instances details

Cql Decimal Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Decimal ColumnType Source # toCql :: Decimal -> Value Source # fromCql :: Value -> Either String Decimal Source #
Cql Int16 Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Int16 ColumnType Source # toCql :: Int16 -> Value Source # fromCql :: Value -> Either String Int16 Source #
Cql Int32 Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Int32 ColumnType Source # toCql :: Int32 -> Value Source # fromCql :: Value -> Either String Int32 Source #
Cql Int64 Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Int64 ColumnType Source # toCql :: Int64 -> Value Source # fromCql :: Value -> Either String Int64 Source #
Cql Int8 Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Int8 ColumnType Source # toCql :: Int8 -> Value Source # fromCql :: Value -> Either String Int8 Source #
Cql Ascii Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Ascii ColumnType Source # toCql :: Ascii -> Value Source # fromCql :: Value -> Either String Ascii Source #
Cql Blob Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Blob ColumnType Source # toCql :: Blob -> Value Source # fromCql :: Value -> Either String Blob Source #
Cql Counter Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Counter ColumnType Source # toCql :: Counter -> Value Source # fromCql :: Value -> Either String Counter Source #
Cql TimeUuid Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged TimeUuid ColumnType Source # toCql :: TimeUuid -> Value Source # fromCql :: Value -> Either String TimeUuid Source #
Cql IP Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged IP ColumnType Source # toCql :: IP -> Value Source # fromCql :: Value -> Either String IP Source #
Cql Text Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Text ColumnType Source # toCql :: Text -> Value Source # fromCql :: Value -> Either String Text Source #
Cql UTCTime Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged UTCTime ColumnType Source # toCql :: UTCTime -> Value Source # fromCql :: Value -> Either String UTCTime Source #
Cql UUID Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged UUID ColumnType Source # toCql :: UUID -> Value Source # fromCql :: Value -> Either String UUID Source #
Cql Integer Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Integer ColumnType Source # toCql :: Integer -> Value Source # fromCql :: Value -> Either String Integer Source #
Cql Bool Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Bool ColumnType Source # toCql :: Bool -> Value Source # fromCql :: Value -> Either String Bool Source #
Cql Double Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Double ColumnType Source # toCql :: Double -> Value Source # fromCql :: Value -> Either String Double Source #
Cql Float Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Float ColumnType Source # toCql :: Float -> Value Source # fromCql :: Value -> Either String Float Source #
Cql a => Cql (Set a) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (Set a) ColumnType Source # toCql :: Set a -> Value Source # fromCql :: Value -> Either String (Set a) Source #
Cql a => Cql (Maybe a) Source #	Please note that due to the fact that Cassandra internally represents empty collection type values (i.e. lists, maps and sets) as `null`, we can not distinguish `Just []` from `Nothing` on response decoding.
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (Maybe a) ColumnType Source # toCql :: Maybe a -> Value Source # fromCql :: Value -> Either String (Maybe a) Source #
Cql a => Cql [a] Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged [a] ColumnType Source # toCql :: [a] -> Value Source # fromCql :: Value -> Either String [a] Source #
(Cql a, Cql b) => Cql (Map a b) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (Map a b) ColumnType Source # toCql :: Map a b -> Value Source # fromCql :: Value -> Either String (Map a b) Source #
(Cql a1, Cql a2) => Cql (a1, a2) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2) ColumnType Source # toCql :: (a1, a2) -> Value Source # fromCql :: Value -> Either String (a1, a2) Source #
(Cql a1, Cql a2, Cql a3) => Cql (a1, a2, a3) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3) ColumnType Source # toCql :: (a1, a2, a3) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3) Source #
(Cql a1, Cql a2, Cql a3, Cql a4) => Cql (a1, a2, a3, a4) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4) ColumnType Source # toCql :: (a1, a2, a3, a4) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4) Source #
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5) => Cql (a1, a2, a3, a4, a5) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4, a5) ColumnType Source # toCql :: (a1, a2, a3, a4, a5) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4, a5) Source #
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6) => Cql (a1, a2, a3, a4, a5, a6) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4, a5, a6) ColumnType Source # toCql :: (a1, a2, a3, a4, a5, a6) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4, a5, a6) Source #
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7) => Cql (a1, a2, a3, a4, a5, a6, a7) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4, a5, a6, a7) ColumnType Source # toCql :: (a1, a2, a3, a4, a5, a6, a7) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4, a5, a6, a7) Source #
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8) => Cql (a1, a2, a3, a4, a5, a6, a7, a8) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4, a5, a6, a7, a8) ColumnType Source # toCql :: (a1, a2, a3, a4, a5, a6, a7, a8) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4, a5, a6, a7, a8) Source #
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9) => Cql (a1, a2, a3, a4, a5, a6, a7, a8, a9) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4, a5, a6, a7, a8, a9) ColumnType Source # toCql :: (a1, a2, a3, a4, a5, a6, a7, a8, a9) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4, a5, a6, a7, a8, a9) Source #
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10) => Cql (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) ColumnType Source # toCql :: (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) Source #
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11) => Cql (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) ColumnType Source # toCql :: (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) Source #
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12) => Cql (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) ColumnType Source # toCql :: (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) Source #
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13) => Cql (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) ColumnType Source # toCql :: (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) Source #
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14) => Cql (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) ColumnType Source # toCql :: (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) Source #
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15) => Cql (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) ColumnType Source # toCql :: (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) Source #
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16) => Cql (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16) ColumnType Source # toCql :: (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16) -> Value Source # fromCql :: Value -> Either String (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16) Source #

Basic type definitions

newtype Keyspace Source #

Constructors

Keyspace
Fields unKeyspace :: Text

Instances

Instances details

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

newtype Table Source #

Constructors

Table
Fields unTable :: Text

Instances

Instances details

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

newtype PagingState Source #

Opaque token passed to the server to continue result paging.

Constructors

PagingState
Fields unPagingState :: ByteString

Instances

Instances details

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

newtype QueryId k a b Source #

ID representing a prepared query.

Constructors

QueryId
Fields unQueryId :: ByteString

Instances

Instances details

Show (QueryId k a b) Source #
Instance details Defined in Database.CQL.Protocol.Types Methods showsPrec :: Int -> QueryId k a b -> ShowS # show :: QueryId k a b -> String # showList :: [QueryId k a b] -> ShowS #
Eq (QueryId k a b) Source #
Instance details Defined in Database.CQL.Protocol.Types Methods (==) :: QueryId k a b -> QueryId k a b -> Bool # (/=) :: QueryId k a b -> QueryId k a b -> Bool #

newtype QueryString k a b Source #

Constructors

QueryString
Fields unQueryString :: Text

Instances

Instances details

IsString (QueryString k a b) Source #
Instance details Defined in Database.CQL.Protocol.Types Methods fromString :: String -> QueryString k a b #
Show (QueryString k a b) Source #
Instance details Defined in Database.CQL.Protocol.Types Methods showsPrec :: Int -> QueryString k a b -> ShowS # show :: QueryString k a b -> String # showList :: [QueryString k a b] -> ShowS #
Eq (QueryString k a b) Source #
Instance details Defined in Database.CQL.Protocol.Types Methods (==) :: QueryString k a b -> QueryString k a b -> Bool # (/=) :: QueryString k a b -> QueryString k a b -> Bool #

data Version Source #

CQL binary protocol version.

Constructors

V3	version 3
V4	version 4

Instances

Instances details

Show Version Source #
Instance details Defined in Database.CQL.Protocol.Types Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #
Eq Version Source #
Instance details Defined in Database.CQL.Protocol.Types Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Ord Version Source #
Instance details Defined in Database.CQL.Protocol.Types Methods compare :: Version -> Version -> Ordering # (<) :: Version -> Version -> Bool # (<=) :: Version -> Version -> Bool # (>) :: Version -> Version -> Bool # (>=) :: Version -> Version -> Bool # max :: Version -> Version -> Version # min :: Version -> Version -> Version #

data CqlVersion Source #

The CQL version (not the binary protocol version).

Constructors

Cqlv300
CqlVersion !Text

Instances

Instances details

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

data CompressionAlgorithm Source #

Constructors

Snappy
LZ4
None

Instances

Instances details

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

data Compression Source #

Constructors

Compression
Fields algorithm :: !CompressionAlgorithm shrink :: ByteString -> Maybe ByteString expand :: ByteString -> Maybe ByteString

Instances

Instances details

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

noCompression :: Compression Source #

data Consistency Source #

Consistency level.

See: Consistency

Constructors

Any
One
LocalOne
Two
Three
Quorum
LocalQuorum
All
EachQuorum	Only for write queries.
Serial	Only for read queries.
LocalSerial	Only for read queries.

Instances

Instances details

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

data OpCode Source #

An opcode is a tag to distinguish protocol frame bodies.

Constructors

OcError
OcStartup
OcReady
OcAuthenticate
OcOptions
OcSupported
OcQuery
OcResult
OcPrepare
OcExecute
OcRegister
OcEvent
OcBatch
OcAuthChallenge
OcAuthResponse
OcAuthSuccess

Instances

Instances details

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

data ColumnType Source #

The type of a single CQL column.

Instances

Instances details

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

newtype Ascii Source #

Constructors

Ascii
Fields fromAscii :: Text

Instances

Instances details

IsString Ascii Source #
Instance details Defined in Database.CQL.Protocol.Types Methods fromString :: String -> Ascii #
Show Ascii Source #
Instance details Defined in Database.CQL.Protocol.Types Methods showsPrec :: Int -> Ascii -> ShowS # show :: Ascii -> String # showList :: [Ascii] -> ShowS #
Cql Ascii Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Ascii ColumnType Source # toCql :: Ascii -> Value Source # fromCql :: Value -> Either String Ascii Source #
Eq Ascii Source #
Instance details Defined in Database.CQL.Protocol.Types Methods (==) :: Ascii -> Ascii -> Bool # (/=) :: Ascii -> Ascii -> Bool #
Ord Ascii Source #
Instance details Defined in Database.CQL.Protocol.Types Methods compare :: Ascii -> Ascii -> Ordering # (<) :: Ascii -> Ascii -> Bool # (<=) :: Ascii -> Ascii -> Bool # (>) :: Ascii -> Ascii -> Bool # (>=) :: Ascii -> Ascii -> Bool # max :: Ascii -> Ascii -> Ascii # min :: Ascii -> Ascii -> Ascii #

newtype Blob Source #

Constructors

Blob
Fields fromBlob :: ByteString

Instances

Instances details

Show Blob Source #
Instance details Defined in Database.CQL.Protocol.Types Methods showsPrec :: Int -> Blob -> ShowS # show :: Blob -> String # showList :: [Blob] -> ShowS #
Cql Blob Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Blob ColumnType Source # toCql :: Blob -> Value Source # fromCql :: Value -> Either String Blob Source #
Eq Blob Source #
Instance details Defined in Database.CQL.Protocol.Types Methods (==) :: Blob -> Blob -> Bool # (/=) :: Blob -> Blob -> Bool #
Ord Blob Source #
Instance details Defined in Database.CQL.Protocol.Types Methods compare :: Blob -> Blob -> Ordering # (<) :: Blob -> Blob -> Bool # (<=) :: Blob -> Blob -> Bool # (>) :: Blob -> Blob -> Bool # (>=) :: Blob -> Blob -> Bool # max :: Blob -> Blob -> Blob # min :: Blob -> Blob -> Blob #

newtype Counter Source #

Constructors

Counter
Fields fromCounter :: Int64

Instances

Instances details

Show Counter Source #
Instance details Defined in Database.CQL.Protocol.Types Methods showsPrec :: Int -> Counter -> ShowS # show :: Counter -> String # showList :: [Counter] -> ShowS #
Cql Counter Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged Counter ColumnType Source # toCql :: Counter -> Value Source # fromCql :: Value -> Either String Counter Source #
Eq Counter Source #
Instance details Defined in Database.CQL.Protocol.Types Methods (==) :: Counter -> Counter -> Bool # (/=) :: Counter -> Counter -> Bool #
Ord Counter Source #
Instance details Defined in Database.CQL.Protocol.Types Methods compare :: Counter -> Counter -> Ordering # (<) :: Counter -> Counter -> Bool # (<=) :: Counter -> Counter -> Bool # (>) :: Counter -> Counter -> Bool # (>=) :: Counter -> Counter -> Bool # max :: Counter -> Counter -> Counter # min :: Counter -> Counter -> Counter #

newtype TimeUuid Source #

Constructors

TimeUuid
Fields fromTimeUuid :: UUID

Instances

Instances details

Show TimeUuid Source #
Instance details Defined in Database.CQL.Protocol.Types Methods showsPrec :: Int -> TimeUuid -> ShowS # show :: TimeUuid -> String # showList :: [TimeUuid] -> ShowS #
Cql TimeUuid Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged TimeUuid ColumnType Source # toCql :: TimeUuid -> Value Source # fromCql :: Value -> Either String TimeUuid Source #
Eq TimeUuid Source #
Instance details Defined in Database.CQL.Protocol.Types Methods (==) :: TimeUuid -> TimeUuid -> Bool # (/=) :: TimeUuid -> TimeUuid -> Bool #
Ord TimeUuid Source #
Instance details Defined in Database.CQL.Protocol.Types Methods compare :: TimeUuid -> TimeUuid -> Ordering # (<) :: TimeUuid -> TimeUuid -> Bool # (<=) :: TimeUuid -> TimeUuid -> Bool # (>) :: TimeUuid -> TimeUuid -> Bool # (>=) :: TimeUuid -> TimeUuid -> Bool # max :: TimeUuid -> TimeUuid -> TimeUuid # min :: TimeUuid -> TimeUuid -> TimeUuid #

newtype Set a Source #

Constructors

Set
Fields fromSet :: [a]

Instances

Instances details

Show a => Show (Set a) Source #
Instance details Defined in Database.CQL.Protocol.Types Methods showsPrec :: Int -> Set a -> ShowS # show :: Set a -> String # showList :: [Set a] -> ShowS #
Cql a => Cql (Set a) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (Set a) ColumnType Source # toCql :: Set a -> Value Source # fromCql :: Value -> Either String (Set a) Source #
(Eq a, Ord a) => Eq (Set a) Source #
Instance details Defined in Database.CQL.Protocol.Types Methods (==) :: Set a -> Set a -> Bool # (/=) :: Set a -> Set a -> Bool #

newtype Map a b Source #

Constructors

Map
Fields fromMap :: [(a, b)]

Instances

Instances details

(Show a, Show b) => Show (Map a b) Source #
Instance details Defined in Database.CQL.Protocol.Types Methods showsPrec :: Int -> Map a b -> ShowS # show :: Map a b -> String # showList :: [Map a b] -> ShowS #
(Cql a, Cql b) => Cql (Map a b) Source #
Instance details Defined in Database.CQL.Protocol.Class Methods ctype :: Tagged (Map a b) ColumnType Source # toCql :: Map a b -> Value Source # fromCql :: Value -> Either String (Map a b) Source #
(Eq k, Eq v, Ord k) => Eq (Map k v) Source #
Instance details Defined in Database.CQL.Protocol.Types Methods (==) :: Map k v -> Map k v -> Bool # (/=) :: Map k v -> Map k v -> Bool #

data Value Source #

A CQL value. The various constructors correspond to CQL data-types for individual columns in Cassandra.

Constructors

CqlCustom !ByteString
CqlBoolean !Bool
CqlInt !Int32
CqlBigInt !Int64
CqlVarInt !Integer
CqlFloat !Float
CqlDecimal !Decimal
CqlDouble !Double
CqlText !Text
CqlInet !IP
CqlUuid !UUID
CqlTimestamp !Int64
CqlAscii !Text
CqlBlob !ByteString
CqlCounter !Int64
CqlTimeUuid !UUID
CqlMaybe (Maybe Value)
CqlList [Value]
CqlSet [Value]
CqlMap [(Value, Value)]
CqlTuple [Value]
CqlUdt [(Text, Value)]
CqlDate !Int32
CqlTime !Int64
CqlSmallInt !Int16
CqlTinyInt !Int8

Instances

Instances details

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

newtype Tagged a b Source #

Tag some value with a phantom type.

Constructors

Tagged
Fields untag :: b

retag :: Tagged a c -> Tagged b c Source #

data R Source #

Type tag for read queries, i.e. 'QueryString R a b'.

data W Source #

Type tag for write queries, i.e. 'QueryString W a b'.

data S Source #

Type tag for schema queries, i.e. 'QueryString S a b'.

data ColumnSpec Source #

The column specification. Part of MetaData unless skipMetaData in QueryParams was True.

Constructors

ColumnSpec
Fields keyspace :: !Keyspace table :: !Table columnName :: !Text columnType :: !ColumnType

Instances

Instances details

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

Header

data Header Source #

Protocol frame header.

Constructors

Header
Fields headerType :: !HeaderType version :: !Version flags :: !Flags streamId :: !StreamId opCode :: !OpCode bodyLength :: !Length

Instances

data HeaderType Source #

Constructors

RqHeader	A request frame header.
RsHeader	A response frame header.

Instances

Instances details

Show HeaderType Source #
Instance details Defined in Database.CQL.Protocol.Header Methods showsPrec :: Int -> HeaderType -> ShowS # show :: HeaderType -> String # showList :: [HeaderType] -> ShowS #

header :: Version -> ByteString -> Either String Header Source #

Deserialise a frame header using the version specific decoding format.

Length

newtype Length Source #

The type denoting a protocol frame length.

Constructors

Length
Fields lengthRepr :: Int32

Instances

Instances details

Show Length Source #
Instance details Defined in Database.CQL.Protocol.Header Methods showsPrec :: Int -> Length -> ShowS # show :: Length -> String # showList :: [Length] -> ShowS #
Eq Length Source #
Instance details Defined in Database.CQL.Protocol.Header Methods (==) :: Length -> Length -> Bool # (/=) :: Length -> Length -> Bool #

StreamId

data StreamId Source #

Streams allow multiplexing of requests over a single communication channel. The StreamId correlates Requests with Responses.

Instances

Instances details

Show StreamId Source #
Instance details Defined in Database.CQL.Protocol.Header Methods showsPrec :: Int -> StreamId -> ShowS # show :: StreamId -> String # showList :: [StreamId] -> ShowS #
Eq StreamId Source #
Instance details Defined in Database.CQL.Protocol.Header Methods (==) :: StreamId -> StreamId -> Bool # (/=) :: StreamId -> StreamId -> Bool #

mkStreamId :: Integral i => i -> StreamId Source #

Create a StreamId from the given integral value. In version 2, a StreamId is an Int8 and in version 3 an Int16.

fromStreamId :: StreamId -> Int Source #

Convert the stream ID to an integer.

Flags

data Flags Source #

Type representing header flags. Flags form a monoid and can be used as in compress <> tracing <> mempty.

Instances

Instances details

Monoid Flags Source #
Instance details Defined in Database.CQL.Protocol.Header Methods mempty :: Flags # mappend :: Flags -> Flags -> Flags # mconcat :: [Flags] -> Flags #
Semigroup Flags Source #
Instance details Defined in Database.CQL.Protocol.Header Methods (<>) :: Flags -> Flags -> Flags # sconcat :: NonEmpty Flags -> Flags # stimes :: Integral b => b -> Flags -> Flags #
Show Flags Source #
Instance details Defined in Database.CQL.Protocol.Header Methods showsPrec :: Int -> Flags -> ShowS # show :: Flags -> String # showList :: [Flags] -> ShowS #
Eq Flags Source #
Instance details Defined in Database.CQL.Protocol.Header Methods (==) :: Flags -> Flags -> Bool # (/=) :: Flags -> Flags -> Bool #

compress :: Flags Source #

Compression flag. If set, the frame body is compressed.

tracing :: Flags Source #

Tracing flag. If a request support tracing and the tracing flag was set, the response to this request will have the tracing flag set and contain tracing information.

isSet :: Flags -> Flags -> Bool Source #

Check if a particular flag is present.

Request

data Request k a b Source #

The type corresponding to the protocol request frame.

The type parameter k denotes the kind of request. It is present to allow distinguishing read operations from write operations. Use R for read, W for write and S for schema related operations.

a represents the argument type and b the return type of this request.

Constructors

RqStartup !Startup
RqOptions !Options
RqRegister !Register
RqBatch !Batch
RqAuthResp !AuthResponse
RqPrepare !(Prepare k a b)
RqQuery !(Query k a b)
RqExecute !(Execute k a b)

Instances

Instances details

Show a => Show (Request k a b) Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> Request k a b -> ShowS # show :: Request k a b -> String # showList :: [Request k a b] -> ShowS #

getOpCode :: Request k a b -> OpCode Source #

Get the protocol OpCode corresponding to the given Request.

pack Source #

Arguments

:: Tuple a
=> Version	protocol version, which determines the encoding
-> Compression	compression to use
-> Bool	enable/disable tracing
-> StreamId	the stream Id to use
-> Request k a b	the actual request to serialise
-> Either String ByteString

Serialise the given request, optionally using compression. The result is either an error description in case of failure or a binary protocol frame, including Header, Length and body.

Options

data Options Source #

An options request, send prior to Startup to request the server's startup options.

Constructors

Options

Instances

Instances details

Show Options Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> Options -> ShowS # show :: Options -> String # showList :: [Options] -> ShowS #

Startup

data Startup Source #

A startup request which is used when initialising a connection to the server. It specifies the CQL version to use and optionally the compression algorithm.

Constructors

Startup !CqlVersion !CompressionAlgorithm

Instances

Instances details

Show Startup Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> Startup -> ShowS # show :: Startup -> String # showList :: [Startup] -> ShowS #

Auth Response

newtype AuthResponse Source #

A request send in response to a previous authentication challenge.

Constructors

AuthResponse ByteString

Instances

Instances details

Show AuthResponse Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> AuthResponse -> ShowS # show :: AuthResponse -> String # showList :: [AuthResponse] -> ShowS #

Register

newtype Register Source #

Register's the connection this request is made through, to receive server events.

Constructors

Register [EventType]

Instances

Instances details

Show Register Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> Register -> ShowS # show :: Register -> String # showList :: [Register] -> ShowS #

data EventType Source #

Event types to register.

Constructors

TopologyChangeEvent	events related to change in the cluster topology
StatusChangeEvent	events related to change of node status
SchemaChangeEvent	events related to schema change

Instances

Instances details

Show EventType Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> EventType -> ShowS # show :: EventType -> String # showList :: [EventType] -> ShowS #

Query

data Query k a b Source #

A CQL query (select, insert, etc.).

Constructors

Query !(QueryString k a b) !(QueryParams a)

Instances

Instances details

Show a => Show (Query k a b) Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> Query k a b -> ShowS # show :: Query k a b -> String # showList :: [Query k a b] -> ShowS #

data QueryParams a Source #

Query parameters.

Constructors

QueryParams

Fields

consistency :: !Consistency
(Regular) consistency level to use.
skipMetaData :: !Bool
Whether to omit the metadata in the Response of the query. This is an optimisation only relevant for use with prepared queries, for which the metadata obtained from the PreparedResult may be reused.
values :: a
The bound parameters of the query.
pageSize :: Maybe Int32
The desired maximum result set size.
queryPagingState :: Maybe PagingState
The current paging state that determines the "offset" of the results to return for a read query.
serialConsistency :: Maybe SerialConsistency
Serial consistency level to use for conditional updates (aka "lightweight transactions"). Irrelevant for any other queries.
enableTracing :: Maybe Bool
Whether tracing should be enabled for the query, in which case the Response will carry a traceId.

Instances

Instances details

Show a => Show (QueryParams a) Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> QueryParams a -> ShowS # show :: QueryParams a -> String # showList :: [QueryParams a] -> ShowS #

data SerialConsistency Source #

Consistency level for the serial phase of conditional updates (aka "lightweight transactions").

See: SerialConsistency

Constructors

SerialConsistency	Default. Quorum-based linearizable consistency.
LocalSerialConsistency	Like `SerialConsistency` except confined to a single (logical) data center.

Instances

Instances details

Show SerialConsistency Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> SerialConsistency -> ShowS # show :: SerialConsistency -> String # showList :: [SerialConsistency] -> ShowS #

Batch

data Batch Source #

Allows executing a list of queries (prepared or not) as a batch.

Constructors

Batch
Fields batchType :: !BatchType batchQuery :: [BatchQuery] batchConsistency :: !Consistency batchSerialConsistency :: Maybe SerialConsistency

Instances

Instances details

Show Batch Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> Batch -> ShowS # show :: Batch -> String # showList :: [Batch] -> ShowS #

data BatchQuery where Source #

A GADT to unify queries and prepared queries both of which can be used in batch requests.

Constructors

BatchQuery :: (Show a, Tuple a, Tuple b) => !(QueryString W a b) -> !a -> BatchQuery
BatchPrepared :: (Show a, Tuple a, Tuple b) => !(QueryId W a b) -> !a -> BatchQuery

Instances

Instances details

Show BatchQuery Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> BatchQuery -> ShowS # show :: BatchQuery -> String # showList :: [BatchQuery] -> ShowS #

data BatchType Source #

Constructors

BatchLogged	default, uses a batch log for atomic application
BatchUnLogged	skip the batch log
BatchCounter	used for batched counter updates

Instances

Instances details

Show BatchType Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> BatchType -> ShowS # show :: BatchType -> String # showList :: [BatchType] -> ShowS #

Prepare

newtype Prepare k a b Source #

Prepare a query for later execution (cf. Execute).

Constructors

Prepare (QueryString k a b)

Instances

Instances details

Show (Prepare k a b) Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> Prepare k a b -> ShowS # show :: Prepare k a b -> String # showList :: [Prepare k a b] -> ShowS #

Execute

data Execute k a b Source #

Executes a prepared query.

Constructors

Execute !(QueryId k a b) !(QueryParams a)

Instances

Instances details

Show a => Show (Execute k a b) Source #
Instance details Defined in Database.CQL.Protocol.Request Methods showsPrec :: Int -> Execute k a b -> ShowS # show :: Execute k a b -> String # showList :: [Execute k a b] -> ShowS #

Response

data Response k a b Source #

The type corresponding to the protocol response frame.

The type parameter k denotes the kind of response. It is present to allow distinguishing read operations from write operations. Use R for read, W for write and S for schema related operations.

a represents the argument type and b the return type of this response.

Constructors

RsError (Maybe UUID) [Text] !Error
RsReady (Maybe UUID) [Text] !Ready
RsAuthenticate (Maybe UUID) [Text] !Authenticate
RsAuthChallenge (Maybe UUID) [Text] !AuthChallenge
RsAuthSuccess (Maybe UUID) [Text] !AuthSuccess
RsSupported (Maybe UUID) [Text] !Supported
RsResult (Maybe UUID) [Text] !(Result k a b)
RsEvent (Maybe UUID) [Text] !Event

Instances

Instances details

Show b => Show (Response k a b) Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> Response k a b -> ShowS # show :: Response k a b -> String # showList :: [Response k a b] -> ShowS #

warnings :: Response k a b -> [Text] Source #

Get server warnings from response if any.

traceId :: Response k a b -> Maybe UUID Source #

Get server trace ID from response if any.

unpack :: (Tuple a, Tuple b) => Compression -> Header -> ByteString -> Either String (Response k a b) Source #

Deserialise a Response from the given ByteString.

Ready

data Ready Source #

The server is ready to process queries. Response of a Startup request.

Constructors

Ready

Instances

Instances details

Show Ready Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> Ready -> ShowS # show :: Ready -> String # showList :: [Ready] -> ShowS #

Authenticate

newtype Authenticate Source #

The server requires authentication.

Constructors

Authenticate Text

Instances

Instances details

Show Authenticate Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> Authenticate -> ShowS # show :: Authenticate -> String # showList :: [Authenticate] -> ShowS #

newtype AuthChallenge Source #

A server-send authentication challenge.

Constructors

AuthChallenge (Maybe ByteString)

Instances

Instances details

Show AuthChallenge Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> AuthChallenge -> ShowS # show :: AuthChallenge -> String # showList :: [AuthChallenge] -> ShowS #

newtype AuthSuccess Source #

Indicates the success of an authentication phase.

Constructors

AuthSuccess (Maybe ByteString)

Instances

Instances details

Show AuthSuccess Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> AuthSuccess -> ShowS # show :: AuthSuccess -> String # showList :: [AuthSuccess] -> ShowS #

Result

data Result k a b Source #

Query response.

Constructors

VoidResult
RowsResult !MetaData [b]
SetKeyspaceResult !Keyspace
PreparedResult !(QueryId k a b) !MetaData !MetaData
SchemaChangeResult !SchemaChange

Instances

Instances details

Show b => Show (Result k a b) Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> Result k a b -> ShowS # show :: Result k a b -> String # showList :: [Result k a b] -> ShowS #

data MetaData Source #

Part of a RowsResult. Describes the result set.

Constructors

MetaData
Fields columnCount :: !Int32 pagingState :: Maybe PagingState columnSpecs :: [ColumnSpec] primaryKeyIndices :: [Int32]

Instances

Instances details

Show MetaData Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> MetaData -> ShowS # show :: MetaData -> String # showList :: [MetaData] -> ShowS #

data ColumnSpec Source #

The column specification. Part of MetaData unless skipMetaData in QueryParams was True.

Constructors

ColumnSpec
Fields keyspace :: !Keyspace table :: !Table columnName :: !Text columnType :: !ColumnType

Instances

Instances details

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

Supported

data Supported Source #

The startup options supported by the server. Response of an Options request.

Constructors

Supported [CompressionAlgorithm] [CqlVersion]

Instances

Instances details

Show Supported Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> Supported -> ShowS # show :: Supported -> String # showList :: [Supported] -> ShowS #

Event

data Event Source #

Messages send by the server without request, if the connection has been Registered to receive such events.

Constructors

TopologyEvent !TopologyChange !SockAddr
StatusEvent !StatusChange !SockAddr
SchemaEvent !SchemaChange

Instances

Instances details

Show Event Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #

data TopologyChange Source #

Constructors

NewNode
RemovedNode

Instances

Instances details

Show TopologyChange Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> TopologyChange -> ShowS # show :: TopologyChange -> String # showList :: [TopologyChange] -> ShowS #
Eq TopologyChange Source #
Instance details Defined in Database.CQL.Protocol.Response Methods (==) :: TopologyChange -> TopologyChange -> Bool # (/=) :: TopologyChange -> TopologyChange -> Bool #
Ord TopologyChange Source #
Instance details Defined in Database.CQL.Protocol.Response Methods compare :: TopologyChange -> TopologyChange -> Ordering # (<) :: TopologyChange -> TopologyChange -> Bool # (<=) :: TopologyChange -> TopologyChange -> Bool # (>) :: TopologyChange -> TopologyChange -> Bool # (>=) :: TopologyChange -> TopologyChange -> Bool # max :: TopologyChange -> TopologyChange -> TopologyChange # min :: TopologyChange -> TopologyChange -> TopologyChange #

data SchemaChange Source #

Constructors

SchemaCreated !Change
SchemaUpdated !Change
SchemaDropped !Change

Instances

Instances details

Show SchemaChange Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> SchemaChange -> ShowS # show :: SchemaChange -> String # showList :: [SchemaChange] -> ShowS #

data StatusChange Source #

Constructors

Up
Down

Instances

Instances details

Show StatusChange Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> StatusChange -> ShowS # show :: StatusChange -> String # showList :: [StatusChange] -> ShowS #
Eq StatusChange Source #
Instance details Defined in Database.CQL.Protocol.Response Methods (==) :: StatusChange -> StatusChange -> Bool # (/=) :: StatusChange -> StatusChange -> Bool #
Ord StatusChange Source #
Instance details Defined in Database.CQL.Protocol.Response Methods compare :: StatusChange -> StatusChange -> Ordering # (<) :: StatusChange -> StatusChange -> Bool # (<=) :: StatusChange -> StatusChange -> Bool # (>) :: StatusChange -> StatusChange -> Bool # (>=) :: StatusChange -> StatusChange -> Bool # max :: StatusChange -> StatusChange -> StatusChange # min :: StatusChange -> StatusChange -> StatusChange #

data Change Source #

Constructors

KeyspaceChange !Keyspace
TableChange !Keyspace !Table
TypeChange !Keyspace !Text
FunctionChange !Keyspace !Text ![Text]
AggregateChange !Keyspace !Text ![Text]

Instances

Instances details

Show Change Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> Change -> ShowS # show :: Change -> String # showList :: [Change] -> ShowS #

Error

data Error Source #

Error response.

Constructors

AlreadyExists !Text !Keyspace !Table
BadCredentials !Text
ConfigError !Text
FunctionFailure !Text !Keyspace !Text ![Text]
Invalid !Text
IsBootstrapping !Text
Overloaded !Text
ProtocolError !Text
ServerError !Text
SyntaxError !Text
TruncateError !Text
Unauthorized !Text
Unprepared !Text !ByteString
Unavailable
Fields unavailMessage :: !Text unavailConsistency :: !Consistency unavailNumRequired :: !Int32 unavailNumAlive :: !Int32
ReadFailure
Fields rFailureMessage :: !Text rFailureConsistency :: !Consistency rFailureNumAck :: !Int32 rFailureNumRequired :: !Int32 rFailureNumFailures :: !Int32 rFailureDataPresent :: !Bool
ReadTimeout
Fields rTimeoutMessage :: !Text rTimeoutConsistency :: !Consistency rTimeoutNumAck :: !Int32 rTimeoutNumRequired :: !Int32 rTimeoutDataPresent :: !Bool
WriteFailure
Fields wFailureMessage :: !Text wFailureConsistency :: !Consistency wFailureNumAck :: !Int32 wFailureNumRequired :: !Int32 wFailureNumFailures :: !Int32 wFailureWriteType :: !WriteType
WriteTimeout
Fields wTimeoutMessage :: !Text wTimeoutConsistency :: !Consistency wTimeoutNumAck :: !Int32 wTimeoutNumRequired :: !Int32 wTimeoutWriteType :: !WriteType

Instances

Instances details

Exception Error Source #
Instance details Defined in Database.CQL.Protocol.Response Methods toException :: Error -> SomeException # fromException :: SomeException -> Maybe Error # displayException :: Error -> String #
Show Error Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
Eq Error Source #
Instance details Defined in Database.CQL.Protocol.Response Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #

data WriteType Source #

Constructors

WriteSimple
WriteBatch
WriteBatchLog
WriteUnloggedBatch
WriteCounter
WriteCas
WriteView	Since `V4`.
WriteCdc	Since `V4`.

Instances

Instances details

Show WriteType Source #
Instance details Defined in Database.CQL.Protocol.Response Methods showsPrec :: Int -> WriteType -> ShowS # show :: WriteType -> String # showList :: [WriteType] -> ShowS #
Eq WriteType Source #
Instance details Defined in Database.CQL.Protocol.Response Methods (==) :: WriteType -> WriteType -> Bool # (/=) :: WriteType -> WriteType -> Bool #

Row, Tuple and Record

class PrivateTuple a => Tuple a Source #

Instances

Instances details

Tuple Row Source #
Instance details Defined in Database.CQL.Protocol.Tuple
Tuple () Source #
Instance details Defined in Database.CQL.Protocol.Tuple
Cql a => Tuple (Identity a) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2) => Tuple (a1, a2) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3) => Tuple (a1, a2, a3) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4) => Tuple (a1, a2, a3, a4) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5) => Tuple (a1, a2, a3, a4, a5) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6) => Tuple (a1, a2, a3, a4, a5, a6) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7) => Tuple (a1, a2, a3, a4, a5, a6, a7) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36, Cql a37) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36, Cql a37, Cql a38) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36, Cql a37, Cql a38, Cql a39) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38, a39) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36, Cql a37, Cql a38, Cql a39, Cql a40) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38, a39, a40) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36, Cql a37, Cql a38, Cql a39, Cql a40, Cql a41) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38, a39, a40, a41) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36, Cql a37, Cql a38, Cql a39, Cql a40, Cql a41, Cql a42) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38, a39, a40, a41, a42) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36, Cql a37, Cql a38, Cql a39, Cql a40, Cql a41, Cql a42, Cql a43) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38, a39, a40, a41, a42, a43) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36, Cql a37, Cql a38, Cql a39, Cql a40, Cql a41, Cql a42, Cql a43, Cql a44) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38, a39, a40, a41, a42, a43, a44) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36, Cql a37, Cql a38, Cql a39, Cql a40, Cql a41, Cql a42, Cql a43, Cql a44, Cql a45) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38, a39, a40, a41, a42, a43, a44, a45) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36, Cql a37, Cql a38, Cql a39, Cql a40, Cql a41, Cql a42, Cql a43, Cql a44, Cql a45, Cql a46) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38, a39, a40, a41, a42, a43, a44, a45, a46) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36, Cql a37, Cql a38, Cql a39, Cql a40, Cql a41, Cql a42, Cql a43, Cql a44, Cql a45, Cql a46, Cql a47) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38, a39, a40, a41, a42, a43, a44, a45, a46, a47) Source #
Instance details Defined in Database.CQL.Protocol.Tuple
(Cql a1, Cql a2, Cql a3, Cql a4, Cql a5, Cql a6, Cql a7, Cql a8, Cql a9, Cql a10, Cql a11, Cql a12, Cql a13, Cql a14, Cql a15, Cql a16, Cql a17, Cql a18, Cql a19, Cql a20, Cql a21, Cql a22, Cql a23, Cql a24, Cql a25, Cql a26, Cql a27, Cql a28, Cql a29, Cql a30, Cql a31, Cql a32, Cql a33, Cql a34, Cql a35, Cql a36, Cql a37, Cql a38, Cql a39, Cql a40, Cql a41, Cql a42, Cql a43, Cql a44, Cql a45, Cql a46, Cql a47, Cql a48) => Tuple (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, a21, a22, a23, a24, a25, a26, a27, a28, a29, a30, a31, a32, a33, a34, a35, a36, a37, a38, a39, a40, a41, a42, a43, a44, a45, a46, a47, a48) Source #
Instance details Defined in Database.CQL.Protocol.Tuple

count :: PrivateTuple a => Tagged a Int Source #

check :: PrivateTuple a => Tagged a ([ColumnType] -> [ColumnType]) Source #

tuple :: PrivateTuple a => Version -> [ColumnSpec] -> Get a Source #

store :: PrivateTuple a => Version -> Putter a Source #

data Row Source #

A row is a vector of Values.

Instances

Instances details

Show Row Source #
Instance details Defined in Database.CQL.Protocol.Tuple Methods showsPrec :: Int -> Row -> ShowS # show :: Row -> String # showList :: [Row] -> ShowS #
Tuple Row Source #
Instance details Defined in Database.CQL.Protocol.Tuple
Eq Row Source #
Instance details Defined in Database.CQL.Protocol.Tuple Methods (==) :: Row -> Row -> Bool # (/=) :: Row -> Row -> Bool #

mkRow :: [(Value, ColumnType)] -> Row Source #

fromRow :: Cql a => Int -> Row -> Either String a Source #

Convert a row element.

columnTypes :: Row -> [ColumnType] Source #

rowLength :: Row -> Int Source #

class Record a where Source #

Record/Tuple conversion. For example:

data Peer = Peer
    { peerAddr :: IP
    , peerRPC  :: IP
    , peerDC   :: Text
    , peerRack :: Text
    } deriving Show

recordInstance ''Peer

map asRecord <$> performQuery "SELECT peer, rpc_address, data_center, rack FROM system.peers"

The generated type-class instance maps between record and tuple constructors:

type instance TupleType Peer = (IP, IP, Text, Text)

instance Record Peer where
    asTuple (Peer a b c d) = (a, b, c, d)
    asRecord (a, b, c, d)  = Peer a b c d

Methods

asTuple :: a -> TupleType a Source #

asRecord :: TupleType a -> a Source #

type family TupleType a Source #

recordInstance :: Name -> Q [Dec] Source #

CustomColumn !Text
AsciiColumn
BigIntColumn
BlobColumn
BooleanColumn
CounterColumn
DecimalColumn
DoubleColumn
FloatColumn
IntColumn
TextColumn
TimestampColumn
UuidColumn
VarCharColumn
VarIntColumn
TimeUuidColumn
InetColumn
MaybeColumn !ColumnType
ListColumn !ColumnType
SetColumn !ColumnType
MapColumn !ColumnType !ColumnType
TupleColumn [ColumnType]
UdtColumn !Text [(Text, ColumnType)]
DateColumn
TimeColumn
SmallIntColumn
TinyIntColumn