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

Indexes

object Indexes

A factory for defining index keys. A convenient way to use this class is to statically import all of its methods, which allows usage like:

collection.createIndex(compoundIndex(ascending("x"), descending("y")))

Since: 1.0

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Indexes
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 ascending(fieldNames: String*): Bson
Create an index key for an ascending index on the given fields.
Create an index key for an ascending index on the given fields.
fieldNames
the field names, which must contain at least one
returns
the index specification
See also
indexes
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
def compoundIndex(indexes: Bson*): Bson
create a compound index specifications.
create a compound index specifications. If any field names are repeated, the last one takes precedence.
indexes
the index specifications
returns
the compound index specification
See also
compoundIndex
def descending(fieldNames: String*): Bson
Create an index key for an ascending index on the given fields.
Create an index key for an ascending index on the given fields.
fieldNames
the field names, which must contain at least one
returns
the index specification
See also
indexes
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def geo2d(fieldName: String): Bson
Create an index key for a 2d index on the given field.
Create an index key for a 2d index on the given field.
Note: A 2d index is for data stored as points on a two-dimensional plane. The 2d index is intended for legacy coordinate pairs used in MongoDB 2.2 and earlier.
fieldName
the field to create a 2d index on
returns
the index specification
See also
2d index
def geo2dsphere(fieldNames: String*): Bson
Create an index key for an 2dsphere index on the given fields.
Create an index key for an 2dsphere index on the given fields.
fieldNames
the field names, which must contain at least one
returns
the index specification
See also
2dsphere Index
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def hashed(fieldName: String): Bson
Create an index key for a hashed index on the given field.
Create an index key for a hashed index on the given field.
fieldName
the field to create a hashed index on
returns
the index specification
See also
hashed index
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 text(fieldName: String): Bson
Create an index key for a text index on the given field.
Create an index key for a text index on the given field.
fieldName
the field to create a text index on
returns
the index specification
See also
text index
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

Indexes

object Indexes

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Driver structure

Indexes

object Indexes

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Indexes