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 Objecttrait Matchableclass Any
Members list
Type members
Types
Value members
Abstract methods
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
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
Optional partial filter
Concrete methods
An optional 2dsphere
index version number.
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
Optionally indicates the precision of geohash for 2d indexes.
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
An optional default language for text indexes.
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 typeAny
,x.equals(x)
should returntrue
. - It is symmetric: for any instances
x
andy
of typeAny
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any instances
x
,y
, andz
of typeAny
ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
.
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
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
An optional language override for text indexes.
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
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
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
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
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
An optional text
index version number.
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
The flag to enforces uniqueness (default: false
)
The flag to enforces uniqueness (default: false
)
Attributes
An optional document that contains field and weight pairs for text indexes.
Concrete fields
The name of the index (a default one is computed if none).
The name of the index (a default one is computed if none).