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
- Alphabetic
- By Inheritance
- MergeOptions
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new MergeOptions(wrapped: com.mongodb.client.model.MergeOptions = new JMergeOptions())
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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
- 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
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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
- 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
- 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
- val wrapped: com.mongodb.client.model.MergeOptions
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
This is the documentation for the MongoDB Scala driver.
Driver structure
The mongodb scala driver.
To get started you need a MongoClient instance, either from a connection string or via a org.mongodb.scala.MongoClientSettings.
Notable packages include: