Class MergeStageOptions<TOutput>

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

Options for the $merge aggregation pipeline stage.

public class MergeStageOptions<TOutput>

Type Parameters

TOutput

The type of the output documents.

Inheritance

object

MergeStageOptions<TOutput>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

LetVariables

Specifies variables accessible for use in the WhenMatchedPipeline.

public BsonDocument LetVariables { get; set; }

Property Value

BsonDocument

OnFieldNames

Field or fields that act as a unique identifier for a document. The identifier determines if a results document matches an already existing document in the output collection.

public IReadOnlyList<string> OnFieldNames { get; set; }

Property Value

IReadOnlyList<string>

OutputSerializer

The output serializer.

public IBsonSerializer<TOutput> OutputSerializer { get; set; }

Property Value

IBsonSerializer<TOutput>

WhenMatched

The behavior of $merge if a result document and an existing document in the collectoin have the same value for the specified on field(s).

public MergeStageWhenMatched? WhenMatched { get; set; }

Property Value

MergeStageWhenMatched?

WhenMatchedPipeline

An aggregation pipeline to update the document in the collection. Used when WhenMatched is Pipeline.

public PipelineDefinition<TOutput, TOutput> WhenMatchedPipeline { get; set; }

Property Value

PipelineDefinition<TOutput, TOutput>

WhenNotMatched

The behavior of $merge if a result document does not match an existing document in the output collection.

public MergeStageWhenNotMatched? WhenNotMatched { get; set; }

Property Value

MergeStageWhenNotMatched?