Packages

case class Index(key: Seq[(String, IndexType)], name: Option[String] = None, unique: Boolean = false, background: Boolean = false, dropDups: Boolean = false, sparse: Boolean = false, version: Option[Int] = None, partialFilter: Option[BSONDocument] = None, options: BSONDocument = BSONDocument()) extends Product with Serializable

A MongoDB index (excluding the namespace).

Consider reading the documentation about indexes in MongoDB.

key

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

name

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

unique

Enforces uniqueness.

background

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

dropDups

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

sparse

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

version

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

partialFilter

Optional partial filter (since MongoDB 3.2)

options

Optional parameters for this index (typically specific to an IndexType like Geo2D).

Linear Supertypes
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

Instance Constructors

  1. new Index(key: Seq[(String, IndexType)], name: Option[String] = None, unique: Boolean = false, background: Boolean = false, dropDups: Boolean = false, sparse: Boolean = false, version: Option[Int] = None, partialFilter: Option[BSONDocument] = None, options: BSONDocument = BSONDocument())

    key

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

    name

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

    unique

    Enforces uniqueness.

    background

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

    dropDups

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

    sparse

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

    version

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

    partialFilter

    Optional partial filter (since MongoDB 3.2)

    options

    Optional parameters for this index (typically specific to an IndexType like Geo2D).

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 to any2stringadd[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 to ArrowAssoc[Index] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val background: Boolean
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. val dropDups: Boolean
  10. def ensuring(cond: (Index) ⇒ Boolean, msg: ⇒ Any): Index
    Implicit
    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
    Implicit
    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
    Implicit
    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
    Implicit
    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
    Definition Classes
    AnyRef
  15. lazy val eventualName: String

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

  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String
    Implicit
    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()
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val key: Seq[(String, IndexType)]
  21. val name: Option[String]
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. val options: BSONDocument
  26. val partialFilter: Option[BSONDocument]
  27. val sparse: Boolean
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. val unique: Boolean
  30. val version: Option[Int]
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  34. def [B](y: B): (Index, B)
    Implicit
    This member is added by an implicit conversion from Index to ArrowAssoc[Index] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

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