Copyright | (c) 2011 MailRank, Inc. |
---|---|
License | Apache |
Maintainer | Mark Hibberd <mark@hibberd.id.au>, Nathan Hunter <nhunter@janrain.com> |
Stability | experimental |
Portability | portable |
Safe Haskell | None |
Language | Haskell98 |
Basic support for the Riak decentralized data store.
When storing and retrieving data, the functions in this module do not perform any encoding or decoding of data, nor do they resolve conflicts.
- type ClientID = ByteString
- data Client = Client {}
- defaultClient :: Client
- data Connection = Connection {
- connSock :: Socket
- connClient :: Client
- connBuffer :: IORef ByteString
- connect :: Client -> IO Connection
- disconnect :: Connection -> IO ()
- ping :: Connection -> IO ()
- getClientID :: Connection -> IO ClientID
- setClientID :: Connection -> ClientID -> IO ()
- getServerInfo :: Connection -> IO ServerInfo
- data Quorum
- get :: Connection -> Bucket -> Key -> R -> IO (Maybe (Seq Content, VClock))
- put :: Connection -> Bucket -> Key -> Maybe VClock -> Content -> W -> DW -> IO (Seq Content, VClock)
- put_ :: Connection -> Bucket -> Key -> Maybe VClock -> Content -> W -> DW -> IO ()
- delete :: Connection -> Bucket -> Key -> RW -> IO ()
- listBuckets :: Connection -> Maybe BucketType -> IO (Seq Bucket)
- foldKeys :: MonadIO m => Connection -> Maybe BucketType -> Bucket -> (a -> Key -> m a) -> a -> m a
- getBucket :: Connection -> Maybe BucketType -> Bucket -> IO BucketProps
- setBucket :: Connection -> Maybe BucketType -> Bucket -> BucketProps -> IO ()
- getBucketType :: Connection -> BucketType -> IO BucketProps
- mapReduce :: Connection -> Job -> (a -> MapReduce -> a) -> a -> IO a
Client configuration and identification
type ClientID = ByteString Source
A client identifier. This is used by the Riak cluster when logging vector clock changes, and should be unique for each client.
defaultClient :: Client Source
Default client configuration. Talks to localhost, port 8087, with a randomly chosen client ID.
Connection management
data Connection Source
A connection to a Riak server.
Connection | |
|
connect :: Client -> IO Connection Source
Connect to a server.
disconnect :: Connection -> IO () Source
Disconnect from a server.
ping :: Connection -> IO () Source
Check to see if the connection to the server is alive.
getClientID :: Connection -> IO ClientID Source
Find out from the server what client ID this connection is using.
setClientID :: Connection -> ClientID -> IO () Source
Tell the server our client ID.
getServerInfo :: Connection -> IO ServerInfo Source
Retrieve information about the server.
Data management
A read/write quorum. The quantity of replicas that must respond
to a read or write request before it is considered successful. This
is defined as a bucket property or as one of the relevant
parameters to a single request (R
,W
,DW
,RW
).
get :: Connection -> Bucket -> Key -> R -> IO (Maybe (Seq Content, VClock)) Source
Retrieve a value. This may return multiple conflicting siblings. Choosing among them is your responsibility.
put :: Connection -> Bucket -> Key -> Maybe VClock -> Content -> W -> DW -> IO (Seq Content, VClock) Source
Store a single value. This may return multiple conflicting siblings. Choosing among them, and storing a new value, is your responsibility.
You should only supply Nothing
as a VClock
if you are sure
that the given bucket+key combination does not already exist. If
you omit a VClock
but the bucket+key does exist, your value
will not be stored.
put_ :: Connection -> Bucket -> Key -> Maybe VClock -> Content -> W -> DW -> IO () Source
Store a single value, without the possibility of conflict resolution.
You should only supply Nothing
as a VClock
if you are sure
that the given bucket+key combination does not already exist. If
you omit a VClock
but the bucket+key does exist, your value
will not be stored, and you will not be notified.
Metadata
listBuckets :: Connection -> Maybe BucketType -> IO (Seq Bucket) Source
foldKeys :: MonadIO m => Connection -> Maybe BucketType -> Bucket -> (a -> Key -> m a) -> a -> m a Source
getBucket :: Connection -> Maybe BucketType -> Bucket -> IO BucketProps Source
Retrieve the properties of a bucket.
setBucket :: Connection -> Maybe BucketType -> Bucket -> BucketProps -> IO () Source
Store new properties for a bucket.
getBucketType :: Connection -> BucketType -> IO BucketProps Source
Gets the bucket properties associated with a bucket type.
Map/reduce
mapReduce :: Connection -> Job -> (a -> MapReduce -> a) -> a -> IO a Source
Run a MapReduce
job. Its result is consumed via a strict left
fold.