Annotation Interface MongoFindOptions
@Retention(RUNTIME)
@Target({ANNOTATION_TYPE,METHOD,TYPE})
@Documented
@Inherited
public @interface MongoFindOptions
Defines a custom MongoDB find query options.
- Since:
- 3.3.0
- Author:
- Denis Stepanov
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionboolean
The allowDiskUse.int
The batchSize.The comment.com.mongodb.CursorType
The cursorType.The hint.int
The limit.The max.long
The maxAwaitTimeMS.long
The maxTimeMS.The min.boolean
The cursorType.boolean
The partial.boolean
The returnKey.boolean
The showRecordId.int
The skip.
-
Element Details
-
batchSize
int batchSizeThe batchSize.- Returns:
- The batchSize value
- Default:
- -1
-
skip
int skipThe skip.- Returns:
- The skip value
- Default:
- -1
-
limit
int limitThe limit.- Returns:
- The limit value
- Default:
- -1
-
maxTimeMS
long maxTimeMSThe maxTimeMS.- Returns:
- The maxTimeMS value
- Default:
- -1L
-
maxAwaitTimeMS
long maxAwaitTimeMSThe maxAwaitTimeMS.- Returns:
- The maxAwaitTimeMS value
- Default:
- -1L
-
cursorType
com.mongodb.CursorType cursorTypeThe cursorType.- Returns:
- The cursorType value
- Default:
- NonTailable
-
noCursorTimeout
boolean noCursorTimeoutThe cursorType.- Returns:
- The cursorType value
- Default:
- false
-
partial
boolean partialThe partial.- Returns:
- The partial value
- Default:
- false
-
comment
String commentThe comment.- Returns:
- The comment value
- Default:
- ""
-
hint
String hintThe hint.- Returns:
- The hint value
- Default:
- ""
-
max
String maxThe max.- Returns:
- The max value
- Default:
- ""
-
min
String minThe min.- Returns:
- The min value
- Default:
- ""
-
returnKey
boolean returnKeyThe returnKey.- Returns:
- The returnKey value
- Default:
- false
-
showRecordId
boolean showRecordIdThe showRecordId.- Returns:
- The showRecordId value
- Default:
- false
-
allowDiskUse
boolean allowDiskUseThe allowDiskUse.- Returns:
- The allowDiskUse value
- Default:
- false
-