Aborts the transaction associated with the current client session (since MongoDB 4.0), if any otherwise does nothing .

Aborts the transaction associated with the current client session (since MongoDB 4.0), if any otherwise does nothing .

import scala.concurrent.ExecutionContext
import reactivemongo.api.DB

def equivalentTo(db: DB)(implicit ec: ExecutionContext) =
  db.abortTransaction(failIfNotStarted = false)

Returns a reactivemongo.api.Collection reference from this database (alias for the collection method).

Authenticates the connection on this database.

Returns a reactivemongo.api.Collection reference from this database.

Returns the names of the collections in this database.

import scala.concurrent.{ ExecutionContext, Future }
import reactivemongo.api.DB

def listCollections(db: DB)(
  implicit ec: ExecutionContext): Future[List[String]] =
  db.collectionNames

Commits the transaction associated with the current client session (since MongoDB 4.0), if any otherwise does nothing .

import scala.concurrent.ExecutionContext
import reactivemongo.api.DB

def commitIt(db: DB)(implicit ec: ExecutionContext) =
  db.commitTransaction(failIfNotStarted = true)

Commits the transaction associated with the current client session (since MongoDB 4.0), if any otherwise does nothing .

import scala.concurrent.ExecutionContext
import reactivemongo.api.DB

def equivalentTo(db: DB)(implicit ec: ExecutionContext) =
  db.commitTransaction(failIfNotStarted = false)

Create the user with given properties.

import scala.concurrent.{ ExecutionContext, Future }

import reactivemongo.api.{
  DB,
  ScramSha256Authentication,
  ScramSha1Authentication,
  WriteConcern
}
import reactivemongo.api.commands.UserRole

def createReadWriteUser(db: DB, name: String)(
  implicit ec: ExecutionContext): Future[Unit] =
  db.createUser(
    user = name,
    pwd = None, // no initial password
    roles = List(UserRole("readWrite")),
    digestPassword = true,
    writeConcern = WriteConcern.Default,
    restrictions = List.empty,
    mechanisms = List(
      ScramSha1Authentication, ScramSha256Authentication))

Drops this database.

import scala.concurrent.{ ExecutionContext, Future }
import reactivemongo.api.DB

def dropDB(db: DB)(
  implicit ec: ExecutionContext): Future[Unit] = db.drop()

Ends (closes) the session associated with this database reference (since MongoDB 3.6), if any otherwise does nothing .

Ends (closes) the session associated with this database reference (since MongoDB 3.6), if any otherwise does nothing .

import scala.concurrent.ExecutionContext
import reactivemongo.api.DB

def equivalentTo(db: DB)(implicit ec: ExecutionContext) =
  db.endSession(failIfNotStarted = false)

EXPERIMENTAL: API may change without notice.

The GridFS with the default serialization.

The GridFS with the default serialization.

The GridFS with the default serialization and collection prefix.

import reactivemongo.api.DB
import reactivemongo.api.bson.BSONDocument

def findFile(db: DB, query: BSONDocument) = db.gridfs.find(query)

Returns an index manager for this database.

import scala.concurrent.{ ExecutionContext, Future }

import reactivemongo.api.DB
import reactivemongo.api.indexes.NSIndex

def listIndexes(db: DB)(
  implicit ec: ExecutionContext): Future[List[String]] =
  db.indexesManager.list().map(_.flatMap { ni: NSIndex =>
    ni.index.name.toList
  })

Kills (aborts) the session associated with this database reference (since MongoDB 3.6), if any otherwise does nothing .

Kills (aborts) the session associated with this database reference (since MongoDB 3.6), if any otherwise does nothing .

import scala.concurrent.ExecutionContext
import reactivemongo.api.DB

def equivalentTo(db: DB)(implicit ec: ExecutionContext) =
  db.killSession(failIfNotStarted = false)

The serialization pack (BSON by default).

Used to resolve the types of values (by default BSONValue, BSONDocument, ...), and the related typeclasses (e.g. BSONDocumentReader ...).

Tests if the server, resolved according to the given read preference, responds to commands.

Renames a collection. Can only be executed if the this database reference is the admin one.

import scala.concurrent.{ ExecutionContext, Future }
import reactivemongo.api.DB

def addCollSuffix(
  admin: DB,
  coll: String,
  suffix: String)(implicit ec: ExecutionContext): Future[Unit] =
  admin.renameCollection("myDB", coll, coll + suffix).map(_ => {})

Run a raw command (represented by a document).

import reactivemongo.api.FailoverStrategy
import reactivemongo.api.bson.BSONDocument

def getUsers(db: reactivemongo.api.DB) =
  db.runCommand(BSONDocument("usersInfo" -> 1), FailoverStrategy.default)

Starts a new session (since MongoDB 3.6).

import scala.concurrent.ExecutionContext
import reactivemongo.api.DB

def startIt(db: DB)(implicit ec: ExecutionContext) =
  db.startSession(failIfAlreadyStarted = true)

Starts a new session (since MongoDB 3.6), does nothing if a session has already being started .

import scala.concurrent.ExecutionContext
import reactivemongo.api.DB

def equivalentTo(db: DB)(implicit ec: ExecutionContext) =
  db.startSession(failIfAlreadyStarted = false)

Starts a transaction (since MongoDB 4.0), if none is already started with the current client session otherwise does nothing.

It fails if no session is previously started (see startSession).

import scala.concurrent.ExecutionContext
import reactivemongo.api.{ DB, WriteConcern }

def doIt(db: DB, aWriteConcern: Option[WriteConcern])(
  implicit ec: ExecutionContext) =
  db.startTransaction(aWriteConcern, failIfAlreadyStarted = true)

Starts a transaction (since MongoDB 4.0), if none is already started with the current client session otherwise does nothing.

It fails if no session is previously started (see startSession).

import scala.concurrent.ExecutionContext
import reactivemongo.api.{ DB, WriteConcern }

def equivalentTo(db: DB, aWriteConcern: Option[WriteConcern])(
  implicit ec: ExecutionContext) =
  db.startTransaction(aWriteConcern, failIfAlreadyStarted = false)