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 | Haskell2010 |
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
- data RpbPingReq
- ping :: RpbPingReq
- data RpbGetClientIdReq
- getClientID :: RpbGetClientIdReq
- data RpbGetServerInfoReq
- getServerInfo :: RpbGetServerInfoReq
- data RpbGetReq
- get :: Maybe BucketType -> Bucket -> Key -> R -> RpbGetReq
- getByIndex :: Bucket -> IndexQuery -> RpbIndexReq
- data RpbIndexReq
- data RpbPutReq
- put :: Maybe BucketType -> Bucket -> Key -> Maybe VClock -> RpbContent -> W -> DW -> Bool -> RpbPutReq
- data RpbDelReq
- delete :: Maybe BucketType -> Bucket -> Key -> RW -> RpbDelReq
- data RpbLink
- link :: Bucket -> Key -> Tag -> RpbLink
- data RpbListBucketsReq
- listBuckets :: Maybe BucketType -> RpbListBucketsReq
- data RpbListKeysReq
- listKeys :: Maybe BucketType -> Bucket -> RpbListKeysReq
- data RpbGetBucketReq
- getBucket :: Maybe BucketType -> Bucket -> RpbGetBucketReq
- data RpbSetBucketReq
- setBucket :: Maybe BucketType -> Bucket -> RpbBucketProps -> RpbSetBucketReq
- getBucketType :: BucketType -> RpbGetBucketTypeReq
- data RpbMapRedReq
- mapReduce :: Job -> RpbMapRedReq
- search :: SearchQuery -> Index -> RpbSearchQueryReq
- getIndex :: Maybe Index -> RpbYokozunaIndexGetReq
- putIndex :: IndexInfo -> Maybe Timeout -> RpbYokozunaIndexPutReq
- deleteIndex :: Index -> RpbYokozunaIndexDeleteReq
Connection management
data RpbPingReq #
Fields :
Instances
ping :: RpbPingReq Source #
Create a ping request.
data RpbGetClientIdReq #
Fields :
Instances
getClientID :: RpbGetClientIdReq Source #
Create a client-ID request.
data RpbGetServerInfoReq #
Fields :
Instances
getServerInfo :: RpbGetServerInfoReq Source #
Create a server-info request.
Data management
Fields :
bucket
:: Lens' RpbGetReq Data.ByteString.ByteString
key
:: Lens' RpbGetReq Data.ByteString.ByteString
r
:: Lens' RpbGetReq Data.Word.Word32
maybe'r
:: Lens' RpbGetReq (Prelude.Maybe Data.Word.Word32)
pr
:: Lens' RpbGetReq Data.Word.Word32
maybe'pr
:: Lens' RpbGetReq (Prelude.Maybe Data.Word.Word32)
basicQuorum
:: Lens' RpbGetReq Prelude.Bool
maybe'basicQuorum
:: Lens' RpbGetReq (Prelude.Maybe Prelude.Bool)
notfoundOk
:: Lens' RpbGetReq Prelude.Bool
maybe'notfoundOk
:: Lens' RpbGetReq (Prelude.Maybe Prelude.Bool)
ifModified
:: Lens' RpbGetReq Data.ByteString.ByteString
maybe'ifModified
:: Lens' RpbGetReq (Prelude.Maybe Data.ByteString.ByteString)
head
:: Lens' RpbGetReq Prelude.Bool
maybe'head
:: Lens' RpbGetReq (Prelude.Maybe Prelude.Bool)
deletedvclock
:: Lens' RpbGetReq Prelude.Bool
maybe'deletedvclock
:: Lens' RpbGetReq (Prelude.Maybe Prelude.Bool)
timeout
:: Lens' RpbGetReq Data.Word.Word32
maybe'timeout
:: Lens' RpbGetReq (Prelude.Maybe Data.Word.Word32)
sloppyQuorum
:: Lens' RpbGetReq Prelude.Bool
maybe'sloppyQuorum
:: Lens' RpbGetReq (Prelude.Maybe Prelude.Bool)
nVal
:: Lens' RpbGetReq Data.Word.Word32
maybe'nVal
:: Lens' RpbGetReq (Prelude.Maybe Data.Word.Word32)
type'
:: Lens' RpbGetReq Data.ByteString.ByteString
maybe'type'
:: Lens' RpbGetReq (Prelude.Maybe Data.ByteString.ByteString)
Instances
get :: Maybe BucketType -> Bucket -> Key -> R -> RpbGetReq Source #
Create a get request. The bucket and key names are URL-escaped.
getByIndex :: Bucket -> IndexQuery -> RpbIndexReq Source #
Create a secondary index request. Bucket, key and index names and values are URL-escaped.
data RpbIndexReq #
Fields :
bucket
:: Lens' RpbIndexReq Data.ByteString.ByteString
index
:: Lens' RpbIndexReq Data.ByteString.ByteString
qtype
:: Lens' RpbIndexReq RpbIndexReq'IndexQueryType
key
:: Lens' RpbIndexReq Data.ByteString.ByteString
maybe'key
:: Lens' RpbIndexReq (Prelude.Maybe Data.ByteString.ByteString)
rangeMin
:: Lens' RpbIndexReq Data.ByteString.ByteString
maybe'rangeMin
:: Lens' RpbIndexReq (Prelude.Maybe Data.ByteString.ByteString)
rangeMax
:: Lens' RpbIndexReq Data.ByteString.ByteString
maybe'rangeMax
:: Lens' RpbIndexReq (Prelude.Maybe Data.ByteString.ByteString)
returnTerms
:: Lens' RpbIndexReq Prelude.Bool
maybe'returnTerms
:: Lens' RpbIndexReq (Prelude.Maybe Prelude.Bool)
stream
:: Lens' RpbIndexReq Prelude.Bool
maybe'stream
:: Lens' RpbIndexReq (Prelude.Maybe Prelude.Bool)
maxResults
:: Lens' RpbIndexReq Data.Word.Word32
maybe'maxResults
:: Lens' RpbIndexReq (Prelude.Maybe Data.Word.Word32)
continuation
:: Lens' RpbIndexReq Data.ByteString.ByteString
maybe'continuation
:: Lens' RpbIndexReq (Prelude.Maybe Data.ByteString.ByteString)
timeout
:: Lens' RpbIndexReq Data.Word.Word32
maybe'timeout
:: Lens' RpbIndexReq (Prelude.Maybe Data.Word.Word32)
type'
:: Lens' RpbIndexReq Data.ByteString.ByteString
maybe'type'
:: Lens' RpbIndexReq (Prelude.Maybe Data.ByteString.ByteString)
termRegex
:: Lens' RpbIndexReq Data.ByteString.ByteString
maybe'termRegex
:: Lens' RpbIndexReq (Prelude.Maybe Data.ByteString.ByteString)
paginationSort
:: Lens' RpbIndexReq Prelude.Bool
maybe'paginationSort
:: Lens' RpbIndexReq (Prelude.Maybe Prelude.Bool)
coverContext
:: Lens' RpbIndexReq Data.ByteString.ByteString
maybe'coverContext
:: Lens' RpbIndexReq (Prelude.Maybe Data.ByteString.ByteString)
returnBody
:: Lens' RpbIndexReq Prelude.Bool
maybe'returnBody
:: Lens' RpbIndexReq (Prelude.Maybe Prelude.Bool)
Instances
Fields :
bucket
:: Lens' RpbPutReq Data.ByteString.ByteString
key
:: Lens' RpbPutReq Data.ByteString.ByteString
maybe'key
:: Lens' RpbPutReq (Prelude.Maybe Data.ByteString.ByteString)
vclock
:: Lens' RpbPutReq Data.ByteString.ByteString
maybe'vclock
:: Lens' RpbPutReq (Prelude.Maybe Data.ByteString.ByteString)
content
:: Lens' RpbPutReq RpbContent
w
:: Lens' RpbPutReq Data.Word.Word32
maybe'w
:: Lens' RpbPutReq (Prelude.Maybe Data.Word.Word32)
dw
:: Lens' RpbPutReq Data.Word.Word32
maybe'dw
:: Lens' RpbPutReq (Prelude.Maybe Data.Word.Word32)
returnBody
:: Lens' RpbPutReq Prelude.Bool
maybe'returnBody
:: Lens' RpbPutReq (Prelude.Maybe Prelude.Bool)
pw
:: Lens' RpbPutReq Data.Word.Word32
maybe'pw
:: Lens' RpbPutReq (Prelude.Maybe Data.Word.Word32)
ifNotModified
:: Lens' RpbPutReq Prelude.Bool
maybe'ifNotModified
:: Lens' RpbPutReq (Prelude.Maybe Prelude.Bool)
ifNoneMatch
:: Lens' RpbPutReq Prelude.Bool
maybe'ifNoneMatch
:: Lens' RpbPutReq (Prelude.Maybe Prelude.Bool)
returnHead
:: Lens' RpbPutReq Prelude.Bool
maybe'returnHead
:: Lens' RpbPutReq (Prelude.Maybe Prelude.Bool)
timeout
:: Lens' RpbPutReq Data.Word.Word32
maybe'timeout
:: Lens' RpbPutReq (Prelude.Maybe Data.Word.Word32)
asis
:: Lens' RpbPutReq Prelude.Bool
maybe'asis
:: Lens' RpbPutReq (Prelude.Maybe Prelude.Bool)
sloppyQuorum
:: Lens' RpbPutReq Prelude.Bool
maybe'sloppyQuorum
:: Lens' RpbPutReq (Prelude.Maybe Prelude.Bool)
nVal
:: Lens' RpbPutReq Data.Word.Word32
maybe'nVal
:: Lens' RpbPutReq (Prelude.Maybe Data.Word.Word32)
type'
:: Lens' RpbPutReq Data.ByteString.ByteString
maybe'type'
:: Lens' RpbPutReq (Prelude.Maybe Data.ByteString.ByteString)
Instances
put :: Maybe BucketType -> Bucket -> Key -> Maybe VClock -> RpbContent -> W -> DW -> Bool -> RpbPutReq 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.
Fields :
bucket
:: Lens' RpbDelReq Data.ByteString.ByteString
key
:: Lens' RpbDelReq Data.ByteString.ByteString
rw
:: Lens' RpbDelReq Data.Word.Word32
maybe'rw
:: Lens' RpbDelReq (Prelude.Maybe Data.Word.Word32)
vclock
:: Lens' RpbDelReq Data.ByteString.ByteString
maybe'vclock
:: Lens' RpbDelReq (Prelude.Maybe Data.ByteString.ByteString)
r
:: Lens' RpbDelReq Data.Word.Word32
maybe'r
:: Lens' RpbDelReq (Prelude.Maybe Data.Word.Word32)
w
:: Lens' RpbDelReq Data.Word.Word32
maybe'w
:: Lens' RpbDelReq (Prelude.Maybe Data.Word.Word32)
pr
:: Lens' RpbDelReq Data.Word.Word32
maybe'pr
:: Lens' RpbDelReq (Prelude.Maybe Data.Word.Word32)
pw
:: Lens' RpbDelReq Data.Word.Word32
maybe'pw
:: Lens' RpbDelReq (Prelude.Maybe Data.Word.Word32)
dw
:: Lens' RpbDelReq Data.Word.Word32
maybe'dw
:: Lens' RpbDelReq (Prelude.Maybe Data.Word.Word32)
timeout
:: Lens' RpbDelReq Data.Word.Word32
maybe'timeout
:: Lens' RpbDelReq (Prelude.Maybe Data.Word.Word32)
sloppyQuorum
:: Lens' RpbDelReq Prelude.Bool
maybe'sloppyQuorum
:: Lens' RpbDelReq (Prelude.Maybe Prelude.Bool)
nVal
:: Lens' RpbDelReq Data.Word.Word32
maybe'nVal
:: Lens' RpbDelReq (Prelude.Maybe Data.Word.Word32)
type'
:: Lens' RpbDelReq Data.ByteString.ByteString
maybe'type'
:: Lens' RpbDelReq (Prelude.Maybe Data.ByteString.ByteString)
Instances
delete :: Maybe BucketType -> Bucket -> Key -> RW -> RpbDelReq Source #
Create a delete request. The bucket and key names are URL-escaped.
Metadata
Fields :
bucket
:: Lens' RpbLink Data.ByteString.ByteString
maybe'bucket
:: Lens' RpbLink (Prelude.Maybe Data.ByteString.ByteString)
key
:: Lens' RpbLink Data.ByteString.ByteString
maybe'key
:: Lens' RpbLink (Prelude.Maybe Data.ByteString.ByteString)
tag
:: Lens' RpbLink Data.ByteString.ByteString
maybe'tag
:: Lens' RpbLink (Prelude.Maybe Data.ByteString.ByteString)
Instances
link :: Bucket -> Key -> Tag -> RpbLink Source #
Create a link. The bucket and key names are URL-escaped.
data RpbListBucketsReq #
Fields :
timeout
:: Lens' RpbListBucketsReq Data.Word.Word32
maybe'timeout
:: Lens' RpbListBucketsReq (Prelude.Maybe Data.Word.Word32)
stream
:: Lens' RpbListBucketsReq Prelude.Bool
maybe'stream
:: Lens' RpbListBucketsReq (Prelude.Maybe Prelude.Bool)
type'
:: Lens' RpbListBucketsReq Data.ByteString.ByteString
maybe'type'
:: Lens' RpbListBucketsReq (Prelude.Maybe Data.ByteString.ByteString)
Instances
listBuckets :: Maybe BucketType -> RpbListBucketsReq Source #
Create a list-buckets request.
data RpbListKeysReq #
Fields :
bucket
:: Lens' RpbListKeysReq Data.ByteString.ByteString
timeout
:: Lens' RpbListKeysReq Data.Word.Word32
maybe'timeout
:: Lens' RpbListKeysReq (Prelude.Maybe Data.Word.Word32)
type'
:: Lens' RpbListKeysReq Data.ByteString.ByteString
maybe'type'
:: Lens' RpbListKeysReq (Prelude.Maybe Data.ByteString.ByteString)
Instances
listKeys :: Maybe BucketType -> Bucket -> RpbListKeysReq Source #
Create a list-keys request. The bucket type and name are URL-escaped.
data RpbGetBucketReq #
Fields :
bucket
:: Lens' RpbGetBucketReq Data.ByteString.ByteString
type'
:: Lens' RpbGetBucketReq Data.ByteString.ByteString
maybe'type'
:: Lens' RpbGetBucketReq (Prelude.Maybe Data.ByteString.ByteString)
Instances
getBucket :: Maybe BucketType -> Bucket -> RpbGetBucketReq Source #
Create a get-bucket request. The bucket type and name are URL-escaped.
data RpbSetBucketReq #
Fields :
bucket
:: Lens' RpbSetBucketReq Data.ByteString.ByteString
props
:: Lens' RpbSetBucketReq RpbBucketProps
type'
:: Lens' RpbSetBucketReq Data.ByteString.ByteString
maybe'type'
:: Lens' RpbSetBucketReq (Prelude.Maybe Data.ByteString.ByteString)
Instances
setBucket :: Maybe BucketType -> Bucket -> RpbBucketProps -> RpbSetBucketReq Source #
Create a set-bucket request. The bucket type and name are URL-escaped.
getBucketType :: BucketType -> RpbGetBucketTypeReq Source #
Create a get-bucket-type request. The bucket type is URL-escaped.
Map/reduce
data RpbMapRedReq #
Fields :
request
:: Lens' RpbMapRedReq Data.ByteString.ByteString
contentType
:: Lens' RpbMapRedReq Data.ByteString.ByteString
Instances
mapReduce :: Job -> RpbMapRedReq Source #
Create a map-reduce request.
Search
search :: SearchQuery -> Index -> RpbSearchQueryReq Source #
Create a search request