Packages

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:

MongoClient The MongoClient used to connect and access MongoDB
MongoDatabase Providing access to a specific database
MongoCollection Providing access to a specific collection in a database.

Definition Classes: root

package org

Definition Classes: root

package mongodb

Definition Classes: org

package scala

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

Definition Classes: scala

package bulk

Models, options, results for the client-level bulk write operation.

Definition Classes: model
Since: 5.4

package changestream

Definition Classes: model

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.

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

Definition Classes: model
Since: 2.7

ChangeStreamPreAndPostImagesOptions

ClusteredIndexOptions

CreateCollectionOptions

CreateEncryptedCollectionParams

DropCollectionOptions

EstimatedDocumentCountOptions

Facet

Field

Filters

FindOneAndDeleteOptions

FindOneAndReplaceOptions

FindOneAndUpdateOptions

GraphLookupOptions

HnswSearchIndexOptions

RenameCollectionOptions

ReplaceOneModel

ReplaceOptions

ReturnDocument

SearchIndexDefinition

VectorSearchIndexFields

WindowOutputFields

Windows

org.mongodb.scala.model

VectorSearchIndexFields

object VectorSearchIndexFields

Companion object providing Scala-friendly factories for VectorSearchIndexFields.

Since: 5.8

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

VectorSearchIndexFields
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

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 autoEmbedField(path: String): AutoEmbedField
Creates an auto-embed field definition for a vector search index.
Creates an auto-embed field definition for a vector search index.
path
the field path in the document containing the content to embed
returns
a new VectorSearchIndexFields.AutoEmbedField
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def filterField(path: String): FilterField
Creates a filter field definition for a vector search index.
Creates a filter field definition for a vector search index.
path
the field path in the document
returns
a new VectorSearchIndexFields.FilterField
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
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
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
def vectorField(path: String): VectorField
Creates a vector field definition for a vector search index.
Creates a vector field definition for a vector search index.
path
the field path in the document
returns
a new VectorSearchIndexFields.VectorField
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])

Deprecated Value Members

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

Packages

Driver structure

VectorSearchIndexFields

object VectorSearchIndexFields

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Driver structure

VectorSearchIndexFields

object VectorSearchIndexFields

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

VectorSearchIndexFields