PipelineDefinitionBuilder.UnionWith<TInput, TWith, TOutput> Method

Appends a $unionWith stage to the pipeline.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

Copy

public static PipelineDefinition<TInput, TOutput> UnionWith<TInput, TWith, TOutput>(
	this PipelineDefinition<TInput, TOutput> pipeline,
	IMongoCollection<TWith> withCollection,
	PipelineDefinition<TWith, TOutput> withPipeline = null
)

<ExtensionAttribute>
Public Shared Function UnionWith(Of TInput, TWith, TOutput) ( 
	pipeline As PipelineDefinition(Of TInput, TOutput),
	withCollection As IMongoCollection(Of TWith),
	Optional withPipeline As PipelineDefinition(Of TWith, TOutput) = Nothing
) As PipelineDefinition(Of TInput, TOutput)

[<ExtensionAttribute>]
static member UnionWith : 
        pipeline : PipelineDefinition<'TInput, 'TOutput> * 
        withCollection : IMongoCollection<'TWith> * 
        ?withPipeline : PipelineDefinition<'TWith, 'TOutput> 
(* Defaults:
        let _withPipeline = defaultArg withPipeline null
*)
-> PipelineDefinition<'TInput, 'TOutput>

Parameters

pipeline: Type: MongoDB.Driver.PipelineDefinition<TInput, TOutput>
The pipeline.
withCollection: Type: MongoDB.Driver.IMongoCollection<TWith>
The with collection.
withPipeline (Optional): Type: MongoDB.Driver.PipelineDefinition<TWith, TOutput>
The with pipeline.

Type Parameters

TInput: The type of the input documents.
TWith: The type of the with collection documents.
TOutput: The type of the output documents.

Return Value

Type: PipelineDefinition<TInput, TOutput>
The stage.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type PipelineDefinition<TInput, TOutput>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Reference

PipelineDefinitionBuilder Class