com.basho.riak.client.api.commands.kv

Class FullBucketRead

java.lang.Object

com.basho.riak.client.api.RiakCommand<S,U>

com.basho.riak.client.api.commands.indexes.SecondaryIndexQuery<BinaryValue,FullBucketRead.Response,FullBucketRead>

com.basho.riak.client.api.commands.kv.FullBucketRead

public class FullBucketRead
extends SecondaryIndexQuery<BinaryValue,FullBucketRead.Response,FullBucketRead>

Command used to retrieve all values from Riak bucket.

Command might be executed with or without CoveragePlanOperation.Response.CoverageEntry. If coverage entry/context is provided, the only primary writes that related to the coverage context will be returned, otherwise all data will be returned. All execution options may be used in conjunction with coverage context. Unlike 2i queries, FullBucketRead may return values/objects as part of the response and, as a result, it has better performance. To activate this option you need to set SecondaryIndexQuery.returnBody parameter. Note that this command mustn't be used without coverage context for querying buckets that contain a big amount of data.

Author:

Sergey Galkin

See Also:

CoveragePlan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FullBucketRead.Builder Builder used to construct a FullBucketRead command.
protected class	FullBucketRead.RawQueryFuture
static class	FullBucketRead.Response

Nested classes/interfaces inherited from class com.basho.riak.client.api.commands.indexes.SecondaryIndexQuery

SecondaryIndexQuery.IndexConverter<T>, SecondaryIndexQuery.Init<S,T extends SecondaryIndexQuery.Init<S,T>>, SecondaryIndexQuery.Type

Field Summary

Fields inherited from class com.basho.riak.client.api.commands.indexes.SecondaryIndexQuery

continuation, coverageContext, end, indexName, match, maxResults, namespace, paginationSort, returnBody, returnTerms, start, termFilter, timeout

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FullBucketRead(FullBucketRead.Builder builder)

Method Summary

Modifier and Type	Method and Description
protected RiakFuture<FullBucketRead.Response,FullBucketRead>	executeAsync(RiakCluster cluster)
protected SecondaryIndexQuery.IndexConverter<BinaryValue>	getConverter()

Methods inherited from class com.basho.riak.client.api.commands.indexes.SecondaryIndexQuery

createCoreQuery, equals, executeCoreAsync, getContinuation, getIndexName, getMatchValue, getMaxResults, getNamespace, getPaginationSort, getRangeEnd, getRangeStart, getReturnKeyAndIndex, getTermFilter, getTimeout, hashCode, toString

Methods inherited from class com.basho.riak.client.api.RiakCommand

execute, execute

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FullBucketRead

protected FullBucketRead(FullBucketRead.Builder builder)

Method Detail

getConverter

protected SecondaryIndexQuery.IndexConverter<BinaryValue> getConverter()

Specified by:

getConverter in class SecondaryIndexQuery<BinaryValue,FullBucketRead.Response,FullBucketRead>

executeAsync

protected RiakFuture<FullBucketRead.Response,FullBucketRead> executeAsync(RiakCluster cluster)

Specified by:

executeAsync in class RiakCommand<FullBucketRead.Response,FullBucketRead>