NAME

AnyEvent::Riak::Documentation - AnyEvent Riak Client documentation

VERSION

version 0.90

METHODS

get_bucket

Get bucket properties request

bucket

required, string

type

optional, string

set_bucket

Set bucket properties request

bucket

required, string

props

required, RpbBucketProps

type

optional, string

reset_bucket

Reset bucket properties request

bucket

required, string

type

optional, string

get_bucket_type

Get bucket properties request

type

required, string

set_bucket_type

Set bucket properties request

type

required, string

props

required, RpbBucketProps

auth

Authentication request

user

required, string

password

required, string

set_client_id

client_id

required, string

Client id to use for this connection

get

Get Request - retrieve bucket/key

bucket

required, string

key

required, string

r

optional, number

pr

optional, number

basic_quorum

optional, boolean

notfound_ok

optional, boolean

if_modified

optional, string

fail if the supplied vclock does not match

head

optional, boolean

return everything but the value

deletedvclock

optional, boolean

return the tombstone's vclock, if applicable

timeout

optional, number

sloppy_quorum

optional, boolean

Experimental, may change/disappear

n_val

optional, number

Experimental, may change/disappear

type

optional, string

Bucket type, if not set we assume the 'default' type

put

Put request - if options.return_body is set then the updated metadata/data for the key will be returned.

bucket

required, string

key

optional, string

vclock

optional, string

content

required, RpbContent

w

optional, number

dw

optional, number

return_body

optional, boolean

pw

optional, number

if_not_modified

optional, boolean

if_none_match

optional, boolean

return_head

optional, boolean

timeout

optional, number

asis

optional, boolean

sloppy_quorum

optional, boolean

Experimental, may change/disappear

n_val

optional, number

Experimental, may change/disappear

type

optional, string

Bucket type, if not set we assume the 'default' type

del

Delete request

bucket

required, string

key

required, string

rw

optional, number

vclock

optional, string

r

optional, number

w

optional, number

pr

optional, number

pw

optional, number

dw

optional, number

timeout

optional, number

sloppy_quorum

optional, boolean

Experimental, may change/disappear

n_val

optional, number

Experimental, may change/disappear

type

optional, string

Bucket type, if not set we assume the 'default' type

list_buckets

List buckets request

timeout

optional, number

stream

optional, boolean

type

optional, string

Bucket type, if not set we assume the 'default' type

list_keys

List keys in bucket request

bucket

required, string

timeout

optional, number

type

optional, string

Bucket type, if not set we assume the 'default' type

map_red

Map/Reduce request

request

required, string

content_type

required, string

index

Secondary Index query request

bucket

required, string

index

required, string

qtype

required, one of 'eq', 'range'

key

optional, string

key here means equals value for index?

range_min

optional, string

range_max

optional, string

return_terms

optional, boolean

stream

optional, boolean

max_results

optional, number

continuation

optional, string

timeout

optional, number

type

optional, string

Bucket type, if not set we assume the 'default' type

term_regex

optional, string

pagination_sort

optional, boolean

Whether to use pagination sort for non-paginated queries=back

CS_bucket

added solely for riak_cs currently for folding over a bucket and returning objects.

bucket

required, string

start_key

required, string

end_key

optional, string

start_incl

optional, boolean

end_incl

optional, boolean

continuation

optional, string

max_results

optional, number

timeout

optional, number

type

optional, string

Bucket type, if not set we assume the 'default' type

counter_update

Counter update request

bucket

required, string

key

required, string

amount

required, sint64

w

optional, number

dw

optional, number

pw

optional, number

returnvalue

optional, boolean

counter_get

counter value

bucket

required, string

key

required, string

r

optional, number

pr

optional, number

basic_quorum

optional, boolean

notfound_ok

optional, boolean

RESPONSE OBJECTS

RpbErrorResp

Error response - may be generated for any Req

errmsg

required, string

errcode

required, number

RpbGetServerInfoResp

Get server info request - no message defined, just send RpbGetServerInfoReq message code

node

optional, string

server_version

optional, string

RpbGetBucketResp

Get bucket properties response

props

required, RpbBucketProps

RpbGetClientIdResp

Get ClientId Request - no message defined, just send RpbGetClientIdReq message code

client_id

required, string

Client id in use for this connection

RpbGetResp

Get Response - if the record was not found there will be no content/vclock

content

repeated, RpbContent

vclock

optional, string

the opaque vector clock for the object

unchanged

optional, boolean

RpbPutResp

Put response - same as get response with optional key if one was generated

content

repeated, RpbContent

vclock

optional, string

the opaque vector clock for the object

key

optional, string

the key generated, if any

RpbListBucketsResp

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)

buckets

repeated, string

done

optional, boolean

RpbListKeysResp

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)

keys

repeated, string

done

optional, boolean

RpbMapRedResp

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)

phase

optional, number

response

optional, string

done

optional, boolean

RpbIndexResp

Secondary Index query response

keys

repeated, string

results

repeated, RpbPair

continuation

optional, string

done

optional, boolean

RpbCSBucketResp

return for CS bucket fold

objects

repeated, RpbIndexObject

continuation

optional, string

done

optional, boolean

RpbCounterUpdateResp

Counter update response? No message | error response

value

optional, sint64

RpbCounterGetResp

Counter value response

value

optional, sint64

OTHER OBJECTS

key

required, string

Key/value pair - used for user metadata, indexes, search doc fields=item value

optional, string

module

required, string

Module-Function pairs for commit hooks and other bucket properties that take functions=item function

required, string

modfun

optional, RpbModFun

A commit hook, which may either be a modfun or a JavaScript named function=item name

optional, string

n_val

optional, number

Bucket properties. Declared in riak_core_app=item allow_mult

optional, boolean

last_write_wins

optional, boolean

precommit

repeated, RpbCommitHook

has_precommit

optional, boolean

postcommit

repeated, RpbCommitHook

has_postcommit

optional, boolean

chash_keyfun

optional, RpbModFun

linkfun

optional, RpbModFun

Declared in riak_kv_app=item old_vclock

optional, number

young_vclock

optional, number

big_vclock

optional, number

small_vclock

optional, number

pr

optional, number

r

optional, number

w

optional, number

pw

optional, number

dw

optional, number

rw

optional, number

basic_quorum

optional, boolean

notfound_ok

optional, boolean

backend

optional, string

Used by riak_kv_multi_backend=item search

optional, boolean

Used by riak_search bucket fixup=item repl

optional, one of 'FALSE', 'REALTIME', 'FULLSYNC', 'TRUE'

Used by riak_repl bucket fixup=item search_index

optional, string

Search index=item datatype

optional, string

KV Datatypes=item consistent

optional, boolean

KV strong consistency=back

key

required, string

object

required, RpbGetResp

value

required, string

Content message included in get/put responses. Holds the value and associated metadata=item content_type

optional, string

the media type/format

charset

optional, string

content_encoding

optional, string

vtag

optional, string

links

repeated, RpbLink

links to other resources

last_mod

optional, number

last_mod_usecs

optional, number

usermeta

repeated, RpbPair

user metadata stored with the object

indexes

repeated, RpbPair

user metadata stored with the object

deleted

optional, boolean

bucket

optional, string

Link metadata=item key

optional, string

tag

optional, string

AUTHOR

Damien Krotkine <dams@cpan.org>

COPYRIGHT AND LICENSE

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.

cpanm AnyEvent::Riak

perl -MCPAN -e shell
install AnyEvent::Riak