cassandra-cql 0.2.0.0 → 0.2.0.1

raw patch · 2 files changed

+41/−18 lines, 2 filesPVP: minor bump suggested

API additions: PVP suggests at least a minor version bump

API changes (from Hackage documentation)

Files

• Database/Cassandra/CQL.hs +40/−17
• cassandra-cql.cabal +1/−1

@@ -43,9 +43,11 @@ -- -- * set\<a\> - 'Set' b ----- The recommended way to use it is to specify your queries as global constants--- in this way:+-- ...and you can define your own 'CasType' instances to extend these types, which is+-- a very powerful way to write your code. --+-- One way to do things is to specify your queries with a type signature, like this:+-- -- > createSongs :: Query Schema () () -- > createSongs = "create table songs (id uuid PRIMARY KEY, title text, artist text, comment text)" -- >@@ -65,12 +67,6 @@ -- in the table. Cassandra allows any column to be null, but you can lock this out by -- specifying non-Maybe types. ----- The reason why it is desirable for 'Query' values to be global constants (i.e. defined--- at top-level of your Haskell source) is because it's the fastest at runtime:--- Queries contain a hash value that is calculated lazily from the query text, which is--- used to locally cache prepared queries. If the constant is global, then Haskell caches--- the hash value so it gets calculated once only per query per program execution.--- -- The query types are: -- -- * 'Schema' for modifications to the schema. The output tuple type must be ().@@ -82,6 +78,13 @@ -- The functions to use for these query types are 'executeSchema', 'executeWrite' and -- 'executeRows' or 'executeRow' respectively. --+-- The following pattern seems to work very well, especially along with your own 'CasType'+-- instances, because it neatly hides the mechanics from the body of your code:+--+-- > insertSong :: UUID -> Text -> Text -> Maybe Text -> Cas ()+-- > insertSong id title artist comment = executeWrite QUORUM q (id, title, artist, comment)+-- >      where q = "insert into songs (id, title, artist, comment) values (?, ?, ?, ?)"+-- -- /To do/ -- -- * Add credentials.@@ -97,7 +100,7 @@         Pool,         newPool,         -- * Cassandra monad-        MonadCassandra,+        MonadCassandra(..),         Cas,         runCas,         CassandraException(..),@@ -115,12 +118,12 @@         executeRows,         executeRow,         -- * Value types-        CasType(..),-        CasValues(..),         Blob(..),         Counter(..),         TimeUUID(..),         metadataTypes,+        CasType(..),+        CasValues(..),         -- * Lower-level interfaces         executeRaw,         Result(..),@@ -196,7 +199,7 @@     }  class MonadCatchIO m => MonadCassandra m where-    getEltsandraPool :: m Pool+    getCassandraPool :: m Pool  -- | Construct a pool of Cassandra connections. newPool :: [Server] -> Keyspace -> IO Pool@@ -536,7 +539,7 @@  withSession :: MonadCassandra m => (Pool -> StateT ActiveSession IO a) -> m a withSession code = do-    pool <- getEltsandraPool+    pool <- getCassandraPool     mA <- liftIO $ do         session <- connectIfNeeded pool =<< takeSession pool         case sesActive session of@@ -640,9 +643,29 @@  -- | A type class for types that can be used in query arguments or column values in -- returned results.+--+-- To define your own newtypes for Cassandra data, you only need to define 'getCas',+-- 'putCas' and 'casType', like this:+--+-- > instance CasType UserId where+-- >     getCas = UserId <$> getCas+-- >     putCas (UserId i) = putCas i+-- >     casType (UserId i) = casType i+--+-- If you have a more complex type you want to store as a Cassandra blob, you could+-- write an instance like this (assuming we're it's an instance of the /cereal/ package's+-- 'Serialize' class):+--+-- > instance CasType User where+-- >     getCas = decode . unBlob <$> getCas+-- >     putCas = putCas . Blob . encode+-- >     casType _ = CBlob+ class CasType a where     getCas :: Get a     putCas :: a -> Put+    -- | For a given Haskell type given as ('undefined' :: a), tell the caller how Cassandra+    -- represents it.     casType :: a -> CType     casNothing :: a     casNothing = error "casNothing impossible"@@ -670,7 +693,7 @@  -- | If you wrap this round a 'ByteString', it will be treated as a /blob/ type -- instead of /ascii/ (if it was a plain 'ByteString' type).-newtype Blob = Blob ByteString+newtype Blob = Blob { unBlob :: ByteString }     deriving (Eq, Ord, Show)  instance CasType Blob where@@ -685,7 +708,7 @@     casType _ = CBoolean  -- | A Cassandra distributed counter value.-newtype Counter = Counter Int64+newtype Counter = Counter { unCounter :: Int64 }     deriving (Eq, Ord, Show, Read)  instance CasType Counter where@@ -779,7 +802,7 @@  -- | If you wrap this round a 'UUID' then it is treated as a /timeuuid/ type instead of -- /uuid/ (if it was a plain 'UUID' type).-newtype TimeUUID = TimeUUID UUID deriving (Eq, Data, Ord, Read, Show, Typeable)+newtype TimeUUID = TimeUUID { unTimeUUID :: UUID } deriving (Eq, Data, Ord, Read, Show, Typeable)  instance CasType TimeUUID where     getCas = TimeUUID <$> getCas@@ -1334,7 +1357,7 @@     deriving (Functor, Applicative, Monad, MonadIO, MonadCatchIO)  instance MonadCassandra Cas where-    getEltsandraPool = Cas ask+    getCassandraPool = Cas ask  -- | Execute Cassandra queries. runCas :: Pool -> Cas a -> IO a

@@ -1,5 +1,5 @@ name:                cassandra-cql-version:             0.2.0.0+version:             0.2.0.1 synopsis:            Haskell client for Cassandra's CQL protocol description:            Haskell client for Cassandra's CQL protocol