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)
- Alphabetic
- By Inheritance
- Index
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- abstract type Pack <: SerializationPack
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Index, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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.
- def canEqual(that: Any): Boolean
- Definition Classes
- Index → Equals
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (Index) => Boolean, msg: => Any): Index
- def ensuring(cond: (Index) => Boolean): Index
- def ensuring(cond: Boolean, msg: => Any): Index
- def ensuring(cond: Boolean): Index
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(that: Any): Boolean
- Definition Classes
- Index → Equals → AnyRef → Any
- lazy val eventualName: String
The name of the index (a default one is computed if none).
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- Index → AnyRef → Any
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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!
- def name: Option[String]
The name of this index.
The name of this index. If you provide none, a name will be computed for you.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElement(n: Int): Any
- Definition Classes
- Index → Product
- def productElementName(n: Int): String
- Definition Classes
- Product
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def productIterator: Iterator[Any]
- Definition Classes
- Product
- def productPrefix: String
- Definition Classes
- Product
- def sparse: Boolean
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.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unique: Boolean
Enforces uniqueness
- 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.
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
Deprecated Value Members
- def dropDups: Boolean
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
- def options: BSONDocument
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Will be internal
- def partialFilter: Option[BSONDocument]
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.0) Will be internal
- val productArity: Int
- Definition Classes
- Index → Product
- Annotations
- @deprecated
- Deprecated
(Since version 0.19.1) No longer a case class
- 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.