Object/Class

reactivemongo.api.indexes

Index

Related Docs: class Index | package indexes

Permalink

object Index extends AbstractFunction9[Seq[(String, IndexType)], Option[String], Boolean, Boolean, Boolean, Boolean, Option[Int], Option[BSONDocument], BSONDocument, Index] with Serializable

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Index
  2. Serializable
  3. Serializable
  4. AbstractFunction9
  5. Function9
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Aux[P] = Index { type Pack = P }

    Permalink
  2. type Default = Index { type Pack = reactivemongo.api.Serialization.Pack }

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object Key

    Permalink

    EXPERIMENTAL: API may change

  5. def apply(key: Seq[(String, IndexType)], name: Option[String], unique: Boolean, background: Boolean, sparse: Boolean, expireAfterSeconds: Option[Int], storageEngine: Option[Document], weights: Option[Document], defaultLanguage: Option[String], languageOverride: Option[String], textIndexVersion: Option[Int], sphereIndexVersion: Option[Int], bits: Option[Int], min: Option[Double], max: Option[Double], bucketSize: Option[Double], collation: Option[Collation], wildcardProjection: Option[Document], version: Option[Int], partialFilter: Option[Document], options: Document): Aux[Pack]

    Permalink

    import reactivemongo.api.bson.BSONDocument
    import reactivemongo.api.bson.collection.BSONSerializationPack
    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)
  6. def apply[P <: SerializationPack](_pack: P)(key: Seq[(String, IndexType)], name: Option[String], unique: Boolean, background: Boolean, dropDups: Boolean, sparse: Boolean, expireAfterSeconds: Option[Int], storageEngine: Option[Index.apply.P.Document], weights: Option[Index.apply.P.Document], defaultLanguage: Option[String], languageOverride: Option[String], textIndexVersion: Option[Int], sphereIndexVersion: Option[Int], bits: Option[Int], min: Option[Double], max: Option[Double], bucketSize: Option[Double], collation: Option[Collation], wildcardProjection: Option[Index.apply.P.Document], version: Option[Int], partialFilter: Option[Index.apply.P.Document], options: Index.apply.P.Document): Aux[P]

    Permalink

    import reactivemongo.api.bson.BSONDocument
    import reactivemongo.api.bson.collection.BSONSerializationPack
    import reactivemongo.api.indexes.{ Index, IndexType }
    
    val bsonIndex = Index(BSONSerializationPack)(
      key = Seq("name" -> IndexType.Ascending),
      name = Some("name_idx"),
      unique = false,
      background = false,
      dropDups = 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)
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def curried: (Seq[(String, IndexType)]) ⇒ (Option[String]) ⇒ (Boolean) ⇒ (Boolean) ⇒ (Boolean) ⇒ (Boolean) ⇒ (Option[Int]) ⇒ (Option[BSONDocument]) ⇒ (BSONDocument) ⇒ Index

    Permalink
    Definition Classes
    Function9
    Annotations
    @unspecialized()
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    Function9 → AnyRef → Any
  21. def tupled: ((Seq[(String, IndexType)], Option[String], Boolean, Boolean, Boolean, Boolean, Option[Int], Option[BSONDocument], BSONDocument)) ⇒ Index

    Permalink
    Definition Classes
    Function9
    Annotations
    @unspecialized()
  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def apply(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.empty): Index

    Permalink
    Definition Classes
    Index → Function9
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.1) Use constructor with pack parameter

  2. def unapply(index: Index): Option[(Seq[(String, IndexType)], Option[String], Boolean, Boolean, Boolean, Boolean, Option[Int], Option[BSONDocument], BSONDocument)]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.1) No longer a ReactiveMongo case class

Inherited from Serializable

Inherited from Serializable

Inherited from (Seq[(String, IndexType)], Option[String], Boolean, Boolean, Boolean, Boolean, Option[Int], Option[BSONDocument], BSONDocument) ⇒ Index

Inherited from AnyRef

Inherited from Any

Ungrouped