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.Types.Internal

Contents

Description

Basic types.

Synopsis

Client management

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

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

Errors

Data types

type Bucket = ByteString Source #

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 Source #

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

type Key = ByteString Source #

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

type Index = ByteString Source #

Name of a secondary index

type Schema = ByteString Source #

Name of an index schema

data IndexQuery Source #

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.

Instances
Eq IndexQuery Source # 
Instance details

Defined in Network.Riak.Types.Internal

Show IndexQuery Source # 
Instance details

Defined in Network.Riak.Types.Internal

type Tag = ByteString Source #

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

type SearchQuery = ByteString Source #

Search request

type Score = Double Source #

Search result score

type IndexInfo = YzIndex Source #

Search index info

newtype VClock Source #

A wrapper that keeps Riak vector clocks opaque.

Constructors

VClock 

Fields

Instances
Eq VClock Source # 
Instance details

Defined in Network.Riak.Types.Internal

Methods

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

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

Show VClock Source # 
Instance details

Defined in Network.Riak.Types.Internal

data Job Source #

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

Instances
Eq Job Source # 
Instance details

Defined in Network.Riak.Types.Internal

Methods

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

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

Show Job Source # 
Instance details

Defined in Network.Riak.Types.Internal

Methods

showsPrec :: Int -> Job -> ShowS #

show :: Job -> String #

showList :: [Job] -> ShowS #

type Timeout = Word32 Source #

Timeout in milliseconds

Quorum 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

type DW = Quorum Source #

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

type R = Quorum Source #

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

type RW = Quorum Source #

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

type W = Quorum Source #

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

Message identification

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

A message representing a request from client to server.

Instances
Request YzIndexPutRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request YzIndexGetRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request YzIndexDeleteRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request DtUpdateRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request SetClientIDRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request SetBucketRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request SearchQueryRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request PutRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request PingRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request MapReduceRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request ListKeysRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request ListBucketsRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request IndexRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request GetServerInfoRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request GetRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request GetClientIDRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request GetBucketTypeRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request GetBucketRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request DtFetchRequest Source # 
Instance details

Defined in Network.Riak.Tag

Request DeleteRequest Source # 
Instance details

Defined in Network.Riak.Tag

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

A message representing a response from server to client.

Instances
Response YzIndexGetResponse Source # 
Instance details

Defined in Network.Riak.Tag

Response ServerInfo Source # 
Instance details

Defined in Network.Riak.Tag

Response SearchQueryResponse Source # 
Instance details

Defined in Network.Riak.Tag

Response PutResponse Source # 
Instance details

Defined in Network.Riak.Tag

Response GetResponse Source # 
Instance details

Defined in Network.Riak.Tag

Response IndexResponse Source # 
Instance details

Defined in Network.Riak.Tag

Response GetBucketResponse Source # 
Instance details

Defined in Network.Riak.Tag

Response MapReduce Source # 
Instance details

Defined in Network.Riak.Tag

Response DtUpdateResponse Source # 
Instance details

Defined in Network.Riak.Tag

Response DtFetchResponse Source # 
Instance details

Defined in Network.Riak.Tag

Response ListKeysResponse Source # 
Instance details

Defined in Network.Riak.Tag

Response ListBucketsResponse Source # 
Instance details

Defined in Network.Riak.Tag

Response GetClientIDResponse Source # 
Instance details

Defined in Network.Riak.Tag

Response ErrorResponse Source # 
Instance details

Defined in Network.Riak.Tag

data MessageTag Source #

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

Instances
Eq MessageTag Source # 
Instance details

Defined in Network.Riak.Types.Internal

Show MessageTag Source # 
Instance details

Defined in Network.Riak.Types.Internal

Generic MessageTag Source # 
Instance details

Defined in Network.Riak.Types.Internal

Associated Types

type Rep MessageTag :: Type -> Type #

Hashable MessageTag Source # 
Instance details

Defined in Network.Riak.Types.Internal

Tagged MessageTag Source # 
Instance details

Defined in Network.Riak.Types.Internal

type Rep MessageTag Source # 
Instance details

Defined in Network.Riak.Types.Internal

type Rep MessageTag = D1 (MetaData "MessageTag" "Network.Riak.Types.Internal" "riak-1.1.2.6-4pln7ObZDPn7ODFUTrYXyq" False) (((((C1 (MetaCons "ErrorResponse" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "PingRequest" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "PingResponse" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "GetClientIDRequest" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "GetClientIDResponse" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SetClientIDRequest" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "SetClientIDResponse" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "GetServerInfoRequest" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "GetServerInfoResponse" PrefixI False) (U1 :: Type -> Type))))) :+: (((C1 (MetaCons "GetRequest" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "GetResponse" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "PutRequest" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "PutResponse" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "DeleteRequest" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "DeleteResponse" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ListBucketsRequest" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "ListBucketsResponse" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "ListKeysRequest" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ListKeysResponse" PrefixI False) (U1 :: Type -> Type)))))) :+: ((((C1 (MetaCons "GetBucketRequest" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "GetBucketResponse" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "SetBucketRequest" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SetBucketResponse" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "GetBucketTypeRequest" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "MapReduceRequest" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "MapReduceResponse" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "IndexRequest" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "IndexResponse" PrefixI False) (U1 :: Type -> Type))))) :+: (((C1 (MetaCons "DtFetchRequest" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "DtFetchResponse" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "DtUpdateRequest" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "DtUpdateResponse" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SearchQueryRequest" PrefixI False) (U1 :: Type -> Type)))) :+: ((C1 (MetaCons "SearchQueryResponse" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "YokozunaIndexGetRequest" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "YokozunaIndexGetResponse" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "YokozunaIndexPutRequest" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "YokozunaIndexDeleteRequest" PrefixI False) (U1 :: Type -> Type)))))))

class Tagged msg where Source #

Messages are tagged.

Methods

messageTag Source #

Arguments

:: msg 
-> MessageTag

Retrieve a message's tag.

Instances
Tagged YzIndexPutRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged YzIndexGetResponse Source # 
Instance details

Defined in Network.Riak.Tag

Tagged YzIndexGetRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged YzIndexDeleteRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged DtUpdateRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged SetClientIDRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged SetBucketRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged ServerInfo Source # 
Instance details

Defined in Network.Riak.Tag

Tagged SearchQueryResponse Source # 
Instance details

Defined in Network.Riak.Tag

Tagged SearchQueryRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged PutResponse Source # 
Instance details

Defined in Network.Riak.Tag

Tagged PutRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged PingRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged GetResponse Source # 
Instance details

Defined in Network.Riak.Tag

Tagged IndexResponse Source # 
Instance details

Defined in Network.Riak.Tag

Tagged GetBucketResponse Source # 
Instance details

Defined in Network.Riak.Tag

Tagged MapReduceRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged MapReduce Source # 
Instance details

Defined in Network.Riak.Tag

Tagged DtUpdateResponse Source # 
Instance details

Defined in Network.Riak.Tag

Tagged DtFetchResponse Source # 
Instance details

Defined in Network.Riak.Tag

Tagged ListKeysResponse Source # 
Instance details

Defined in Network.Riak.Tag

Tagged ListKeysRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged ListBucketsResponse Source # 
Instance details

Defined in Network.Riak.Tag

Tagged ListBucketsRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged IndexRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged GetServerInfoRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged GetRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged GetClientIDResponse Source # 
Instance details

Defined in Network.Riak.Tag

Tagged GetClientIDRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged GetBucketTypeRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged GetBucketRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged ErrorResponse Source # 
Instance details

Defined in Network.Riak.Tag

Tagged DtFetchRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged DeleteRequest Source # 
Instance details

Defined in Network.Riak.Tag

Tagged MessageTag Source # 
Instance details

Defined in Network.Riak.Types.Internal