Index

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

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

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
def ->[B](y: B): (Index, B)

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()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val background: Boolean

States if this index should be built in background.
States if this index should be built in background. You should read the documentation about background indexing before using it.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val dropDups: Boolean

States if duplicates should be discarded (if unique = true).
States if duplicates should be discarded (if unique = true). Warning: you should read the documentation.
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Index) ⇒ Boolean): Index

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
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Index

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
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
lazy val eventualName: String

The name of the index (a default one is computed if none).
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val 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!
val 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
final def notifyAll(): Unit

Definition Classes
AnyRef
val options: BSONDocument

Optional parameters for this index (typically specific to an IndexType like Geo2D).
val partialFilter: Option[BSONDocument]

Optional partial filter (since MongoDB 3.2)
val sparse: Boolean

States if the index to build should only consider the documents that have the indexed fields.
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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val unique: Boolean

Enforces uniqueness.
val 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( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (Index, B)

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

Related Doc: package indexes

Instance Constructors

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())

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

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

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val background: Boolean

def clone(): AnyRef

val dropDups: Boolean

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

lazy val eventualName: String

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val key: Seq[(String, IndexType)]

val name: Option[String]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val options: BSONDocument

val partialFilter: Option[BSONDocument]

val sparse: Boolean

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

val unique: Boolean

val version: Option[Int]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

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

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