object SearchIndexModel
A model describing the creation of a single Atlas Search index.
- Alphabetic
- By Inheritance
- SearchIndexModel
- AnyRef
- Any
- Hide All
- Show All
- 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: Option[String], definition: Bson, indexType: Option[SearchIndexType]): 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.
- indexType
the search index type.
- returns
the SearchIndexModel
- def apply(indexName: String, definition: VectorSearchIndexDefinition): SearchIndexModel
Construct a vector search index instance with the given name and definition.
Construct a vector search index instance with the given name and definition.
The index type is automatically set to
vectorSearch.- indexName
the name of the search index to create.
- definition
the vector search index definition.
- returns
the SearchIndexModel
- Since
5.8
- 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
namefield will benull. In that case, when passing thisSearchIndexModelto thecreateSearchIndexesmethod, the default search index namedefaultwill 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]) @IntrinsicCandidate() @native()
- 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
- @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
- 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)
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: