Packages

case class MergeOptions(wrapped: com.mongodb.client.model.MergeOptions = new JMergeOptions()) extends Product with Serializable

Options to control the behavior of the $merge aggregation stage

Since

2.7

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MergeOptions
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MergeOptions(wrapped: com.mongodb.client.model.MergeOptions = new JMergeOptions())

Value Members

  1. def productElementNames: Iterator[String]
    Definition Classes
    Product
  2. def uniqueIdentifier(uniqueIdentifiers: String*): MergeOptions

    Sets the field that act as a unique identifier for a document.

    Sets the field that act as a unique identifier for a document. The identifier determine if a results document matches an already existing document in the output collection.

    uniqueIdentifiers

    the unique identifier(s)

    returns

    this

  3. def variables(variables: Variable[_]*): MergeOptions

    Sets the variables accessible for use in the whenMatched pipeline.

    Sets the variables accessible for use in the whenMatched pipeline.

    variables

    the variables

    returns

    this

  4. def whenMatched(whenMatched: WhenMatched): MergeOptions

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

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

    whenMatched

    when matched

    returns

    this

  5. def whenMatchedPipeline(whenMatchedPipeline: Bson*): MergeOptions

    Sets aggregation pipeline to update the document in the collection.

    Sets aggregation pipeline to update the document in the collection.

    whenMatchedPipeline

    when matched pipeline

    returns

    this

    See also

    WhenMatched#PIPELINE

  6. def whenNotMatched(whenNotMatched: WhenNotMatched): MergeOptions

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

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

    whenNotMatched

    when not matched

    returns

    this

  7. val wrapped: com.mongodb.client.model.MergeOptions