Copyright | (c) 2011 MailRank, Inc. |
---|---|
License | Apache |
Maintainer | Mark Hibberd <mark@hibberd.id.au>, Nathan Hunter <nhunter@janrain.com> |
Stability | experimental |
Portability | portable |
Safe Haskell | None |
Language | Haskell98 |
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.
- data PingRequest :: *
- ping :: PingRequest
- data GetClientIDRequest :: *
- getClientID :: GetClientIDRequest
- data GetServerInfoRequest :: *
- getServerInfo :: GetServerInfoRequest
- data GetRequest :: *
- get :: Bucket -> Key -> R -> GetRequest
- getByIndex :: Bucket -> IndexQuery -> IndexRequest
- data IndexRequest :: *
- data PutRequest :: *
- put :: Bucket -> Key -> Maybe VClock -> Content -> W -> DW -> Bool -> PutRequest
- data DeleteRequest :: *
- delete :: Bucket -> Key -> RW -> DeleteRequest
- data Link :: *
- link :: Bucket -> Key -> Tag -> Link
- data ListBucketsRequest :: *
- listBuckets :: Maybe BucketType -> ListBucketsRequest
- data ListKeysRequest :: *
- listKeys :: Maybe BucketType -> Bucket -> ListKeysRequest
- data GetBucketRequest :: *
- getBucket :: Maybe BucketType -> Bucket -> GetBucketRequest
- data SetBucketRequest :: *
- setBucket :: Maybe BucketType -> Bucket -> BucketProps -> SetBucketRequest
- getBucketType :: BucketType -> GetBucketTypeRequest
- data MapReduceRequest :: *
- mapReduce :: Job -> MapReduceRequest
- search :: SearchQuery -> Index -> SearchQueryRequest
- getIndex :: Maybe Index -> YzIndexGetRequest
Connection management
data PingRequest :: *
Eq PingRequest | |
Data PingRequest | |
Ord PingRequest | |
Show PingRequest | |
Wire PingRequest | |
TextType PingRequest | |
TextMsg PingRequest | |
ReflectDescriptor PingRequest | |
Mergeable PingRequest | |
GPB PingRequest | |
Default PingRequest | |
MessageAPI msg' (msg' -> PingRequest) PingRequest |
Create a ping request.
data GetClientIDRequest :: *
Eq GetClientIDRequest | |
Data GetClientIDRequest | |
Ord GetClientIDRequest | |
Show GetClientIDRequest | |
Wire GetClientIDRequest | |
TextType GetClientIDRequest | |
TextMsg GetClientIDRequest | |
ReflectDescriptor GetClientIDRequest | |
Mergeable GetClientIDRequest | |
GPB GetClientIDRequest | |
Default GetClientIDRequest | |
MessageAPI msg' (msg' -> GetClientIDRequest) GetClientIDRequest |
getClientID :: GetClientIDRequest Source
Create a client-ID request.
data GetServerInfoRequest :: *
Eq GetServerInfoRequest | |
Data GetServerInfoRequest | |
Ord GetServerInfoRequest | |
Show GetServerInfoRequest | |
Wire GetServerInfoRequest | |
TextType GetServerInfoRequest | |
TextMsg GetServerInfoRequest | |
ReflectDescriptor GetServerInfoRequest | |
Mergeable GetServerInfoRequest | |
GPB GetServerInfoRequest | |
Default GetServerInfoRequest | |
MessageAPI msg' (msg' -> GetServerInfoRequest) GetServerInfoRequest |
getServerInfo :: GetServerInfoRequest Source
Create a server-info request.
Data management
data GetRequest :: *
Eq GetRequest | |
Data GetRequest | |
Ord GetRequest | |
Show GetRequest | |
Wire GetRequest | |
TextType GetRequest | |
TextMsg GetRequest | |
ReflectDescriptor GetRequest | |
Mergeable GetRequest | |
GPB GetRequest | |
Default GetRequest | |
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 :: *
Eq IndexRequest | |
Data IndexRequest | |
Ord IndexRequest | |
Show IndexRequest | |
Wire IndexRequest | |
TextType IndexRequest | |
TextMsg IndexRequest | |
ReflectDescriptor IndexRequest | |
Mergeable IndexRequest | |
GPB IndexRequest | |
Default IndexRequest | |
MessageAPI msg' (msg' -> IndexRequest) IndexRequest |
data PutRequest :: *
Eq PutRequest | |
Data PutRequest | |
Ord PutRequest | |
Show PutRequest | |
Wire PutRequest | |
TextType PutRequest | |
TextMsg PutRequest | |
ReflectDescriptor PutRequest | |
Mergeable PutRequest | |
GPB PutRequest | |
Default PutRequest | |
MessageAPI msg' (msg' -> PutRequest) PutRequest |
data DeleteRequest :: *
Eq DeleteRequest | |
Data DeleteRequest | |
Ord DeleteRequest | |
Show DeleteRequest | |
Wire DeleteRequest | |
TextType DeleteRequest | |
TextMsg DeleteRequest | |
ReflectDescriptor DeleteRequest | |
Mergeable DeleteRequest | |
GPB DeleteRequest | |
Default DeleteRequest | |
MessageAPI msg' (msg' -> DeleteRequest) DeleteRequest |
delete :: Bucket -> Key -> RW -> DeleteRequest Source
Create a delete request. The bucket and key names are URL-escaped.
Metadata
data Link :: *
data ListBucketsRequest :: *
Eq ListBucketsRequest | |
Data ListBucketsRequest | |
Ord ListBucketsRequest | |
Show ListBucketsRequest | |
Wire ListBucketsRequest | |
TextType ListBucketsRequest | |
TextMsg ListBucketsRequest | |
ReflectDescriptor ListBucketsRequest | |
Mergeable ListBucketsRequest | |
GPB ListBucketsRequest | |
Default ListBucketsRequest | |
MessageAPI msg' (msg' -> ListBucketsRequest) ListBucketsRequest |
listBuckets :: Maybe BucketType -> ListBucketsRequest Source
Create a list-buckets request.
data ListKeysRequest :: *
Eq ListKeysRequest | |
Data ListKeysRequest | |
Ord ListKeysRequest | |
Show ListKeysRequest | |
Wire ListKeysRequest | |
TextType ListKeysRequest | |
TextMsg ListKeysRequest | |
ReflectDescriptor ListKeysRequest | |
Mergeable ListKeysRequest | |
GPB ListKeysRequest | |
Default ListKeysRequest | |
MessageAPI msg' (msg' -> ListKeysRequest) ListKeysRequest |
listKeys :: Maybe BucketType -> Bucket -> ListKeysRequest Source
Create a list-keys request. The bucket type and name are URL-escaped.
data GetBucketRequest :: *
Eq GetBucketRequest | |
Data GetBucketRequest | |
Ord GetBucketRequest | |
Show GetBucketRequest | |
Wire GetBucketRequest | |
TextType GetBucketRequest | |
TextMsg GetBucketRequest | |
ReflectDescriptor GetBucketRequest | |
Mergeable GetBucketRequest | |
GPB GetBucketRequest | |
Default GetBucketRequest | |
MessageAPI msg' (msg' -> GetBucketRequest) GetBucketRequest |
getBucket :: Maybe BucketType -> Bucket -> GetBucketRequest Source
Create a get-bucket request. The bucket type and name are URL-escaped.
data SetBucketRequest :: *
Eq SetBucketRequest | |
Data SetBucketRequest | |
Ord SetBucketRequest | |
Show SetBucketRequest | |
Wire SetBucketRequest | |
TextType SetBucketRequest | |
TextMsg SetBucketRequest | |
ReflectDescriptor SetBucketRequest | |
Mergeable SetBucketRequest | |
GPB SetBucketRequest | |
Default SetBucketRequest | |
MessageAPI msg' (msg' -> SetBucketRequest) SetBucketRequest |
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 :: *
Eq MapReduceRequest | |
Data MapReduceRequest | |
Ord MapReduceRequest | |
Show MapReduceRequest | |
Wire MapReduceRequest | |
TextType MapReduceRequest | |
TextMsg MapReduceRequest | |
ReflectDescriptor MapReduceRequest | |
Mergeable MapReduceRequest | |
GPB MapReduceRequest | |
Default MapReduceRequest | |
MessageAPI msg' (msg' -> MapReduceRequest) MapReduceRequest |
mapReduce :: Job -> MapReduceRequest Source
Create a map-reduce request.
search :: SearchQuery -> Index -> SearchQueryRequest Source
Create a search request