Packages

  • package root

    This is the documentation for the MongoDB Scala driver.

    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:

    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package mongodb
    Definition Classes
    org
  • package scala

    The MongoDB Scala Driver package

    The MongoDB Scala Driver package

    Contains type aliases and companion objects to help when using the Scala API

    Definition Classes
    mongodb
    Since

    1.0

  • package model

    The model package containing models and options that help describe MongoCollection operations

    The model package containing models and options that help describe MongoCollection operations

    Definition Classes
    scala
  • package fill

    Definition Classes
    model
    Since

    4.7

    Note

    Requires MongoDB 5.3 or greater.

    See also

    Aggregates.fill

  • FillOptions
  • FillOutputField
o

org.mongodb.scala.model.fill

FillOutputField

object FillOutputField

The core part of the $fill pipeline stage of an aggregation pipeline. A pair of an expression/method and a path to a field to be filled with evaluation results of the expression/method.

Since

4.7

Note

Requires MongoDB 5.3 or greater.

See also

Aggregates.fill

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FillOutputField
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def linear(field: String): LinearFillOutputField

    Returns a FillOutputField that uses the WindowOutputFields.linearFill method.

    Returns a FillOutputField that uses the WindowOutputFields.linearFill method.

    Sorting (FillOptions.sortBy) is required.

    field

    The field to fill.

    returns

    The requested FillOutputField.

    See also

    Dot notation

  12. def locf(field: String): LocfFillOutputField

    Returns a FillOutputField that uses the WindowOutputFields.locf method.

    Returns a FillOutputField that uses the WindowOutputFields.locf method.

    field

    The field to fill.

    returns

    The requested FillOutputField.

    See also

    Dot notation

  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. def of(fill: Bson): FillOutputField

    Creates a FillOutputField from a Bson in situations when there is no builder method that better satisfies your needs.

    Creates a FillOutputField from a Bson in situations when there is no builder method that better satisfies your needs. This method cannot be used to validate the syntax.

    Example
    The following code creates two functionally equivalent FillOutputFields, though they may not be equal.

    val field1 = FillOutputField.locf("fieldName")
val field2 = FillOutputField.of(Document("fieldName" -> Document("method" -> "locf")))
    fill

    A Bson representing the required FillOutputField.

    returns

    The requested FillOutputField.

  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. def value[TExpression](field: String, expression: TExpression): ValueFillOutputField

    Returns a FillOutputField that uses the specified expression.

    Returns a FillOutputField that uses the specified expression.

    TExpression

    The expression type.

    field

    The field to fill.

    expression

    The expression.

    returns

    The requested FillOutputField.

    See also

    Dot notation

  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped