driver-scala 5.0.0 API < Back

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:
- 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
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
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
Accumulators
Aggregates
BsonField
BucketAutoOptions
BucketGranularity
BucketOptions
BulkWriteOptions
ChangeStreamPreAndPostImagesOptions
ClusteredIndexOptions
Collation
CollationAlternate
CollationCaseFirst
CollationMaxVariable
CollationStrength
CountOptions
CreateCollectionOptions
CreateEncryptedCollectionParams
CreateViewOptions
DeleteManyModel
DeleteOneModel
DeleteOptions
DropCollectionOptions
EstimatedDocumentCountOptions
Facet
Field
Filters
FindOneAndDeleteOptions
FindOneAndReplaceOptions
FindOneAndUpdateOptions
GraphLookupOptions
IndexModel
IndexOptionDefaults
IndexOptions
Indexes
InsertManyOptions
InsertOneModel
InsertOneOptions
MapReduceAction
MergeOptions
MongoTimeUnit
Projections
PushOptions
QuantileMethod
RenameCollectionOptions
ReplaceOneModel
ReplaceOptions
ReturnDocument
SearchIndexModel
Sorts
TextSearchOptions
TimeSeriesOptions
UnwindOptions
UpdateManyModel
UpdateOneModel
UpdateOptions
Updates
ValidationAction
ValidationLevel
ValidationOptions
Variable
WindowOutputFields
Windows

org.mongodb.scala.model

SearchIndexModel

object SearchIndexModel

A model describing the creation of a single Atlas Search index.

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

SearchIndexModel
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
def apply(indexName: String, definition: Bson): SearchIndexModel
Construct an instance with the given search index name and definition.
Construct an instance with the given search index name and definition.
indexName
the name of the search index to create.
definition
the search index mapping definition.
returns
the SearchIndexModel
def apply(definition: Bson): SearchIndexModel
Construct an instance with the given Atlas Search index mapping definition.
Construct an instance with the given Atlas Search index mapping definition.
After calling this constructor, the name field will be null. In that case, when passing this SearchIndexModel to the createSearchIndexes method, the default search index name default will be used to create the search index.
definition
the search index mapping definition.
returns
the SearchIndexModel
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
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
@native() @IntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
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

Packages

Driver structure

SearchIndexModel

object SearchIndexModel

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Driver structure

SearchIndexModel

object SearchIndexModel

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

SearchIndexModel