• Home
• io.github.zeal18
• zio-mongodb-driver_3
• 0.10.0
• source code
• UnwindOptions.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.github.zeal18.zio.mongodb.driver.aggregates.UnwindOptions.scala Maven / Gradle / Ivy

package io.github.zeal18.zio.mongodb.driver.aggregates

/** The options for an unwind aggregation pipeline stage
  *
  * @mongodb.driver.manual reference/operator/aggregation/unwind/ $unwind
  * @mongodb.server.release 3.2
  */
final case class UnwindOptions(
  preserveNullAndEmptyArrays: Option[Boolean] = None,
  includeArrayIndex: Option[String] = None,
) {

  /** Sets true if the unwind stage should include documents that have null values or empty arrays
    *
    * @param preserveNullAndEmptyArrays flag depicting if the unwind stage should include documents that have null values or empty arrays
    */
  def withPreserveNullAndEmptyArrays(preserveNullAndEmptyArrays: Boolean): UnwindOptions =
    copy(preserveNullAndEmptyArrays = Some(preserveNullAndEmptyArrays))

  /** Sets the field to be used to store the array index of the unwound item
    *
    * @param arrayIndexFieldName the field to be used to store the array index of the unwound item
    */
  def withIncludeArrayIndex(includeArrayIndex: String): UnwindOptions =
    copy(includeArrayIndex = Some(includeArrayIndex))
}