ChangeStreamOptions class
Parameters for the ChangeStream Operation
Please, note that even if the resume parameters are present, no atomatic resume logic is applied (at least in this driver version).
- Inheritance
-
- Object
- AggregateOptions
- ChangeStreamOptions
Constructors
Properties
- allowDiskUse ↔ bool
-
Enables writing to temporary files. When set to true, a
ggregation stages can write data to the _tmp subdirectory in the dbPath
directory.
getter/setter pairinherited
- bypassDocumentValidation ↔ bool
-
Applicable only if you specify the $out or $merge aggregation stages.
Enables aggregate to bypass document validation during the operation.
This lets you insert documents that do not meet the validation requirements.
getter/setter pairinherited
- collation → CollationOptions?
-
Specifies the collation to use for the operation.
Collation allows users to specify language-specific rules for string
comparison, such as rules for lettercase and accent marks.
See Collation document
finalinherited
- comment → String?
-
A user-provided comment to attach to this command. Once set,
this comment appears alongside records of this command in the
following locations:
finalinherited
- fullDocument ↔ String?
-
By default, the change stream returns the delta of those fields modified
by an update operation, instead of the entire updated document.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- maxAwaitTimeMS ↔ int?
-
The maximum amount of time in milliseconds the server waits for new data
changes to report to the change stream cursor before returning an
empty batch.
getter/setter pair
- maxTimeMS → int?
-
Specifies a time limit in milliseconds for processing operations on a
cursor. If you do not specify a value for maxTimeMS, operations will
not time out. A value of 0 explicitly specifies the default
unbounded behavior.
finalinherited
- readConcern → ReadConcern?
-
Starting in MongoDB 3.6, the readConcern option has the following syntax:
readConcern: { level:
finalinherited
-
resumeAfter
↔ Map<
String, Object> ? -
Directs watch to attempt resuming notifications starting after the
operation specified in the resume token.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
startAfter
↔ Map<
String, Object> ? -
Directs watch to attempt starting a new change stream after the operation
specified in the resume token. Allows notifications to resume after an
invalidate event.
getter/setter pair
- startAtOperationTime ↔ Timestamp?
-
The starting point for the change stream. If the specified starting
point is in the past, it must be in the time range of the oplog.
To check the time range of the oplog, see rs.printReplicationInfo().
getter/setter pair
- writeConcern → WriteConcern?
-
A document that expresses the write concern to use with the $out or
$merge stage.
finalinherited
Methods
-
changeStreamSpecificOptions(
) → Map< String, Object> - These options mut be passed to the $changeStream key in the aggregate command
-
getOptions(
Db? db) → Map< String, Object> -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited