Packages

c

uk.gov.hmrc.mongo.play.json

PlayMongoRepository

class PlayMongoRepository[A] extends MongoDatabaseCollection

Initialise a mongo repository.

Linear Supertypes
MongoDatabaseCollection, AnyRef, Any
Known Subclasses
MongoCacheRepository, MongoLockRepository
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlayMongoRepository
  2. MongoDatabaseCollection
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PlayMongoRepository(mongoComponent: MongoComponent, collectionName: String, domainFormat: Format[A], indexes: Seq[IndexModel], optSchema: Option[BsonDocument] = None, replaceIndexes: Boolean = false, extraCodecs: Seq[Codec[_]] = Seq.empty)(implicit arg0: ClassTag[A], ec: ExecutionContext)

    collectionName

    the name of the mongo collection.

    domainFormat

    a play Json format to map the domain to mongo entities.

    indexes

    indexes to ensure are created.

    optSchema

    optional schema to validate entities written to the collection

    replaceIndexes

    If true, existing indices should be removed/updated to match the provided indices. If false, any old indices are left behind, and indices with changed definitions will throw IndexConflict exceptions.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. lazy val collection: MongoCollection[A]
  7. final val collectionName: String
    Definition Classes
    PlayMongoRepository → MongoDatabaseCollection
  8. final val domainFormat: Format[A]
  9. def ensureIndexes: Future[Seq[String]]
  10. def ensureSchema: Future[Unit]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final val indexes: Seq[IndexModel]
    Definition Classes
    PlayMongoRepository → MongoDatabaseCollection
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final val optSchema: Option[BsonDocument]
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MongoDatabaseCollection

Inherited from AnyRef

Inherited from Any

Ungrouped