Network.Riak.Basic

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.

Client configuration and identification

type ClientID = ByteString

A client identifier. This is used by the Riak cluster when logging vector clock changes, and should be unique for each client.

data Client

Constructors

Client

Fields

• host :: HostName

  Name of the server to connect to.

• port :: ServiceName

  Port number to connect to (default is 8087).

• clientID :: ClientID

  Client identifier.

Instances

Eq Client

Defined in Network.Riak.Types.Internal

Methods

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

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

Show Client

Defined in Network.Riak.Types.Internal

Methods

showsPrec :: Int -> Client -> ShowS

show :: Client -> String

showList :: [Client] -> ShowS

defaultClient :: Client

Default client configuration. Talks to localhost, port 8087, with a randomly chosen client ID.

Connection management

data Connection

A connection to a Riak server.

Constructors

Connection

Fields

• connSock :: Socket
• connClient :: Client

  The configuration we connected with.

• connBuffer :: IORef ByteString

  Received data that has not yet been consumed.

Instances

Eq Connection

Defined in Network.Riak.Types.Internal

Methods

(==) :: Connection -> Connection -> Bool

(/=) :: Connection -> Connection -> Bool

Show Connection

Defined in Network.Riak.Types.Internal

Methods

showsPrec :: Int -> Connection -> ShowS

show :: Connection -> String

showList :: [Connection] -> ShowS

connect :: Client -> IO Connection

Connect to a server.

disconnect :: Connection -> IO ()

Disconnect from a server.

ping :: Connection -> IO ()

Check to see if the connection to the server is alive.

getClientID :: Connection -> IO ClientID

Find out from the server what client ID this connection is using.

setClientID :: Connection -> ClientID -> IO ()

Tell the server our client ID.

getServerInfo :: Connection -> IO RpbGetServerInfoResp

Retrieve information about the server.

Data management

data Quorum

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

Defined in Network.Riak.Types.Internal

Methods

minBound :: Quorum

maxBound :: Quorum

Enum Quorum

Defined in Network.Riak.Types.Internal

Methods

succ :: Quorum -> Quorum

pred :: Quorum -> Quorum

toEnum :: Int -> Quorum

fromEnum :: Quorum -> Int

enumFrom :: Quorum -> [Quorum]

enumFromThen :: Quorum -> Quorum -> [Quorum]

enumFromTo :: Quorum -> Quorum -> [Quorum]

enumFromThenTo :: Quorum -> Quorum -> Quorum -> [Quorum]

Eq Quorum

Defined in Network.Riak.Types.Internal

Methods

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

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

Ord Quorum

Defined in Network.Riak.Types.Internal

Methods

compare :: Quorum -> Quorum -> Ordering

(<) :: Quorum -> Quorum -> Bool

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

(>) :: Quorum -> Quorum -> Bool

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

max :: Quorum -> Quorum -> Quorum

min :: Quorum -> Quorum -> Quorum

Show Quorum

Defined in Network.Riak.Types.Internal

Methods

showsPrec :: Int -> Quorum -> ShowS

show :: Quorum -> String

showList :: [Quorum] -> ShowS

get :: Connection -> Maybe BucketType -> Bucket -> Key -> R -> IO (Maybe ([RpbContent], VClock))

Retrieve a value. This may return multiple conflicting siblings. Choosing among them is your responsibility.

put :: Connection -> Maybe BucketType -> Bucket -> Key -> Maybe VClock -> RpbContent -> W -> DW -> IO ([RpbContent], VClock)

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 -> RpbContent -> W -> DW -> IO ()

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

Delete a value.

Metadata

listBuckets :: Connection -> Maybe BucketType -> IO [Bucket]

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

Fold over the keys in a bucket.

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

getBucket :: Connection -> Maybe BucketType -> Bucket -> IO RpbBucketProps

Retrieve the properties of a bucket.

setBucket :: Connection -> Maybe BucketType -> Bucket -> RpbBucketProps -> IO ()

Store new properties for a bucket.

getBucketType :: Connection -> BucketType -> IO RpbBucketProps

Gets the bucket properties associated with a bucket type.

Map/reduce

mapReduce :: Connection -> Job -> (a -> RpbMapRedResp -> a) -> a -> IO a

Run a MapReduce job. Its result is consumed via a strict left fold.