com.basho.riak.client.operations

Class CounterObject

java.lang.Object

com.basho.riak.client.operations.CounterObject

All Implemented Interfaces:

RiakOperation<Long>

public class CounterObject
extends Object
implements RiakOperation<Long>

A new feature in Riak 1.4 is counters. These are implemented via convergent data types.

A counter is uniquely identified by its name (key) in a bucket. The first time you increment a counter, it is created. A counter can be decremented by incrementing it by a negative value;

 // Create and increment a counter by 1
 CounterObject c = bucket.counter("myCounter");
 Long l = c.increment(1L).returnValue(true).execute();
 
 // fetch an existing counter value
 l = bucket.counter("myCounter").execute();
 
 

Author:

Brian Roach

See Also:

A Comprehensive study of Convergent and Commutative Replicated Data Types

Constructor Summary

Constructors

Constructor and Description
CounterObject(RawClient rawClient, String bucket, String counter)

Method Summary

Methods

Modifier and Type	Method and Description
CounterObject	basicQuorum(boolean basicQuorum) fail early if a quorum of error/notfounds are reached before a successful read (for a fetch operation)
CounterObject	dw(int dw) The durable write quorum for an increment operation
CounterObject	dw(Quora dw) The durable write quorum for for an increment operation
CounterObject	dw(Quorum dw) The durable write quorum for an increment operation
Long	execute() Execute this counter operation
CounterObject	increment(Long increment)
CounterObject	notFoundOK(boolean notFoundOK) if notfound_ok counts towards r count (for a fetch operation)
CounterObject	pr(int pr) The pr for a fetch operation
CounterObject	pr(Quora pr) The pr for a fetch operation
CounterObject	pr(Quorum pr) The pr for a fetch operation
CounterObject	pw(int pw) Set the primary write quorum for an increment operation, takes precedence over w.
CounterObject	pw(Quora pw) Set the primary write quorum for an increment operation, takes precedence over w.
CounterObject	pw(Quorum pw) Set the primary write quorum for an increment operation, takes precedence over w.
CounterObject	r(int r) Set the read quorum for a fetch operation
CounterObject	r(Quora r) Set the read quorum for a fetch operation
CounterObject	r(Quorum r) Set the read quorum for a fetch operation
CounterObject	returnValue(boolean returnValue) Should an increment operation return the new value?
CounterObject	w(int w) Set the write quorum for an increment operation
CounterObject	w(Quora w) Set the write quorum for an increment operation
CounterObject	w(Quorum w) Set the write quorum for an increment operation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CounterObject

public CounterObject(RawClient rawClient,
             String bucket,
             String counter)

Method Detail

increment

public CounterObject increment(Long increment)

pw

public CounterObject pw(int pw)

Set the primary write quorum for an increment operation, takes precedence over w.

Parameters:

pw -

Returns:

this

See Also:

StoreMeta.Builder.pw(int)

pw

public CounterObject pw(Quora pw)

Set the primary write quorum for an increment operation, takes precedence over w.

Parameters:

pw -

Returns:

this

See Also:

StoreMeta.Builder.pw(com.basho.riak.client.cap.Quora)

pw

public CounterObject pw(Quorum pw)

Set the primary write quorum for an increment operation, takes precedence over w.

Parameters:

pw -

Returns:

this

See Also:

StoreMeta.Builder.pw(com.basho.riak.client.cap.Quorum)

w

public CounterObject w(int w)

Set the write quorum for an increment operation

Parameters:

w -

Returns:

this

See Also:

StoreMeta.Builder.w(int)

w

public CounterObject w(Quora w)

Set the write quorum for an increment operation

Parameters:

w -

Returns:

this

See Also:

StoreMeta.Builder.w(com.basho.riak.client.cap.Quora)

w

public CounterObject w(Quorum w)

Set the write quorum for an increment operation

Parameters:

w -

Returns:

this

See Also:

StoreMeta.Builder.w(com.basho.riak.client.cap.Quorum)

dw

public CounterObject dw(int dw)

The durable write quorum for an increment operation

Parameters:

dw -

Returns:

this

See Also:

StoreMeta.Builder.dw(int)

dw

public CounterObject dw(Quora dw)

The durable write quorum for for an increment operation

Parameters:

dw -

Returns:

this

See Also:

StoreMeta.Builder.dw(com.basho.riak.client.cap.Quora)

dw

public CounterObject dw(Quorum dw)

The durable write quorum for an increment operation

Parameters:

dw -

Returns:

this

See Also:

StoreMeta.Builder.dw(com.basho.riak.client.cap.Quorum)

returnValue

public CounterObject returnValue(boolean returnValue)

Should an increment operation return the new value?

Parameters:

returnValue -

Returns:

this

r

public CounterObject r(int r)

Set the read quorum for a fetch operation

Parameters:

r - the read quorum for the pre-store fetch

Returns:

this

See Also:

FetchMeta.Builder.r(int)

r

public CounterObject r(Quora r)

Set the read quorum for a fetch operation

Parameters:

r - the read quorum for the pre-store fetch

Returns:

this

See Also:

FetchMeta.Builder.r(com.basho.riak.client.cap.Quora)

r

public CounterObject r(Quorum r)

Set the read quorum for a fetch operation

Parameters:

r - the read quorum for the pre-store fetch

Returns:

this

See Also:

FetchMeta.Builder.r(com.basho.riak.client.cap.Quorum)

pr

public CounterObject pr(int pr)

The pr for a fetch operation

Parameters:

pr -

Returns:

this

See Also:

FetchMeta.Builder.pr(int)

pr

public CounterObject pr(Quora pr)

The pr for a fetch operation

Parameters:

pr -

Returns:

this

See Also:

FetchMeta.Builder.pr(com.basho.riak.client.cap.Quora)

pr

public CounterObject pr(Quorum pr)

The pr for a fetch operation

Parameters:

pr -

Returns:

this

See Also:

FetchMeta.Builder.pr(Quorum)

notFoundOK

public CounterObject notFoundOK(boolean notFoundOK)

if notfound_ok counts towards r count (for a fetch operation)

Parameters:

notFoundOK -

Returns:

this

See Also:

FetchMeta.Builder.notFoundOK(boolean)

basicQuorum

public CounterObject basicQuorum(boolean basicQuorum)

fail early if a quorum of error/notfounds are reached before a successful read (for a fetch operation)

Parameters:

basicQuorum -

Returns:

this

See Also:

FetchMeta.Builder.basicQuorum(boolean)

execute

public Long execute()
             throws RiakException

Execute this counter operation

Specified by:

execute in interface RiakOperation<Long>

Returns:

The value of the counter or null if the counter does not exist or an increment is performed has not specified to return the new value via returnValue(boolean)

Throws:

RiakException