sealed abstract class Index extends AnyRef
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)
- Alphabetic
- By Inheritance
- Index
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Type Members
- abstract type Pack <: SerializationPack
Abstract Value Members
-
abstract
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!
-
abstract
def
options: Pack.Document
Optional parameters for this index (typically specific to an IndexType like Geo2D).
- abstract val pack: Pack
-
abstract
def
partialFilter: Option[Pack.Document]
Optional partial filter
Optional partial filter
- Since
MongoDB 3.2
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
-
def
_2dsphereIndexVersion: Option[Int]
An optional
2dsphere
index version number.An optional
2dsphere
index version number.- Annotations
- @SuppressWarnings()
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
background: Boolean
If this index should be built in background.
If this index should be built in background. You should read the documentation about background indexing before using it.
-
def
bits: Option[Int]
Optionally indicates the precision of geohash for 2d indexes.
-
def
bucketSize: Option[Double]
Optionally specifies the number of units within which to group the location values for geoHaystack indexes.
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
collation: Option[Collation]
An optional Collation (default:
None
) -
def
defaultLanguage: Option[String]
An optional default language for text indexes.
- 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 → AnyRef → Any
- Annotations
- @SuppressWarnings()
-
lazy val
eventualName: String
The name of the index (a default one is computed if none).
-
def
expireAfterSeconds: Option[Int]
Optionally specifies a value, in seconds, as a TTL to control how long MongoDB retains documents in this collection.
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- Index → AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
languageOverride: Option[String]
An optional language override for text indexes.
-
def
max: Option[Double]
Optionally indicates the upper inclusive boundary for longitude and latitude for 2d indexes.
-
def
min: Option[Double]
Optionally indicates the lower inclusive boundary for longitude and latitude for 2d indexes.
-
def
name: Option[String]
The name of this index (default:
None
).The name of this index (default:
None
). 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
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.
-
def
storageEngine: Option[Pack.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.
- Since
MongoDB 3.0
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
textIndexVersion: Option[Int]
An optional
text
index version number. -
def
toString(): String
- Definition Classes
- Index → AnyRef → Any
-
def
unique: Boolean
The flag to enforces uniqueness (default:
false
) -
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( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
weights: Option[Pack.Document]
An optional document that contains field and weight pairs for text indexes.
- def wildcardProjection: Option[Pack.Document]
- def →[B](y: B): (Index, B)