Packages

c

reactivemongo.api.indexes

LegacyIndexesManager

final class LegacyIndexesManager extends IndexesManager

A helper class to manage the indexes on a Mongo 2.x database.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LegacyIndexesManager
  2. IndexesManager
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LegacyIndexesManager(db: DB)(implicit ec: ExecutionContext)

    db

    The subject database.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from LegacyIndexesManager toany2stringadd[LegacyIndexesManager] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (LegacyIndexesManager, B)
    Implicit
    This member is added by an implicit conversion from LegacyIndexesManager toArrowAssoc[LegacyIndexesManager] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val collection: BSONCollection
  9. def create(nsIndex: NSIndex): Future[WriteResult]

    Creates the given index.

    Creates the given index.

    Warning: given the options you choose, and the data to index, it can be a long and blocking operation on the database. You should really consider reading http://www.mongodb.org/display/DOCS/Indexes before doing this, especially in production.

    nsIndex

    the index to create

    Definition Classes
    LegacyIndexesManagerIndexesManager
  10. def drop(collectionName: String, indexName: String): Future[Int]

    Drops the given index on the given collection.

    Drops the given index on the given collection.

    collectionName

    the collection name

    indexName

    the name of the index to be dropped

    returns

    The number of indexes that were dropped.

    Definition Classes
    LegacyIndexesManagerIndexesManager
  11. def drop(nsIndex: NSIndex): Future[Int]

    Drops the given index on the given collection.

    Drops the given index on the given collection.

    returns

    The number of indexes that were dropped.

    Definition Classes
    IndexesManager
  12. def dropAll(collectionName: String): Future[Int]

    Drops all the indexes on the given collection.

    Drops all the indexes on the given collection.

    collectionName

    the collection name

    Definition Classes
    LegacyIndexesManagerIndexesManager
  13. def ensure(nsIndex: NSIndex): Future[Boolean]

    Creates the given index only if it does not exist on this database.

    Creates the given index only if it does not exist on this database.

    The following rules are used to check the matching index: - if nsIndex.isDefined, it checks using the index name, - otherwise it checks using the key.

    Warning: given the options you choose, and the data to index, it can be a long and blocking operation on the database. You should really consider reading http://www.mongodb.org/display/DOCS/Indexes before doing this, especially in production.

    nsIndex

    the index to create

    returns

    true if the index was created, false if it already exists.

    Definition Classes
    LegacyIndexesManagerIndexesManager
  14. def ensuring(cond: (LegacyIndexesManager) => Boolean, msg: => Any): LegacyIndexesManager
    Implicit
    This member is added by an implicit conversion from LegacyIndexesManager toEnsuring[LegacyIndexesManager] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (LegacyIndexesManager) => Boolean): LegacyIndexesManager
    Implicit
    This member is added by an implicit conversion from LegacyIndexesManager toEnsuring[LegacyIndexesManager] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): LegacyIndexesManager
    Implicit
    This member is added by an implicit conversion from LegacyIndexesManager toEnsuring[LegacyIndexesManager] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): LegacyIndexesManager
    Implicit
    This member is added by an implicit conversion from LegacyIndexesManager toEnsuring[LegacyIndexesManager] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  21. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from LegacyIndexesManager toStringFormat[LegacyIndexesManager] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def list(): Future[List[NSIndex]]

    Gets a future list of all the index on this database.

    Gets a future list of all the index on this database.

    Definition Classes
    LegacyIndexesManagerIndexesManager
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def onCollection(collectionName: String): CollectionIndexesManager

    Returns a manager for the given collection.

    Returns a manager for the given collection.

    collectionName

    the collection name

    Definition Classes
    LegacyIndexesManagerIndexesManager
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (LegacyIndexesManager, B)
    Implicit
    This member is added by an implicit conversion from LegacyIndexesManager toArrowAssoc[LegacyIndexesManager] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from IndexesManager

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromLegacyIndexesManager to any2stringadd[LegacyIndexesManager]

Inherited by implicit conversion StringFormat fromLegacyIndexesManager to StringFormat[LegacyIndexesManager]

Inherited by implicit conversion Ensuring fromLegacyIndexesManager to Ensuring[LegacyIndexesManager]

Inherited by implicit conversion ArrowAssoc fromLegacyIndexesManager to ArrowAssoc[LegacyIndexesManager]

Ungrouped