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 changestream
    Definition Classes
    model
  • F
  • FullDocument
  • FullDocumentBeforeChange
  • package densify

    Definition Classes
    model
    Since

    4.7

    Note

    Requires MongoDB 5.1 or greater.

    See also

    Aggregates.densify

  • package fill

    Definition Classes
    model
    Since

    4.7

    Note

    Requires MongoDB 5.3 or greater.

    See also

    Aggregates.fill

  • package geojson
    Definition Classes
    model
  • package search

    Query building API for MongoDB Atlas full-text search.

    Query building API for MongoDB Atlas full-text search.

    While all the building blocks of this API, such as SearchOptions, SearchHighlight, etc., are not necessary immutable, they are unmodifiable due to methods like SearchHighlight.maxCharsToExamine returning new instances instead of modifying the instance on which they are called. This allows storing and using such instances as templates.

    Definition Classes
    model
    Since

    4.7

    See also

    Aggregates.search

    Aggregates.vectorSearch

    Atlas Search

    Atlas Search aggregation pipeline stages

  • package vault

    This package contains options classes for the key vault API

    This package contains options classes for the key vault API

    Definition Classes
    model
    Since

    2.7

p

org.mongodb.scala.model

changestream

package changestream

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

Type Members

  1. type ChangeStreamDocument[T] = com.mongodb.client.model.changestream.ChangeStreamDocument[T]

    Represents the $changeStream aggregation output document.

    Represents the $changeStream aggregation output document.

    Note: this class will not be applicable for all change stream outputs. If using custom pipelines that radically change the change stream result, then an alternative document format should be used.

  2. type FullDocument = com.mongodb.client.model.changestream.FullDocument

    Change Stream fullDocument configuration.

  3. type FullDocumentBeforeChange = com.mongodb.client.model.changestream.FullDocumentBeforeChange

    Change Stream fullDocumentBeforeChange configuration.

Value Members

  1. object F
  2. object FullDocument

    Change Stream fullDocument configuration.

    Change Stream fullDocument configuration.

    Determines what to return for update operations when using a Change Stream. Defaults to FullDocument.DEFAULT. When set to FullDocument.UPDATE_LOOKUP, the change stream for partial updates will include both a delta describing the changes to the document as well as a copy of the entire document that was changed from *some time<*> after the change occurred.

    Since

    2.4

    Note

    Requires MongoDB 3.6 or greater

  3. object FullDocumentBeforeChange

    Change Stream fullDocumentBeforeChange configuration.

    Change Stream fullDocumentBeforeChange configuration.

    Determines what to return for update operations when using a Change Stream. Defaults to FullDocumentBeforeChange#DEFAULT.

    Since

    4.7

    Note

    Requires MongoDB 6.0 or greater

Inherited from AnyRef

Inherited from Any

Ungrouped