AnyEvent::Riak::Documentation - AnyEvent Riak Client documentation
version 0.91
Get bucket properties request
required, string
optional, string
Set bucket properties request
required, RpbBucketProps
Reset bucket properties request
Authentication request
Client id to use for this connection
Get Request - retrieve bucket/key
optional, number
optional, boolean
fail if the supplied vclock does not match
return everything but the value
return the tombstone's vclock, if applicable
Experimental, may change/disappear
Bucket type, if not set we assume the 'default' type
Put request - if options.return_body is set then the updated metadata/data for the key will be returned.
required, RpbContent
Delete request
List buckets request
List keys in bucket request
Map/Reduce request
Secondary Index query request
required, one of 'eq', 'range'
key here means equals value for index?
Whether to use pagination sort for non-paginated queries=back
added solely for riak_cs currently for folding over a bucket and returning objects.
Counter update request
required, sint64
counter value
Error response - may be generated for any Req
required, number
Get server info request - no message defined, just send RpbGetServerInfoReq message code
Get bucket properties response
Get ClientId Request - no message defined, just send RpbGetClientIdReq message code
Client id in use for this connection
Get Response - if the record was not found there will be no content/vclock
repeated, RpbContent
the opaque vector clock for the object
Put response - same as get response with optional key if one was generated
the key generated, if any
List buckets response - one or more of these packets will be sent the last one will have done set true (and may not have any buckets in it)
repeated, string
List keys in bucket response - one or more of these packets will be sent the last one will have done set true (and may not have any keys in it)
Map/Reduce response one or more of these packets will be sent the last one will have done set true (and may not have phase/data in it)
Secondary Index query response
repeated, RpbPair
return for CS bucket fold
repeated, RpbIndexObject
Counter update response? No message | error response
optional, sint64
Counter value response
Key/value pair - used for user metadata, indexes, search doc fields=item value
Module-Function pairs for commit hooks and other bucket properties that take functions=item function
optional, RpbModFun
A commit hook, which may either be a modfun or a JavaScript named function=item name
Bucket properties. Declared in riak_core_app=item allow_mult
repeated, RpbCommitHook
Declared in riak_kv_app=item old_vclock
Used by riak_kv_multi_backend=item search
Used by riak_search bucket fixup=item repl
optional, one of 'FALSE', 'REALTIME', 'FULLSYNC', 'TRUE'
Used by riak_repl bucket fixup=item search_index
Search index=item datatype
KV Datatypes=item consistent
KV strong consistency=back
required, RpbGetResp
Content message included in get/put responses. Holds the value and associated metadata=item content_type
the media type/format
repeated, RpbLink
links to other resources
user metadata stored with the object
Link metadata=item key
Damien Krotkine <dams@cpan.org>
This software is copyright (c) 2014 by Damien Krotkine.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
7 POD Errors
The following errors were encountered while parsing the POD:
You forgot a '=back' before '=head2'
'=item' outside of any '=over'
To install AnyEvent::Riak, copy and paste the appropriate command in to your terminal.
cpanm
cpanm AnyEvent::Riak
CPAN shell
perl -MCPAN -e shell install AnyEvent::Riak
For more information on module installation, please visit the detailed CPAN module installation guide.