Class/Object

reactivemongo.api.indexes

Index

Related Docs: object Index | package indexes

Permalink

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,
  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 StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Pack <: SerializationPack

    Permalink

Abstract Value Members

  1. abstract val pack: Pack

    Permalink

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def background: Boolean

    Permalink

    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.

  8. def canEqual(that: Any): Boolean

    Permalink
    Definition Classes
    Index → Equals

  9. def clone(): AnyRef

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

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

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

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

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

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

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

  13. def ensuring(cond: Boolean): Index

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

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

    Permalink
    Definition Classes
    AnyRef

  15. def equals(that: Any): Boolean

    Permalink
    Definition Classes
    Index → Equals → AnyRef → Any

  16. lazy val eventualName: String

    Permalink

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

  17. def finalize(): Unit

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

  18. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Permalink
    Definition Classes
    Index → AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  22. def key: Seq[(String, IndexType)]

    Permalink

    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!

  23. def name: Option[String]

    Permalink

    The name of this index.

    The name of this index. If you provide none, a name will be computed for you.

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

    Permalink
    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  27. def productElement(n: Int): Any

    Permalink
    Definition Classes
    Index → Product

  28. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product

  29. def productPrefix: String

    Permalink
    Definition Classes
    Product

  30. def sparse: Boolean

    Permalink

    If the index to build should only consider the documents that have the indexed fields.

    If the index to build should only consider the documents that have the indexed fields. See the documentation on the consequences of such an index.

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

    Permalink
    Definition Classes
    AnyRef

  32. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  33. def unique: Boolean

    Permalink

    Enforces uniqueness

  34. def version: Option[Int]

    Permalink

    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.

  35. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

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

Deprecated Value Members

  1. def dropDups: Boolean

    Permalink

    If duplicates should be discarded (if unique = true).

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

    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.1) Since MongoDB 2.6

  2. def options: BSONDocument

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Will be internal

  3. def partialFilter: Option[BSONDocument]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0) Will be internal

  4. val productArity: Int

    Permalink
    Definition Classes
    Index → Product
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.1) No longer a case class

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 any2stringadd[Index]

Inherited by implicit conversion StringFormat from Index to StringFormat[Index]

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

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

Ungrouped