Packages

sealed abstract class Index extends Product with Serializable

A MongoDB index (excluding the namespace).

Consider reading the documentation about indexes in MongoDB.

import reactivemongo.api.bson.BSONDocument
import reactivemongo.api.bson.collection.BSONSerializationPack
import reactivemongo.api.indexes.{ Index, IndexType }

val bsonIndex = Index(
  key = Seq("name" -> IndexType.Ascending),
  name = Some("name_idx"),
  unique = false,
  background = false,
  sparse = false,
  expireAfterSeconds = None,
  storageEngine = None,
  weights = None,
  defaultLanguage = None,
  languageOverride = None,
  textIndexVersion = None,
  sphereIndexVersion = None,
  bits = None,
  min = None,
  max = None,
  bucketSize = None,
  collation = None,
  wildcardProjection = None,
  version = None,
  partialFilter = None,
  options = BSONDocument.empty)
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Index
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Pack <: SerializationPack

Abstract Value Members

  1. abstract val pack: Pack

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Index toany2stringadd[Index] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Index, B)
    Implicit
    This member is added by an implicit conversion from Index toArrowAssoc[Index] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def _2dsphereIndexVersion: Option[Int]

    An optional 2dsphere index version number.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def background: Boolean

    If this index should be built in background.

    If this index should be built in background. You should read the documentation about background indexing before using it.

  9. def bits: Option[Int]

    Optionally indicates the precision of geohash for 2d indexes.

  10. def bucketSize: Option[Double]

    Optionally specifies the number of units within which to group the location values for geoHaystack indexes.

  11. def canEqual(that: Any): Boolean
    Definition Classes
    Index → Equals
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  13. def collation: Option[Collation]

    An optional Collation (default: None)

  14. def defaultLanguage: Option[String]

    An optional default language for text indexes.

  15. def ensuring(cond: (Index) => Boolean, msg: => Any): Index
    Implicit
    This member is added by an implicit conversion from Index toEnsuring[Index] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (Index) => Boolean): Index
    Implicit
    This member is added by an implicit conversion from Index toEnsuring[Index] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): Index
    Implicit
    This member is added by an implicit conversion from Index toEnsuring[Index] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): Index
    Implicit
    This member is added by an implicit conversion from Index toEnsuring[Index] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(that: Any): Boolean
    Definition Classes
    Index → Equals → AnyRef → Any
  21. lazy val eventualName: String

    The name of the index (a default one is computed if none).

  22. def expireAfterSeconds: Option[Int]

    Optionally specifies a value, in seconds, as a TTL to control how long MongoDB retains documents in this collection.

  23. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Index toStringFormat[Index] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def hashCode(): Int
    Definition Classes
    Index → AnyRef → Any
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def key: Seq[(String, IndexType)]

    The index key (it can be composed of multiple fields).

    The index key (it can be composed of multiple fields). This list should not be empty!

  28. def languageOverride: Option[String]

    An optional language override for text indexes.

  29. def max: Option[Double]

    Optionally indicates the upper inclusive boundary for longitude and latitude for 2d indexes.

  30. def min: Option[Double]

    Optionally indicates the lower inclusive boundary for longitude and latitude for 2d indexes.

  31. def name: Option[String]

    The name of this index (default: None).

    The name of this index (default: None). If you provide none, a name will be computed for you.

  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. def productElement(n: Int): Any
    Definition Classes
    Index → Product
  36. def productElementName(n: Int): String
    Definition Classes
    Product
  37. def productElementNames: Iterator[String]
    Definition Classes
    Product
  38. def productIterator: Iterator[Any]
    Definition Classes
    Product
  39. def productPrefix: String
    Definition Classes
    Product
  40. def sparse: Boolean

    The flags to indicates if the index to build should only consider the documents that have the indexed fields (default: false).

    The flags to indicates if the index to build should only consider the documents that have the indexed fields (default: false).

    See the documentation on the consequences of such an index.

  41. def storageEngine: Option[Pack.Document]

    Optionally specifies a configuration for the storage engine on a per-index basis when creating an index.

    Optionally specifies a configuration for the storage engine on a per-index basis when creating an index.

    Since

    MongoDB 3.0

  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. def textIndexVersion: Option[Int]

    An optional text index version number.

  44. def toString(): String
    Definition Classes
    Index → AnyRef → Any
  45. def unique: Boolean

    The flag to enforces uniqueness (default: false)

  46. def version: Option[Int]

    Indicates the version of the index (1 for >= 2.0, else 0).

    Indicates the version of the index (1 for >= 2.0, else 0). You should let MongoDB decide.

  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  50. def weights: Option[Pack.Document]

    An optional document that contains field and weight pairs for text indexes.

  51. def wildcardProjection: Option[Pack.Document]

Deprecated Value Members

  1. def dropDups: Boolean

    If duplicates should be discarded (if unique = true; default: false).

    If duplicates should be discarded (if unique = true; default: false). _Warning_: you should read the documentation.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.1) Since MongoDB 2.6

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

    (Since version ) see corresponding Javadoc for more information.

  3. def options: BSONDocument
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Internal: will be made private

  4. def partialFilter: Option[BSONDocument]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Internal: will be made private

  5. val productArity: Int
    Definition Classes
    Index → Product
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.1) No longer a ReactiveMongo case class

  6. def →[B](y: B): (Index, B)
    Implicit
    This member is added by an implicit conversion from Index toArrowAssoc[Index] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromIndex to any2stringadd[Index]

Inherited by implicit conversion StringFormat fromIndex to StringFormat[Index]

Inherited by implicit conversion Ensuring fromIndex to Ensuring[Index]

Inherited by implicit conversion ArrowAssoc fromIndex to ArrowAssoc[Index]

Ungrouped