$replaceWith class

$replaceWith aggregation stage

Stage description

Available since MongoDB version 4.2

Replaces the input document with the specified document. The operation replaces all existing fields in the input document, including the _id field. With $replaceWith, you can promote an embedded document to the top-level. You can also specify a new document as the replacement.

The $replaceWith is an alias for $replaceRoot.

Examples:

Dart code:

$replaceWith(Field('name')).build()

Equivalent mongoDB aggregation stage:

{r'$replaceWith': r'$name'}

Dart code:

$replaceWith($mergeObjects([
   {'_id': Field('_id'), 'first': '', 'last': ''},
   Field('name')
])).build()

Equivalent mongoDB aggregation stage:

{ $replaceWith: {
    $mergeObjects: [ { _id: "$_id", first: "", last: "" }, "$name" ]
}}

https://docs.mongodb.com/manual/reference/operator/aggregation/replaceWith/

Inheritance

• Object
• ExpressionContent
• Expression<ExpressionContent>
• FieldExpression<ExpressionContent>
• AggregationStage
• $replaceWith

Constructors

$replaceWith.new(dynamic replacement)

Creates $replaceWith aggregation stage

Properties

content → ExpressionContent

no setter, inherited

entry ↔ MapEntry<String, ExpressionContent>

getter/setter pair, inherited

fieldName → String

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

key → String

no setter, inherited

rawContent → dynamic

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stageName → String

no setter, inherited

Methods

build() → MongoDocument

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