Network.Riak.Types.Internal

Basic types.

Client management

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

Show Client

Typeable * Client

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

Show Connection

Errors

data RiakException

The main Riak exception type.

Instances

Eq RiakException

Show RiakException

Exception RiakException

Typeable * RiakException

netError :: String -> String -> String -> a

typeError :: String -> String -> String -> a

unexError :: String -> String -> String -> a

Data types

type Bucket = ByteString

A Bucket is a container and keyspace for data stored in Riak, with a set of common properties for its contents (the number of replicas, for instance).

type BucketType = ByteString

Bucket types is a riak >= 2.0 feature allowing groups of buckets to share configuration details

type Key = ByteString

Keys are unique object identifiers in Riak and are scoped within buckets.

type Index = ByteString

Name of a secondary index

data IndexQuery

Index query. Can be exact or range, int or bin. Index name should not contain the "_bin" or "_int" part, since it's determined from data constructor.

Constructors

IndexQueryExactInt !Index !Int

IndexQueryExactBin !Index !ByteString

IndexQueryRangeInt !Index !Int !Int

IndexQueryRangeBin !Index !ByteString !ByteString

Instances

Eq IndexQuery

Show IndexQuery

data IndexValue

Constructors

IndexInt !Index !Int

IndexBin !Index !ByteString

Instances

Eq IndexValue

Show IndexValue

type Tag = ByteString

An application-specific identifier for a link. See http://wiki.basho.com/Links.html for details.

type SearchQuery = ByteString

Search request

data SearchResult

Solr search result

Constructors

SearchResult

Fields

bucketType :: BucketType

bucket type

bucket :: Bucket

bucket

key :: Key

key

score :: Maybe Score

score, if provided

Instances

Eq SearchResult

Show SearchResult

type IndexInfo = YzIndex

Search index info

newtype VClock

A wrapper that keeps Riak vector clocks opaque.

Constructors

VClock

Fields

fromVClock :: ByteString

Unwrap the ByteString. (This is really only useful for printing the raw vclock string.)

Instances

Eq VClock

Show VClock

Typeable * VClock

data Job

A specification of a MapReduce job. http://wiki.basho.com/MapReduce.html.

Constructors

JSON ByteString

Erlang ByteString

Instances

Eq Job

Show Job

Typeable * Job

Quorum 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

Enum Quorum

Eq Quorum

Ord Quorum

Show Quorum

Typeable * Quorum

type DW = Quorum

Durable write quorum. How many replicas to commit to durable storage before returning a successful response.

type R = Quorum

Read quorum. How many replicas need to agree when retrieving a value.

type RW = Quorum

Read/write quorum. How many replicas need to collaborate when deleting a value.

type W = Quorum

Write quorum. How many replicas to write to before returning a successful response.

fromQuorum :: Quorum -> Maybe Word32

toQuorum :: Word32 -> Maybe Quorum

Message identification

class (Tagged msg, ReflectDescriptor msg, Show msg, Wire msg) => Request msg where

A message representing a request from client to server.

Methods

expectedResponse :: msg -> MessageTag

Instances

Request GetClientIDRequest

Request GetServerInfoRequest

Request ListBucketsRequest

Request MapReduceRequest

Request PingRequest

Request DeleteRequest

Request GetBucketRequest

Request GetRequest

Request IndexRequest

Request ListKeysRequest

Request PutRequest

Request SetBucketRequest

Request GetBucketTypeRequest

Request SearchQueryRequest

Request YzIndexGetRequest

Request SetClientIDRequest

Request DtFetchRequest

Request DtUpdateRequest

class (Tagged msg, ReflectDescriptor msg, Show msg, Wire msg) => Response msg

A message representing a response from server to client.

Instances

Response DtFetchResponse

Response GetBucketResponse

Response GetClientIDResponse

Response GetResponse

Response ListBucketsResponse

Response PutResponse

Response SearchQueryResponse

Response YzIndexGetResponse

Response ErrorResponse

Response IndexResponse

Response ListKeysResponse

Response MapReduce

Response ServerInfo

Response DtUpdateResponse

class (Request req, Response resp) => Exchange req resp | req -> resp

Instances

Exchange GetClientIDRequest GetClientIDResponse

Exchange GetServerInfoRequest ServerInfo

Exchange ListBucketsRequest ListBucketsResponse

Exchange MapReduceRequest MapReduce

Exchange GetBucketRequest GetBucketResponse

Exchange GetRequest GetResponse

Exchange IndexRequest IndexResponse

Exchange PutRequest PutResponse

Exchange GetBucketTypeRequest GetBucketResponse

Exchange SearchQueryRequest SearchQueryResponse

Exchange YzIndexGetRequest YzIndexGetResponse

Exchange DtFetchRequest DtFetchResponse

Exchange DtUpdateRequest DtUpdateResponse

data MessageTag

List of (known to us) inbound or outbound message identifiers.

Constructors

ErrorResponse

PingRequest

PingResponse

GetClientIDRequest

GetClientIDResponse

SetClientIDRequest

SetClientIDResponse

GetServerInfoRequest

GetServerInfoResponse

GetRequest

GetResponse

PutRequest

PutResponse

DeleteRequest

DeleteResponse

ListBucketsRequest

ListBucketsResponse

ListKeysRequest

ListKeysResponse

GetBucketRequest

GetBucketResponse

SetBucketRequest

SetBucketResponse

GetBucketTypeRequest

MapReduceRequest

MapReduceResponse

IndexRequest

IndexResponse

DtFetchRequest

DtFetchResponse

DtUpdateRequest

DtUpdateResponse

SearchQueryRequest

SearchQueryResponse

YokozunaIndexGetRequest

YokozunaIndexGetResponse

Instances

Eq MessageTag

Show MessageTag

Generic MessageTag

Hashable MessageTag

Tagged MessageTag

type Rep MessageTag

class Tagged msg where

Messages are tagged.

Methods

messageTag

Arguments

:: msg

-> MessageTag

Retrieve a message's tag.

Instances

Tagged DtFetchResponse

Tagged MessageTag

Tagged GetClientIDRequest

Tagged GetServerInfoRequest

Tagged ListBucketsRequest

Tagged MapReduceRequest

Tagged PingRequest

Tagged DeleteRequest

Tagged GetBucketRequest

Tagged GetRequest

Tagged IndexRequest

Tagged ListKeysRequest

Tagged PutRequest

Tagged SetBucketRequest

Tagged GetBucketTypeRequest

Tagged SearchQueryRequest

Tagged YzIndexGetRequest

Tagged GetBucketResponse

Tagged GetClientIDResponse

Tagged GetResponse

Tagged ListBucketsResponse

Tagged PutResponse

Tagged SearchQueryResponse

Tagged YzIndexGetResponse

Tagged ErrorResponse

Tagged IndexResponse

Tagged ListKeysResponse

Tagged MapReduce

Tagged ServerInfo

Tagged SetClientIDRequest

Tagged DtFetchRequest

Tagged DtUpdateRequest

Tagged DtUpdateResponse

(Tagged a, Tagged b) => Tagged (Either a b)