final class DefaultIndexesManager extends IndexesManager
A helper class to manage the indexes on a Mongo 3.x database.
- Alphabetic
- By Inheritance
- DefaultIndexesManager
- IndexesManager
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new DefaultIndexesManager(db: DB with DBMetaCommands)(implicit ec: ExecutionContext)
- db
The subject database.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from DefaultIndexesManager toany2stringadd[DefaultIndexesManager] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (DefaultIndexesManager, B)
- Implicit
- This member is added by an implicit conversion from DefaultIndexesManager toArrowAssoc[DefaultIndexesManager] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- DefaultIndexesManager → IndexesManager
- 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
- DefaultIndexesManager → IndexesManager
- 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
- 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
- DefaultIndexesManager → IndexesManager
- 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
- DefaultIndexesManager → IndexesManager
- def ensuring(cond: (DefaultIndexesManager) => Boolean, msg: => Any): DefaultIndexesManager
- Implicit
- This member is added by an implicit conversion from DefaultIndexesManager toEnsuring[DefaultIndexesManager] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (DefaultIndexesManager) => Boolean): DefaultIndexesManager
- Implicit
- This member is added by an implicit conversion from DefaultIndexesManager toEnsuring[DefaultIndexesManager] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): DefaultIndexesManager
- Implicit
- This member is added by an implicit conversion from DefaultIndexesManager toEnsuring[DefaultIndexesManager] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): DefaultIndexesManager
- Implicit
- This member is added by an implicit conversion from DefaultIndexesManager toEnsuring[DefaultIndexesManager] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from DefaultIndexesManager toStringFormat[DefaultIndexesManager] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- DefaultIndexesManager → IndexesManager
- 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 onCollection(collectionName: String): CollectionIndexesManager
Returns a manager for the given collection.
Returns a manager for the given collection.
- collectionName
the collection name
- Definition Classes
- DefaultIndexesManager → IndexesManager
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def →[B](y: B): (DefaultIndexesManager, B)
- Implicit
- This member is added by an implicit conversion from DefaultIndexesManager toArrowAssoc[DefaultIndexesManager] 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.