Package oracle.kv.table
Class TableIteratorOptions
- java.lang.Object
-
- oracle.kv.table.ReadOptions
-
- oracle.kv.table.TableIteratorOptions
-
public class TableIteratorOptions extends ReadOptions
TableIteratorOptions extends ReadOptions and is passed to read-only store operations that return iterators. It is used to specify non-default behavior. Default behavior is configured when a store is opened usingKVStoreConfig
.- Since:
- 3.0
-
-
Constructor Summary
Constructors Constructor Description TableIteratorOptions(Direction direction, Consistency consistency, long timeout, TimeUnit timeoutUnit)
Creates aTableIteratorOptions
with the specified parameters.TableIteratorOptions(Direction direction, Consistency consistency, long timeout, TimeUnit timeoutUnit, int maxConcurrentRequests, int batchResultsSize)
Creates aTableIteratorOptions
with the specified parameters, includingmaxConcurrentRequests
andbatchResultsSize
values.TableIteratorOptions(Direction direction, Consistency consistency, long timeout, TimeUnit timeoutUnit, int maxConcurrentRequests, int batchResultsSize, int maxResultsBatches)
Deprecated.since 3.4, no longer supported.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Direction
getDirection()
Returns the direction.int
getMaxConcurrentRequests()
Returns the maximum number of concurrent requests, or0
if no maximum was specified.int
getMaxResultsBatches()
Deprecated.since 3.4, no longer supported.int
getResultsBatchSize()
Returns the number of results per request, or0
if no value was specified.-
Methods inherited from class oracle.kv.table.ReadOptions
getConsistency, getTimeout, getTimeoutUnit
-
-
-
-
Constructor Detail
-
TableIteratorOptions
public TableIteratorOptions(Direction direction, Consistency consistency, long timeout, TimeUnit timeoutUnit)
Creates aTableIteratorOptions
with the specified parameters. Equivalent toTableIteratorOptions(direction, consistency, timeout, timeoutUnit, 0, 0)
.- Parameters:
direction
- a directionconsistency
- the read consistency or nulltimeout
- the request timeout or 0timeoutUnit
- theTimeUnit
for thetimeout
parameter or null- Throws:
IllegalArgumentException
- if direction is null, the timeout is negative, or timeout is > 0 and timeoutUnit is null
-
TableIteratorOptions
public TableIteratorOptions(Direction direction, Consistency consistency, long timeout, TimeUnit timeoutUnit, int maxConcurrentRequests, int batchResultsSize)
Creates aTableIteratorOptions
with the specified parameters, includingmaxConcurrentRequests
andbatchResultsSize
values.If
consistency
isnull
, thedefault consistency
is used. Iftimeout
is zero thedefault request timeout
is used.maxConcurrentRequests
specifies the maximum degree of parallelism to be used when running an iteration. SettingmaxConcurrentRequests
to 1 causes the iteration to be performed using only a single thread. Setting it to 0 lets the KV Client determine the degree of concurrency based on topology information (up to a maximum of the number of available processors as returned by java.lang.Runtime.availableProcessors()). Values less than 0 cause anIllegalArgumentException
to be thrown.- Parameters:
direction
- a directionconsistency
- the read consistency or nulltimeout
- the request timeout or 0timeoutUnit
- theTimeUnit
for thetimeout
parameter or nullmaxConcurrentRequests
- the maximum number of concurrent requestsbatchResultsSize
- the number of results per request- Throws:
IllegalArgumentException
- if direction is null, the timeout is negative, timeout is > 0 and timeoutUnit is null, or maxConcurrentRequests or batchResultsSize is less than 0- Since:
- 3.4
-
TableIteratorOptions
@Deprecated public TableIteratorOptions(Direction direction, Consistency consistency, long timeout, TimeUnit timeoutUnit, int maxConcurrentRequests, int batchResultsSize, int maxResultsBatches)
Deprecated.since 3.4, no longer supported. replaced byTableIteratorOptions(Direction, Consistency, long, TimeUnit, int, int)
-
-
Method Detail
-
getDirection
public Direction getDirection()
Returns the direction.- Returns:
- the direction
-
getMaxConcurrentRequests
public int getMaxConcurrentRequests()
Returns the maximum number of concurrent requests, or0
if no maximum was specified.- Returns:
- the maximum number of concurrent requests or
0
-
getResultsBatchSize
public int getResultsBatchSize()
Returns the number of results per request, or0
if no value was specified.- Returns:
- the number of results or
0
-
getMaxResultsBatches
@Deprecated public int getMaxResultsBatches()
Deprecated.since 3.4, no longer supported. Returns zero.- Returns:
- zero
-
-