ReactiveMongo API
1.1
API
Generated with
ReactiveMongo API/reactivemongo.api.indexes/Index

Index

reactivemongo.api.indexes.Index
See theIndex companion object
sealed abstract class Index

A MongoDB index (excluding the namespace).

Consider reading the documentation about indexes in MongoDB.

import reactivemongo.api.bson.BSONDocument
import reactivemongo.api.indexes.{ Index, IndexType }

val bsonIndex = Index(
 key = Seq("name" -> IndexType.Ascending),
 name = Some("name_idx"),
 unique = false,
 background = 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)

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Type members

Types

Value members

Abstract methods

def key: Seq[(String, IndexType)]

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

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

Attributes

def options: Document

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

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

Attributes

def partialFilter: Option[Document]

Optional partial filter

Optional partial filter

Attributes

Since:

MongoDB 3.2

Concrete methods

def _2dsphereIndexVersion: Option[Int]

An optional 2dsphere index version number.

An optional 2dsphere index version number.

Attributes

def background: Boolean

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

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

Attributes

def bits: Option[Int]

Optionally indicates the precision of geohash for 2d indexes.

Optionally indicates the precision of geohash for 2d indexes.

Attributes

def bucketSize: Option[Double]

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

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

Attributes

def collation: Option[Collation]

An optional Collation (default: None)

An optional Collation (default: None)

Attributes

def defaultLanguage: Option[String]

An optional default language for text indexes.

An optional default language for text indexes.

Attributes

override def equals(that: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Attributes

that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
def expireAfterSeconds: Option[Int]

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

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

Attributes

override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns:

the hash code value for this object.

Definition Classes
Any
def languageOverride: Option[String]

An optional language override for text indexes.

An optional language override for text indexes.

Attributes

def max: Option[Double]

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

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

Attributes

def min: Option[Double]

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

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

Attributes

def name: Option[String]

The name of this index (default: None). If you provide none, a name will be computed for you.

The name of this index (default: None). If you provide none, a name will be computed for you.

Attributes

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.

Attributes

def storageEngine: Option[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.

Attributes

Since:

MongoDB 3.0

def textIndexVersion: Option[Int]

An optional text index version number.

An optional text index version number.

Attributes

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns:

a string representation of the object.

Definition Classes
Any
def unique: Boolean

The flag to enforces uniqueness (default: false)

The flag to enforces uniqueness (default: false)

Attributes

def version: Option[Int]

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

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

Attributes

def weights: Option[Document]

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

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

Attributes

Abstract fields

val pack: Pack

Concrete fields

lazy val eventualName: String

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

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

Attributes

Generated with