mongo4cats-kernel
API
Generated with
mongo4cats-kernel/mongo4cats/mongo4cats.models/mongo4cats.models.collection

mongo4cats.models.collection

package mongo4cats.models.collection

Members list

Type members

Classlikes

object BulkWriteOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final case class ChangeStreamDocument[T](resumeToken: Document, operationType: OperationType, namespace: Option[MongoNamespace], destinationNamespace: Option[MongoNamespace], fullDocument: Option[T], fullDocumentBeforeChange: Option[T], documentKey: Option[Document], updateDescription: Option[UpdateDescription], txnNumber: Option[BsonValue], lsid: Option[Document], splitEvent: Option[SplitEvent], extraElements: Option[Document], clusterTime: Option[BsonValue], wallTime: Option[BsonValue])

Represents the changeStream aggregation output document.

Represents the changeStream aggregation output document.

Value parameters

clusterTime

the cluster time at which the change occurred

destinationNamespace

the destination namespace, used to indicate the destination of a collection rename event.

documentKey

a document containing the _id of the changed document

extraElements

any extra elements that are part of the change stream document but not otherwise mapped to fields

fullDocument

the full document, Contains the point-in-time post-image of the modified document if the post-image is available and either [[FullDocument# REQUIRED]] or [[FullDocument# WHEN_AVAILABLE]] was specified for the fullDocument option when creating the change stream. A post-image is always available for [[OperationType# INSERT]] and [[OperationType# REPLACE]] events.

fullDocumentBeforeChange

the full document before change. Contains the pre-image of the modified or deleted document if the pre-image is available for the change event and either [[FullDocumentBeforeChange# REQUIRED]] or [[FullDocumentBeforeChange# WHEN_AVAILABLE]] was specified for the fullDocumentBeforeChange option when creating the change stream. If [[FullDocumentBeforeChange# WHEN_AVAILABLE]] was specified but the pre-image is unavailable, the value will be null.

lsid

the identifier for the session associated with the transaction

namespace

the namespace, derived from the "ns" field in a change stream document.

operationType

the operation type

resumeToken

the resume token

splitEvent

the split event

txnNumber

the transaction number

updateDescription

the update description

wallTime

the wall time of the server at the moment the change occurred

Attributes

Since

4.11

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ChangeStreamDocument

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object CountOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object DeleteOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object DropIndexOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object FindOneAndDeleteOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object FindOneAndReplaceOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object FindOneAndUpdateOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object IndexOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object InsertManyOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object InsertOneOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final case class MongoNamespace(databaseName: String, collectionName: String)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MongoNamespace

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object RenameCollectionOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ReplaceOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object UnwindOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final case class UpdateDescription(removedFields: List[String], updatedFields: Option[Document], truncatedArrays: List[TruncatedArray], disambiguatedPaths: Option[Document])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UpdateDescription

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object UpdateOptions

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait WriteCommand[+T]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class DeleteMany
class DeleteOne
class InsertOne[T]
class ReplaceOne[T]
class UpdateMany
class UpdateOne
Show all
object WriteCommand

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Types

type BulkWriteOptions = BulkWriteOptions
type CountOptions = CountOptions
type DeleteOptions = DeleteOptions
type DropIndexOptions = DropIndexOptions
type FindOneAndDeleteOptions = FindOneAndDeleteOptions
type FindOneAndReplaceOptions = FindOneAndReplaceOptions
type FindOneAndUpdateOptions = FindOneAndUpdateOptions
type IndexOptions = IndexOptions
type InsertManyOptions = InsertManyOptions
type InsertOneOptions = InsertOneOptions
type RenameCollectionOptions = RenameCollectionOptions
type ReplaceOptions = ReplaceOptions
type UnwindOptions = UnwindOptions
type UpdateOptions = UpdateOptions
Generated with