reactivemongo.api.indexes

Index

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(BSONSerializationPack)(
  key = Seq("name" -> IndexType.Ascending),
  name = Some("name_idx"),
  unique = false,
  background = false,
  dropDups = 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, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Index
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Index()

Type Members

  1. abstract type Pack <: SerializationPack

Abstract Value Members

  1. abstract val pack: Pack

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Index to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (Index, B)

    Implicit information
    This member is added by an implicit conversion from Index to ArrowAssoc[Index] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. def _2dsphereIndexVersion: Option[Int]

    An optional 2dsphere index version number.

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def background: Boolean

    Ff this index should be built in background.

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

  11. def bits: Option[Int]

    Optionally indicates the precision of geohash for 2d indexes.

  12. def bucketSize: Option[Double]

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

  13. def canEqual(that: Any): Boolean

    Definition Classes
    Index → Equals

  14. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  15. def collation: Option[Collation]

    An optional Collation (default: None)

  16. def defaultLanguage: Option[String]

    An optional default language for text indexes.

  17. def ensuring(cond: (Index) ⇒ Boolean, msg: ⇒ Any): Index

    Implicit information
    This member is added by an implicit conversion from Index to Ensuring[Index] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  18. def ensuring(cond: (Index) ⇒ Boolean): Index

    Implicit information
    This member is added by an implicit conversion from Index to Ensuring[Index] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  19. def ensuring(cond: Boolean, msg: ⇒ Any): Index

    Implicit information
    This member is added by an implicit conversion from Index to Ensuring[Index] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  20. def ensuring(cond: Boolean): Index

    Implicit information
    This member is added by an implicit conversion from Index to Ensuring[Index] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  21. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  22. def equals(that: Any): Boolean

    Definition Classes
    Index → Equals → AnyRef → Any

  23. lazy val eventualName: String

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

  24. def expireAfterSeconds: Option[Int]

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

  25. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  26. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Index to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  27. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  28. def hashCode(): Int

    Definition Classes
    Index → AnyRef → Any

  29. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  30. 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!

  31. def languageOverride: Option[String]

    An optional language override for text indexes.

  32. def max: Option[Double]

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

  33. def min: Option[Double]

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

  34. 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.

  35. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  36. final def notify(): Unit

    Definition Classes
    AnyRef

  37. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  38. def productElement(n: Int): Any

    Definition Classes
    Index → Product

  39. def productIterator: Iterator[Any]

    Definition Classes
    Product

  40. def productPrefix: String

    Definition Classes
    Product

  41. 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.

  42. 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

  43. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  44. def textIndexVersion: Option[Int]

    An optional text index version number.

  45. def toString(): String

    Definition Classes
    AnyRef → Any

  46. def unique: Boolean

    The flag to enforces uniqueness (default: false)

  47. def version: Option[Int]

    Indicates the version of the index (1 for >= 2.

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

  48. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  49. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  50. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  51. def weights: Option[Pack.Document]

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

  52. def wildcardProjection: Option[Pack.Document]

  53. def →[B](y: B): (Index, B)

    Implicit information
    This member is added by an implicit conversion from Index to ArrowAssoc[Index] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Index to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (index: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Index to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (index: StringFormat).self
    Definition Classes
    StringFormat

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 options: BSONDocument

    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Internal: will be made private

  3. def partialFilter: Option[BSONDocument]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Internal: will be made private

  4. val productArity: Int

    Definition Classes
    Index → Product
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.1) No longer a ReactiveMongo case class

  5. def x: Index

    Implicit information
    This member is added by an implicit conversion from Index to ArrowAssoc[Index] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (index: ArrowAssoc[Index]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  6. def x: Index

    Implicit information
    This member is added by an implicit conversion from Index to Ensuring[Index] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (index: Ensuring[Index]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Index to StringAdd

Inherited by implicit conversion any2stringfmt from Index to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Index to ArrowAssoc[Index]

Inherited by implicit conversion any2Ensuring from Index to Ensuring[Index]

Ungrouped