Packages

c

org.mongodb.scala

MongoDatabase

case class MongoDatabase(wrapped: com.mongodb.reactivestreams.client.MongoDatabase) extends Product with Serializable

The MongoDatabase representation.

wrapped

the underlying java MongoDatabase

Since

1.0

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MongoDatabase
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MongoDatabase(wrapped: com.mongodb.reactivestreams.client.MongoDatabase)

    wrapped

    the underlying java MongoDatabase

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. def aggregate[C](clientSession: ClientSession, pipeline: Seq[Bson])(implicit e: DefaultsTo[C, Document], ct: ClassTag[C]): AggregateObservable[C]

    Aggregates documents according to the specified aggregation pipeline.

    Aggregates documents according to the specified aggregation pipeline.

    clientSession

    the client session with which to associate this operation

    pipeline

    the aggregate pipeline

    returns

    a Observable containing the result of the aggregation operation Aggregation

    Since

    2.6

    Note

    Requires MongoDB 3.6 or greater

  5. def aggregate[C](pipeline: Seq[Bson])(implicit e: DefaultsTo[C, Document], ct: ClassTag[C]): AggregateObservable[C]

    Aggregates documents according to the specified aggregation pipeline.

    Aggregates documents according to the specified aggregation pipeline.

    pipeline

    the aggregate pipeline

    returns

    a Observable containing the result of the aggregation operation Aggregation

    Since

    2.6

    Note

    Requires MongoDB 3.6 or greater

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. lazy val codecRegistry: CodecRegistry

    Get the codec registry for the MongoDatabase.

    Get the codec registry for the MongoDatabase.

    returns

    the { @link org.bson.codecs.configuration.CodecRegistry}

  9. def createCollection(clientSession: ClientSession, collectionName: String, options: CreateCollectionOptions): SingleObservable[Unit]

    Create a new collection with the selected options

    Create a new collection with the selected options

    Create Command

    clientSession

    the client session with which to associate this operation

    collectionName

    the name for the new collection to create

    options

    various options for creating the collection

    returns

    a Observable identifying when the collection has been created

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  10. def createCollection(clientSession: ClientSession, collectionName: String): SingleObservable[Unit]

    Create a new collection with the given name.

    Create a new collection with the given name.

    Create Command

    clientSession

    the client session with which to associate this operation

    collectionName

    the name for the new collection to create

    returns

    a Observable identifying when the collection has been created

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  11. def createCollection(collectionName: String, options: CreateCollectionOptions): SingleObservable[Unit]

    Create a new collection with the selected options

    Create a new collection with the selected options

    Create Command

    collectionName

    the name for the new collection to create

    options

    various options for creating the collection

    returns

    a Observable identifying when the collection has been created

  12. def createCollection(collectionName: String): SingleObservable[Unit]

    Create a new collection with the given name.

    Create a new collection with the given name.

    Create Command

    collectionName

    the name for the new collection to create

    returns

    a Observable identifying when the collection has been created

  13. def createView(clientSession: ClientSession, viewName: String, viewOn: String, pipeline: Seq[Bson], createViewOptions: CreateViewOptions): SingleObservable[Unit]

    Creates a view with the given name, backing collection/view name, aggregation pipeline, and options that defines the view.

    Creates a view with the given name, backing collection/view name, aggregation pipeline, and options that defines the view.

    Create Command

    clientSession

    the client session with which to associate this operation

    viewName

    the name of the view to create

    viewOn

    the backing collection/view for the view

    pipeline

    the pipeline that defines the view

    createViewOptions

    various options for creating the view

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  14. def createView(clientSession: ClientSession, viewName: String, viewOn: String, pipeline: Seq[Bson]): SingleObservable[Unit]

    Creates a view with the given name, backing collection/view name, and aggregation pipeline that defines the view.

    Creates a view with the given name, backing collection/view name, and aggregation pipeline that defines the view.

    Create Command

    clientSession

    the client session with which to associate this operation

    viewName

    the name of the view to create

    viewOn

    the backing collection/view for the view

    pipeline

    the pipeline that defines the view

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  15. def createView(viewName: String, viewOn: String, pipeline: Seq[Bson], createViewOptions: CreateViewOptions): SingleObservable[Unit]

    Creates a view with the given name, backing collection/view name, aggregation pipeline, and options that defines the view.

    Creates a view with the given name, backing collection/view name, aggregation pipeline, and options that defines the view.

    Create Command

    viewName

    the name of the view to create

    viewOn

    the backing collection/view for the view

    pipeline

    the pipeline that defines the view

    createViewOptions

    various options for creating the view

    Since

    1.2

    Note

    Requires MongoDB 3.4 or greater

  16. def createView(viewName: String, viewOn: String, pipeline: Seq[Bson]): SingleObservable[Unit]

    Creates a view with the given name, backing collection/view name, and aggregation pipeline that defines the view.

    Creates a view with the given name, backing collection/view name, and aggregation pipeline that defines the view.

    Create Command

    viewName

    the name of the view to create

    viewOn

    the backing collection/view for the view

    pipeline

    the pipeline that defines the view

    Since

    1.2

    Note

    Requires MongoDB 3.4 or greater

  17. def drop(clientSession: ClientSession): SingleObservable[Unit]

    Drops this database.

    Drops this database.

    Drop database

    clientSession

    the client session with which to associate this operation

    returns

    a Observable identifying when the database has been dropped

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  18. def drop(): SingleObservable[Unit]

    Drops this database.

    Drops this database.

    Drop database

    returns

    a Observable identifying when the database has been dropped

  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  21. def getCollection[TResult](collectionName: String)(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): MongoCollection[TResult]

    Gets a collection, with a specific default document class.

    Gets a collection, with a specific default document class.

    TResult

    the type of the class to use instead of Document.

    collectionName

    the name of the collection to return

    returns

    the collection

  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def listCollectionNames(clientSession: ClientSession): ListCollectionNamesObservable

    Gets the names of all the collections in this database.

    Gets the names of all the collections in this database.

    listCollections

    clientSession

    the client session with which to associate this operation

    returns

    a Observable with all the names of all the collections in this database

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  24. def listCollectionNames(): ListCollectionNamesObservable

    Gets the names of all the collections in this database.

    Gets the names of all the collections in this database.

    listCollections

    returns

    a Observable with all the names of all the collections in this database

  25. def listCollections[TResult](clientSession: ClientSession)(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): ListCollectionsObservable[TResult]

    Finds all the collections in this database.

    Finds all the collections in this database.

    listCollections

    TResult

    the target document type of the iterable.

    clientSession

    the client session with which to associate this operation

    returns

    the fluent list collections interface

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  26. def listCollections[TResult]()(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): ListCollectionsObservable[TResult]

    Finds all the collections in this database.

    Finds all the collections in this database.

    listCollections

    TResult

    the target document type of the iterable.

    returns

    the fluent list collections interface

  27. lazy val name: String

    Gets the name of the database.

    Gets the name of the database.

    returns

    the database name

  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. def productElementNames: Iterator[String]
    Definition Classes
    Product
  32. lazy val readConcern: ReadConcern

    Get the read concern for the MongoDatabase.

    Get the read concern for the MongoDatabase.

    returns

    the ReadConcern

    Since

    1.1

  33. lazy val readPreference: ReadPreference

    Get the read preference for the MongoDatabase.

    Get the read preference for the MongoDatabase.

    returns

    the { @link com.mongodb.ReadPreference}

  34. def runCommand[TResult](clientSession: ClientSession, command: Bson, readPreference: ReadPreference)(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): SingleObservable[TResult]

    Executes command in the context of the current database.

    Executes command in the context of the current database.

    Note: The behavior of runCommand is undefined if the provided command document includes a maxTimeMS field and the timeoutMS setting has been set.

    TResult

    the type of the class to use instead of Document.

    command

    the command to be run

    readPreference

    the ReadPreference to be used when executing the command

    returns

    a Observable containing the command result

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  35. def runCommand[TResult](clientSession: ClientSession, command: Bson)(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): SingleObservable[TResult]

    Executes command in the context of the current database using the primary server.

    Executes command in the context of the current database using the primary server.

    Note: The behavior of runCommand is undefined if the provided command document includes a maxTimeMS field and the timeoutMS setting has been set.

    TResult

    the type of the class to use instead of Document.

    clientSession

    the client session with which to associate this operation

    command

    the command to be run

    returns

    a Observable containing the command result

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  36. def runCommand[TResult](command: Bson, readPreference: ReadPreference)(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): SingleObservable[TResult]

    Executes command in the context of the current database.

    Executes command in the context of the current database.

    Note: The behavior of runCommand is undefined if the provided command document includes a maxTimeMS field and the timeoutMS setting has been set.

    TResult

    the type of the class to use instead of Document.

    command

    the command to be run

    readPreference

    the ReadPreference to be used when executing the command

    returns

    a Observable containing the command result

  37. def runCommand[TResult](command: Bson)(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): SingleObservable[TResult]

    Executes command in the context of the current database using the primary server.

    Executes command in the context of the current database using the primary server.

    Note: The behavior of runCommand is undefined if the provided command document includes a maxTimeMS field and the timeoutMS setting has been set.

    TResult

    the type of the class to use instead of Document.

    command

    the command to be run

    returns

    a Observable containing the command result

  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. lazy val timeout: Option[Duration]

    The time limit for the full execution of an operation.

    The time limit for the full execution of an operation.

    If not null the following deprecated options will be ignored: waitQueueTimeoutMS, socketTimeoutMS, wTimeoutMS, maxTimeMS and maxCommitTimeMS.

    • null means that the timeout mechanism for operations will defer to using:
      • waitQueueTimeoutMS: The maximum wait time in milliseconds that a thread may wait for a connection to become available
      • socketTimeoutMS: How long a send or receive on a socket can take before timing out.
      • wTimeoutMS: How long the server will wait for the write concern to be fulfilled before timing out.
      • maxTimeMS: The time limit for processing operations on a cursor. See: [cursor.maxTimeMS](https://docs.mongodb.com/manual/reference/method/cursor.maxTimeMS").
      • maxCommitTimeMS: The maximum amount of time to allow a single commitTransaction command to execute.
    • 0 means infinite timeout.
    • > 0 The time limit to use for the full execution of an operation.
    returns

    the optional timeout duration

    Annotations
    @Alpha()
    Since

    5.2

  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. def watch[C](clientSession: ClientSession, pipeline: Seq[Bson])(implicit e: DefaultsTo[C, Document], ct: ClassTag[C]): ChangeStreamObservable[C]

    Creates a change stream for this collection.

    Creates a change stream for this collection.

    C

    the target document type of the observable.

    clientSession

    the client session with which to associate this operation

    pipeline

    the aggregation pipeline to apply to the change stream

    returns

    the change stream observable

    Since

    2.4

    Note

    Requires MongoDB 4.0 or greater

  44. def watch[C](clientSession: ClientSession)(implicit e: DefaultsTo[C, Document], ct: ClassTag[C]): ChangeStreamObservable[C]

    Creates a change stream for this collection.

    Creates a change stream for this collection.

    C

    the target document type of the observable.

    clientSession

    the client session with which to associate this operation

    returns

    the change stream observable

    Since

    2.4

    Note

    Requires MongoDB 4.0 or greater

  45. def watch[C](pipeline: Seq[Bson])(implicit e: DefaultsTo[C, Document], ct: ClassTag[C]): ChangeStreamObservable[C]

    Creates a change stream for this collection.

    Creates a change stream for this collection.

    C

    the target document type of the observable.

    pipeline

    the aggregation pipeline to apply to the change stream

    returns

    the change stream observable

    Since

    2.4

    Note

    Requires MongoDB 4.0 or greater

  46. def watch[C]()(implicit e: DefaultsTo[C, Document], ct: ClassTag[C]): ChangeStreamObservable[C]

    Creates a change stream for this collection.

    Creates a change stream for this collection.

    C

    the target document type of the observable.

    returns

    the change stream observable

    Since

    2.4

    Note

    Requires MongoDB 4.0 or greater

  47. def withCodecRegistry(codecRegistry: CodecRegistry): MongoDatabase

    Create a new MongoDatabase instance with a different codec registry.

    Create a new MongoDatabase instance with a different codec registry.

    The { @link CodecRegistry} configured by this method is effectively treated by the driver as an instance of { @link CodecProvider}, which { @link CodecRegistry} extends. So there is no benefit to defining a class that implements { @link CodecRegistry}. Rather, an application should always create { @link CodecRegistry} instances using the factory methods in { @link CodecRegistries}.

    codecRegistry

    the new { @link org.bson.codecs.configuration.CodecRegistry} for the collection

    returns

    a new MongoDatabase instance with the different codec registry

    See also

    CodecRegistries

  48. def withReadConcern(readConcern: ReadConcern): MongoDatabase

    Create a new MongoDatabase instance with a different read concern.

    Create a new MongoDatabase instance with a different read concern.

    readConcern

    the new ReadConcern for the collection

    returns

    a new MongoDatabase instance with the different ReadConcern

    Since

    1.1

  49. def withReadPreference(readPreference: ReadPreference): MongoDatabase

    Create a new MongoDatabase instance with a different read preference.

    Create a new MongoDatabase instance with a different read preference.

    readPreference

    the new { @link com.mongodb.ReadPreference} for the collection

    returns

    a new MongoDatabase instance with the different readPreference

  50. def withTimeout(timeout: Duration): MongoDatabase

    Sets the time limit for the full execution of an operation.

    Sets the time limit for the full execution of an operation.

    - 0 means infinite timeout. - > 0 The time limit to use for the full execution of an operation.

    timeout

    the timeout, which must be greater than or equal to 0

    returns

    a new MongoDatabase instance with the set time limit for operations

    Annotations
    @Alpha()
    Since

    5.2

  51. def withWriteConcern(writeConcern: WriteConcern): MongoDatabase

    Create a new MongoDatabase instance with a different write concern.

    Create a new MongoDatabase instance with a different write concern.

    writeConcern

    the new { @link com.mongodb.WriteConcern} for the collection

    returns

    a new MongoDatabase instance with the different writeConcern

  52. lazy val writeConcern: WriteConcern

    Get the write concern for the MongoDatabase.

    Get the write concern for the MongoDatabase.

    returns

    the { @link com.mongodb.WriteConcern}

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped