riak-1.0.0.0: 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.Request

Contents

Description

Smart constructors for Riak types. These functions correctly URL-escape bucket, key, and link names. You should thus use them in preference to the raw data constructors.

Synopsis

Connection management

data PingRequest :: *

Instances

ping :: PingRequest Source

Create a ping request.

data GetClientIDRequest :: *

Instances

getClientID :: GetClientIDRequest Source

Create a client-ID request.

data GetServerInfoRequest :: *

Instances

getServerInfo :: GetServerInfoRequest Source

Create a server-info request.

Data management

data GetRequest :: *

Instances

Eq GetRequest 
Data GetRequest 
Ord GetRequest 
Show GetRequest 
Wire GetRequest 
TextType GetRequest 
TextMsg GetRequest 
ReflectDescriptor GetRequest 
Mergeable GetRequest 
GPB GetRequest 
Default GetRequest 
Request GetRequest 
Tagged GetRequest 
Typeable * GetRequest 
Exchange GetRequest GetResponse 
MessageAPI msg' (msg' -> GetRequest) GetRequest 

get :: Bucket -> Key -> R -> GetRequest Source

Create a get request. The bucket and key names are URL-escaped.

getByIndex :: Bucket -> IndexQuery -> IndexRequest Source

Create a secondary index request. Bucket, key and index names and values are URL-escaped.

data IndexRequest :: *

Instances

data PutRequest :: *

Instances

Eq PutRequest 
Data PutRequest 
Ord PutRequest 
Show PutRequest 
Wire PutRequest 
TextType PutRequest 
TextMsg PutRequest 
ReflectDescriptor PutRequest 
Mergeable PutRequest 
GPB PutRequest 
Default PutRequest 
Request PutRequest 
Tagged PutRequest 
Typeable * PutRequest 
Exchange PutRequest PutResponse 
MessageAPI msg' (msg' -> PutRequest) PutRequest 

put :: Bucket -> Key -> Maybe VClock -> Content -> W -> DW -> Bool -> PutRequest Source

Create a put request. The bucket and key names are URL-escaped. Any Link values inside the Content are assumed to have been constructed with the link function, and hence not escaped.

data DeleteRequest :: *

Instances

delete :: Bucket -> Key -> RW -> DeleteRequest Source

Create a delete request. The bucket and key names are URL-escaped.

Metadata

data Link :: *

link :: Bucket -> Key -> Tag -> Link Source

Create a link. The bucket and key names are URL-escaped.

data ListBucketsRequest :: *

Instances

listBuckets :: Maybe BucketType -> ListBucketsRequest Source

Create a list-buckets request.

data ListKeysRequest :: *

Instances

listKeys :: Maybe BucketType -> Bucket -> ListKeysRequest Source

Create a list-keys request. The bucket type and name are URL-escaped.

data GetBucketRequest :: *

Instances

getBucket :: Maybe BucketType -> Bucket -> GetBucketRequest Source

Create a get-bucket request. The bucket type and name are URL-escaped.

data SetBucketRequest :: *

Instances

setBucket :: Maybe BucketType -> Bucket -> BucketProps -> SetBucketRequest Source

Create a set-bucket request. The bucket type and name are URL-escaped.

getBucketType :: BucketType -> GetBucketTypeRequest Source

Create a get-bucket-type request. The bucket type is URL-escaped.

Map/reduce

data MapReduceRequest :: *

Instances

mapReduce :: Job -> MapReduceRequest Source

Create a map-reduce request.

search :: SearchQuery -> Index -> SearchQueryRequest Source

Create a search request

getIndex :: Maybe Index -> YzIndexGetRequest Source