com.allanbank.mongodb.builder

Class ParallelScan

java.lang.Object

com.allanbank.mongodb.builder.ParallelScan

public class ParallelScan
extends Object

ParallelScan provides an immutable container for all of the options for a parallelCollectionScan.

Note: The parallelCollectionScan does not work with sharded clusters.

See Also:

parallelCollectionScan Command

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2014, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParallelScan.Builder Helper for creating immutable ParallelScan queries.

Field Summary

Fields

Modifier and Type	Field and Description
static Version	REQUIRED_VERSION The first version of MongoDB to support the parallelCollectionScan command.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParallelScan(ParallelScan.Builder builder) Creates a new ParallelScan.

Method Summary

Methods

Modifier and Type	Method and Description
static ParallelScan.Builder	builder() Creates a new builder for a ParallelScan.
int	getBatchSize() Returns the number of documents to be returned in each batch of results.
ReadPreference	getReadPreference() Returns the preference for the servers to retrieve the results from.
int	getRequestedIteratorCount() Returns the requested number of iterators/cursors to create.

Methods inherited from class java.lang.Object

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

Field Detail

REQUIRED_VERSION

public static final Version REQUIRED_VERSION

The first version of MongoDB to support the parallelCollectionScan command.

Constructor Detail

ParallelScan

protected ParallelScan(ParallelScan.Builder builder)

Creates a new ParallelScan.

Parameters:

builder - The builder to copy the query fields from.

Method Detail

builder

public static ParallelScan.Builder builder()

Creates a new builder for a ParallelScan.

Returns:

The builder to construct a ParallelScan.

getBatchSize

public int getBatchSize()

Returns the number of documents to be returned in each batch of results.

Returns:

The number of documents to be returned in each batch of results.

getReadPreference

public ReadPreference getReadPreference()

Returns the preference for the servers to retrieve the results from. May be null in which case the default read preference should be used.

Returns:

The preference for the servers to retrieve the results from.

getRequestedIteratorCount

public int getRequestedIteratorCount()

Returns the requested number of iterators/cursors to create. The server may return few than this number of iterators.

This value will be forced into the range [1, 10,000].

Returns:

The requested number of iterators/cursors to create.