Interface FindPublisher<TResult>
- Type Parameters:
TResult
- The type of the result.
- All Superinterfaces:
Publisher<TResult>
- Since:
- 1.0
-
Method Summary
Modifier and TypeMethodDescriptionallowDiskUse
(Boolean allowDiskUse) Enables writing to temporary files on the server.batchSize
(int batchSize) Sets the number of documents to return per batch.Sets the collation optionsSets the comment to the query.Sets the comment for this operation.cursorType
(CursorType cursorType) Sets the cursor type.explain()
Explain the execution plan for this operation with the server's default verbosity levelexplain
(ExplainVerbosity verbosity) Explain the execution plan for this operation with the given verbosity level<E> Publisher<E>
Explain the execution plan for this operation with the server's default verbosity level<E> Publisher<E>
explain
(Class<E> explainResultClass, ExplainVerbosity verbosity) Explain the execution plan for this operation with the given verbosity levelSets the query filter to apply to the query.first()
Helper to return a publisher limited to the first result.Sets the hint for which index to use.hintString
(String hint) Sets the hint for which index to use.Add top-level variables to the operation.limit
(int limit) Sets the limit to apply.Sets the exclusive upper bound for a specific index.maxAwaitTime
(long maxAwaitTime, TimeUnit timeUnit) The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.Sets the maximum execution time on the server for this operation.Sets the minimum inclusive lower bound for a specific index.noCursorTimeout
(boolean noCursorTimeout) The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.partial
(boolean partial) Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).projection
(Bson projection) Sets a document describing the fields to return for all matching documents.returnKey
(boolean returnKey) Sets the returnKey.showRecordId
(boolean showRecordId) Sets the showRecordId.skip
(int skip) Sets the number of documents to skip.Sets the sort criteria to apply to the query.timeoutMode
(TimeoutMode timeoutMode) Sets the timeoutMode for the cursor.
-
Method Details
-
first
Helper to return a publisher limited to the first result.- Returns:
- a Publisher which will contain a single item.
-
filter
Sets the query filter to apply to the query.- Parameters:
filter
- the filter, which may be null.- Returns:
- this
- MongoDB documentation
- Filter
-
limit
Sets the limit to apply.- Parameters:
limit
- the limit- Returns:
- this
- MongoDB documentation
- Limit
-
skip
Sets the number of documents to skip.- Parameters:
skip
- the number of documents to skip- Returns:
- this
- MongoDB documentation
- Skip
-
maxTime
Sets the maximum execution time on the server for this operation.- Parameters:
maxTime
- the max timetimeUnit
- the time unit, which may not be null- Returns:
- this
- MongoDB documentation
- Max Time
-
maxAwaitTime
The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. This only applies to a TAILABLE_AWAIT cursor. When the cursor is not a TAILABLE_AWAIT cursor, this option is ignored.On servers >= 3.2, this option will be specified on the getMore command as "maxTimeMS". The default is no value: no "maxTimeMS" is sent to the server with the getMore command.
On servers < 3.2, this option is ignored, and indicates that the driver should respect the server's default value
A zero value will be ignored.
- Parameters:
maxAwaitTime
- the max await timetimeUnit
- the time unit to return the result in- Returns:
- the maximum await execution time in the given time unit
- Since:
- 1.2
- MongoDB documentation
- Max Time
-
projection
Sets a document describing the fields to return for all matching documents.- Parameters:
projection
- the project document, which may be null.- Returns:
- this
- See Also:
- MongoDB documentation
- Projection
-
sort
Sets the sort criteria to apply to the query.- Parameters:
sort
- the sort criteria, which may be null.- Returns:
- this
- MongoDB documentation
- Sort
-
noCursorTimeout
The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.- Parameters:
noCursorTimeout
- true if cursor timeout is disabled- Returns:
- this
-
partial
Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).- Parameters:
partial
- if partial results for sharded clusters is enabled- Returns:
- this
-
cursorType
Sets the cursor type.- Parameters:
cursorType
- the cursor type- Returns:
- this
-
collation
Sets the collation optionsA null value represents the server default.
- Parameters:
collation
- the collation options to use- Returns:
- this
- Since:
- 1.3
- Since server release
- 3.4
-
comment
Sets the comment to the query. A null value means no comment is set.- Parameters:
comment
- the comment- Returns:
- this
- Since:
- 1.6
-
comment
Sets the comment for this operation. A null value means no comment is set.The comment can be any valid BSON type for server versions 4.4 and above. Server versions between 3.6 and 4.2 only support string as comment, and providing a non-string type will result in a server-side error.
- Parameters:
comment
- the comment- Returns:
- this
- Since:
- 4.6
- Since server release
- 3.6
-
hint
Sets the hint for which index to use. A null value means no hint is set.- Parameters:
hint
- the hint- Returns:
- this
- Since:
- 1.6
-
hintString
Sets the hint for which index to use. A null value means no hint is set.- Parameters:
hint
- the name of the index which should be used for the operation- Returns:
- this
- Since:
- 1.13
-
let
Add top-level variables to the operation. A null value means no variables are set.Allows for improved command readability by separating the variables from the query text.
- Parameters:
variables
- for find operation or null- Returns:
- this
- Since:
- 4.6
- MongoDB documentation
- reference/command/find/
- Since server release
- 5.0
-
max
Sets the exclusive upper bound for a specific index. A null value means no max is set.- Parameters:
max
- the max- Returns:
- this
- Since:
- 1.6
-
min
Sets the minimum inclusive lower bound for a specific index. A null value means no max is set.- Parameters:
min
- the min- Returns:
- this
- Since:
- 1.6
-
returnKey
Sets the returnKey. If true the find operation will return only the index keys in the resulting documents.- Parameters:
returnKey
- the returnKey- Returns:
- this
- Since:
- 1.6
-
showRecordId
Sets the showRecordId. Set to true to add a field$recordId
to the returned documents.- Parameters:
showRecordId
- the showRecordId- Returns:
- this
- Since:
- 1.6
-
batchSize
Sets the number of documents to return per batch.Overrides the
Subscription.request(long)
value for setting the batch size, allowing for fine-grained control over the underlying cursor.- Parameters:
batchSize
- the batch size- Returns:
- this
- Since:
- 1.8
- MongoDB documentation
- Batch Size
-
allowDiskUse
Enables writing to temporary files on the server. When set to true, the server can write temporary data to disk while executing the find operation.This option is sent only if the caller explicitly sets it to true.
- Parameters:
allowDiskUse
- the allowDiskUse- Returns:
- this
- Since:
- 4.1
- Since server release
- 4.4
-
timeoutMode
Sets the timeoutMode for the cursor.Requires the
timeout
to be set, either in theMongoClientSettings
, viaMongoDatabase
or viaMongoCollection
If the
timeout
is set then:- For non-tailable cursors, the default value of timeoutMode is
TimeoutMode.CURSOR_LIFETIME
- For tailable cursors, the default value of timeoutMode is
TimeoutMode.ITERATION
and its an error to configure it as:TimeoutMode.CURSOR_LIFETIME
- Parameters:
timeoutMode
- the timeout mode- Returns:
- this
- Since:
- 5.2
- For non-tailable cursors, the default value of timeoutMode is
-
explain
Explain the execution plan for this operation with the server's default verbosity level- Returns:
- the execution plan
- Since:
- 4.2
- MongoDB documentation
- reference/command/explain/
- Since server release
- 3.2
-
explain
Explain the execution plan for this operation with the given verbosity level- Parameters:
verbosity
- the verbosity of the explanation- Returns:
- the execution plan
- Since:
- 4.2
- MongoDB documentation
- reference/command/explain/
- Since server release
- 3.2
-
explain
Explain the execution plan for this operation with the server's default verbosity level- Type Parameters:
E
- the type of the document class- Parameters:
explainResultClass
- the document class to decode into- Returns:
- the execution plan
- Since:
- 4.2
- MongoDB documentation
- reference/command/explain/
- Since server release
- 3.2
-
explain
Explain the execution plan for this operation with the given verbosity level- Type Parameters:
E
- the type of the document class- Parameters:
explainResultClass
- the document class to decode intoverbosity
- the verbosity of the explanation- Returns:
- the execution plan
- Since:
- 4.2
- MongoDB documentation
- reference/command/explain/
- Since server release
- 3.2
-