object SearchHighlight
Highlighting options.
You may use the $meta: "searchHighlights"
expression, e.g., via Projections.metaSearchHighlights,
to extract the results of highlighting.
- Annotations
- @Beta()
- Since
4.7
- See also
- Alphabetic
- By Inheritance
- SearchHighlight
- 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
- 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()
- def of(highlight: Bson): SearchHighlight
Creates a
SearchHighlight
from aBson
in situations when there is no builder method that better satisfies your needs.Creates a
SearchHighlight
from aBson
in situations when there is no builder method that better satisfies your needs. This method cannot be used to validate the syntax.Example
The following code creates two functionally equivalentSearchHighlight
s, though they may not be equal.val highlight1: SearchHighlight = SearchHighlight.paths( SearchPath.fieldPath("fieldName"), SearchPath.wildcardPath("wildc*rd")) val highlight2: SearchHighlight = SearchHighlight.of(Document("path" -> Seq( SearchPath.fieldPath("fieldName").toBsonValue, SearchPath.wildcardPath("wildc*rd").toBsonValue)))
- highlight
A
Bson
representing the requiredSearchHighlight
.- returns
The requested
SearchHighlight
.
- def paths(paths: Iterable[_ <: SearchPath]): SearchHighlight
Returns a
SearchHighlight
for the givenpaths
.Returns a
SearchHighlight
for the givenpaths
.- paths
The non-empty fields to be searched.
- returns
The requested
SearchHighlight
.
- def paths(path: SearchPath, paths: SearchPath*): SearchHighlight
Returns a
SearchHighlight
for the givenpaths
.Returns a
SearchHighlight
for the givenpaths
.- path
The field to be searched.
- paths
More fields to be searched.
- returns
The requested
SearchHighlight
.
- 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
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: