riak-1.1.2.6: A Haskell client for the Riak decentralized data store

Copyright(c) 2011 MailRank Inc.
LicenseApache
MaintainerMark Hibberd <mark@hibberd.id.au>, Nathan Hunter <nhunter@janrain.com>
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell98

Network.Riak.Basic

Contents

Description

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.

Synopsis

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.

data Client Source #

Constructors

Client 

Fields

Instances
Eq Client Source # 
Instance details

Defined in Network.Riak.Types.Internal

Methods

(==) :: Client -> Client -> Bool #

(/=) :: Client -> Client -> Bool #

Show Client Source # 
Instance details

Defined in Network.Riak.Types.Internal

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.

Constructors

Connection 

Fields

Instances
Eq Connection Source # 
Instance details

Defined in Network.Riak.Types.Internal

Show Connection Source # 
Instance details

Defined in Network.Riak.Types.Internal

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

data Quorum Source #

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).

Constructors

Default

Use the default quorum settings for the bucket.

One

Success after one server has responded.

Quorum

Success after a quorum of servers has responded.

All

Success after all servers have responded.

Instances
Bounded Quorum Source # 
Instance details

Defined in Network.Riak.Types.Internal

Enum Quorum Source # 
Instance details

Defined in Network.Riak.Types.Internal

Eq Quorum Source # 
Instance details

Defined in Network.Riak.Types.Internal

Methods

(==) :: Quorum -> Quorum -> Bool #

(/=) :: Quorum -> Quorum -> Bool #

Ord Quorum Source # 
Instance details

Defined in Network.Riak.Types.Internal

Show Quorum Source # 
Instance details

Defined in Network.Riak.Types.Internal

get :: Connection -> Maybe BucketType -> 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 -> Maybe BucketType -> 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 type+bucket+key combination does not already exist. If you omit a VClock but the type+bucket+key does exist, your value will not be stored.

put_ :: Connection -> Maybe BucketType -> 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 type+bucket+key combination does not already exist. If you omit a VClock but the type+bucket+key does exist, your value will not be stored, and you will not be notified.

delete :: Connection -> Maybe BucketType -> Bucket -> Key -> RW -> IO () Source #

Delete a value.

Metadata

listBuckets :: Connection -> Maybe BucketType -> IO (Seq Bucket) Source #

List the buckets in the cluster.

Note: this operation is expensive. Do not use it in production.

foldKeys :: MonadIO m => Connection -> Maybe BucketType -> Bucket -> (a -> Key -> m a) -> a -> m a Source #

Fold over the keys in a bucket.

Note: this operation is expensive. Do not use it in production.

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.