Package com.mongodb.operation
Class ParallelCollectionScanOperation<T>
java.lang.Object
com.mongodb.operation.ParallelCollectionScanOperation<T>
- Type Parameters:
T
- the operations result type.
- All Implemented Interfaces:
AsyncReadOperation<List<AsyncBatchCursor<T>>>
,ReadOperation<List<BatchCursor<T>>>
@Deprecated
public class ParallelCollectionScanOperation<T>
extends Object
implements AsyncReadOperation<List<AsyncBatchCursor<T>>>, ReadOperation<List<BatchCursor<T>>>
Deprecated.
Return a list of cursors over the collection that can be used to scan it in parallel.
Note: As of MongoDB 2.6, this operation will work against a mongod, but not a mongos.
- Since:
- 3.0
-
Constructor Summary
ConstructorsConstructorDescriptionParallelCollectionScanOperation
(MongoNamespace namespace, int numCursors, Decoder<T> decoder) Deprecated.Construct a new instance. -
Method Summary
Modifier and TypeMethodDescriptionbatchSize
(int batchSize) Deprecated.The batch size to use for each cursor.List
<BatchCursor<T>> execute
(ReadBinding binding) Deprecated.General execute which can return anything of type Tvoid
executeAsync
(AsyncReadBinding binding, SingleResultCallback<List<AsyncBatchCursor<T>>> callback) Deprecated.General execute which can return anything of type Tint
Deprecated.Gets the batch size to use for each cursor.int
Deprecated.Gets the number of cursors requested.boolean
Deprecated.Gets the value for retryable reads.retryReads
(boolean retryReads) Deprecated.Enables retryable reads if a read fails due to a network error.
-
Constructor Details
-
ParallelCollectionScanOperation
public ParallelCollectionScanOperation(MongoNamespace namespace, int numCursors, Decoder<T> decoder) Deprecated.Construct a new instance.- Parameters:
namespace
- the database and collection namespace for the operation.numCursors
- The maximum number of cursors to return. Must be between 1 and 10000, inclusive.decoder
- the decoder for the result documents.
-
-
Method Details
-
getNumCursors
public int getNumCursors()Deprecated.Gets the number of cursors requested.- Returns:
- number of cursors requested.
-
getBatchSize
public int getBatchSize()Deprecated.Gets the batch size to use for each cursor. The default value is 0, which tells the server to use its own default batch size.- Returns:
- batch size
-
batchSize
Deprecated.The batch size to use for each cursor.- Parameters:
batchSize
- the batch size, which must be greater than or equal to 0- Returns:
- this
-
retryReads
Deprecated.Enables retryable reads if a read fails due to a network error.- Parameters:
retryReads
- true if reads should be retried- Returns:
- this
- Since:
- 3.11
-
getRetryReads
public boolean getRetryReads()Deprecated.Gets the value for retryable reads. The default is true.- Returns:
- the retryable reads value
- Since:
- 3.11
-
execute
Deprecated.Description copied from interface:ReadOperation
General execute which can return anything of type T- Specified by:
execute
in interfaceReadOperation<T>
- Parameters:
binding
- the binding to execute in the context of- Returns:
- T, the result of the execution
-
executeAsync
public void executeAsync(AsyncReadBinding binding, SingleResultCallback<List<AsyncBatchCursor<T>>> callback) Deprecated.Description copied from interface:AsyncReadOperation
General execute which can return anything of type T- Specified by:
executeAsync
in interfaceAsyncReadOperation<T>
- Parameters:
binding
- the binding to execute in the context ofcallback
- the callback to be called when the operation has been executed
-