Type Members

1.  case class AggregateObservable[TResult](wrapped: AggregateIterable[TResult]) extends Observable[TResult] with Product with Serializable

   Observable for aggregate

   Observable for aggregate

   TResult

   The type of the result.

   wrapped

   the underlying java AggregateObservable

   Since

   1.0

2.  type AutoEncryptionSettings = com.mongodb.AutoEncryptionSettings

   The client-side automatic encryption settings.

   The client-side automatic encryption settings. Client side encryption enables an application to specify what fields in a collection must be encrypted, and the driver automatically encrypts commands sent to MongoDB and decrypts responses.

   Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view and will result in error. To bypass automatic encryption, set bypassAutoEncryption=true in AutoEncryptionSettings.

   Explicit encryption/decryption and automatic decryption is a community feature, enabled with the new com.mongodb.client.vault.ClientEncryption type.

   A MongoClient configured with bypassAutoEncryption=true will still automatically decrypt.

   If automatic encryption fails on an operation, use a MongoClient configured with bypassAutoEncryption=true and use ClientEncryption#encrypt to manually encrypt values.

   Enabling client side encryption reduces the maximum document and message size (using a maxBsonObjectSize of 2MiB and maxMessageSizeBytes of 6MB) and may have a negative performance impact.

   Automatic encryption requires the authenticated user to have the listCollections privilege action.

   Since

   2.7

3.  type BulkWriteResult = com.mongodb.bulk.BulkWriteResult

   The result of a successful bulk write operation.

4.  case class ChangeStreamObservable[TResult](wrapped: ChangeStreamIterable[TResult]) extends Observable[ChangeStreamDocument[TResult]] with Product with Serializable

   Observable for change streams.

   Observable for change streams.

   Note: The ChangeStreamDocument class will not be applicable for all change stream outputs. If using custom pipelines that radically change the result, the the ChangeStreamObservable#withDocumentClass method should be used to provide an alternative document format.

   TResult

   The type of the result.

   wrapped

   the underlying java ChangeStreamIterable

   Since

   2.2

   Note

   Requires MongoDB 3.6 or greater

5.  type ClientEncryptionSettings = com.mongodb.ClientEncryptionSettings

   The client-side settings for data key creation and explicit encryption.

   The client-side settings for data key creation and explicit encryption.

   Explicit encryption/decryption is a community feature, enabled with the new com.mongodb.client.vault.ClientEncryption type, for which this is the settings.

   Since

   2.7

6.  type ClientSession = com.mongodb.async.client.ClientSession

   A Client Session

   A Client Session

   Since

   2.4

7.  trait ClientSessionImplicits extends AnyRef

   Extends the Java ClientSession and adds helpers for committing and aborting transactions.

   Extends the Java ClientSession and adds helpers for committing and aborting transactions.

   Automatically imported into the org.mongodb.scala namespace

8.  implicit class ScalaClientSession extends AnyRef

   The implicit ClientSession with Scala helpers

   The implicit ClientSession with Scala helpers

   Definition Classes

   ClientSessionImplicits

9.  type ClientSessionOptions = com.mongodb.ClientSessionOptions

   Options for creating ClientSessions

   Options for creating ClientSessions

   Since

   2.2

10.  case class Completed() extends Product with Serializable

    Represents the result of completed operation that produces no real results.

    Represents the result of completed operation that produces no real results.

    This allows Observables to be composed rather than just completing without a result.

11.  case class DistinctObservable[TResult](wrapped: DistinctIterable[TResult]) extends Observable[TResult] with Product with Serializable

    Observable for distinct

    Observable for distinct

    TResult

    The type of the result.

    wrapped

    the underlying java DistinctObservable

    Since

    1.0

12.  type Document = scala.bson.collection.immutable.Document

    An immutable Document implementation.

    An immutable Document implementation.

    A strictly typed Map[String, BsonValue] like structure that traverses the elements in insertion order. Unlike native scala maps there is no variance in the value type and it always has to be a BsonValue.

13.  type DuplicateKeyException = com.mongodb.DuplicateKeyException

    Subclass of WriteConcernException representing a duplicate key exception

14.  case class FindObservable[TResult](wrapped: FindIterable[TResult]) extends Observable[TResult] with Product with Serializable

    Observable interface for Find.

    Observable interface for Find.

    TResult

    The type of the result.

    wrapped

    the underlying java FindObservable

    Since

    1.0

15.  case class ListCollectionsObservable[TResult](wrapped: ListCollectionsIterable[TResult]) extends Observable[TResult] with Product with Serializable

    Observable interface for ListCollections

    Observable interface for ListCollections

    TResult

    The type of the result.

    wrapped

    the underlying java ListCollectionsObservable

    Since

    1.0

16.  case class ListDatabasesObservable[TResult](wrapped: ListDatabasesIterable[TResult]) extends Observable[TResult] with Product with Serializable

    Observable interface for ListDatabases.

    Observable interface for ListDatabases.

    TResult

    The type of the result.

    wrapped

    the underlying java ListDatabasesObservable

    Since

    1.0

17.  case class ListIndexesObservable[TResult](wrapped: ListIndexesIterable[TResult]) extends Observable[TResult] with Product with Serializable

    Observable interface for ListIndexes.

    Observable interface for ListIndexes.

    TResult

    The type of the result.

    wrapped

    the underlying java ListIndexesObservable

    Since

    1.0

18.  case class MapReduceObservable[TResult](wrapped: MapReduceIterable[TResult]) extends Observable[TResult] with Product with Serializable

    Observable for map reduce.

19.  type MongoBulkWriteException = com.mongodb.MongoBulkWriteException

    An exception that represents all errors associated with a bulk write operation.

20.  type MongoChangeStreamException = com.mongodb.MongoChangeStreamException

    An exception indicating that a failure occurred when running a $changeStream.

    An exception indicating that a failure occurred when running a $changeStream.

    Since

    2.2

21.  case class MongoClient(wrapped: com.mongodb.async.client.MongoClient) extends Closeable with Product with Serializable

    A client-side representation of a MongoDB cluster.

    A client-side representation of a MongoDB cluster. Instances can represent either a standalone MongoDB instance, a replica set, or a sharded cluster. Instance of this class are responsible for maintaining an up-to-date state of the cluster, and possibly cache resources related to this, including background threads for monitoring, and connection pools.

    Instance of this class server as factories for MongoDatabase instances.

    wrapped

    the underlying java MongoClient

    Since

    1.0

22.  type MongoClientException = com.mongodb.MongoClientException

    A base class for exceptions indicating a failure condition with the MongoClient.

23.  type MongoClientSettings = com.mongodb.MongoClientSettings

    Various settings to control the behavior of a MongoClient.

24.  case class MongoCollection[TResult](wrapped: com.mongodb.async.client.MongoCollection[TResult]) extends Product with Serializable

    The MongoCollection representation.

    The MongoCollection representation.

    TResult

    The type that this collection will encode documents from and decode documents to.

    wrapped

    the underlying java MongoCollection

    Since

    1.0

25.  type MongoCommandException = com.mongodb.MongoCommandException

    An exception indicating that a command sent to a MongoDB server returned a failure.

26.  type MongoCompressor = com.mongodb.MongoCompressor

    Options for creating MongoCompressor

    Options for creating MongoCompressor

    Since

    2.2

27.  type MongoCredential = com.mongodb.MongoCredential

    Represents credentials to authenticate to a MongoDB server,as well as the source of the credentials and the authentication mechanism to use.

28.  type MongoCursorNotFoundException = com.mongodb.MongoCursorNotFoundException

    Subclass of MongoException representsing a cursor-not-found exception.

29.  case class MongoDatabase(wrapped: com.mongodb.async.client.MongoDatabase) extends Product with Serializable

    The MongoDatabase representation.

    The MongoDatabase representation.

    wrapped

    the underlying java MongoDatabase

    Since

    1.0

30.  type MongoDriverInformation = com.mongodb.MongoDriverInformation

    The MongoDriverInformation class allows driver and library authors to add extra information about their library.

    The MongoDriverInformation class allows driver and library authors to add extra information about their library. This information is then available in the MongoD/MongoS logs.

    The following metadata can be included when creating a MongoClient.

    • The driver name. Eg: mongo-scala-driver
    • The driver version. Eg: 1.2.0
    • Extra platform information. Eg: Scala 2.11

    Note: Library authors are responsible for accepting MongoDriverInformation from external libraries using their library. Also all the meta data is limited to 512 bytes and any excess data will be truncated.

    Since

    1.2

    Note

    Requires MongoDB 3.4 or greater

31.  type MongoException = com.mongodb.MongoException

    Top level Exception for all Exceptions, server-side or client-side, that come from the driver.

32.  type MongoExecutionTimeoutException = com.mongodb.MongoExecutionTimeoutException

    Exception indicating that the execution of the current operation timed out as a result of the maximum operation time being exceeded.

33.  type MongoIncompatibleDriverException = com.mongodb.MongoIncompatibleDriverException

    An exception indicating that this version of the driver is not compatible with at least one of the servers that it is currently connected to.

34.  type MongoInternalException = com.mongodb.MongoInternalException

    A Mongo exception internal to the driver, not carrying any error code.

35.  type MongoInterruptedException = com.mongodb.MongoInterruptedException

    A non-checked exception indicating that the driver has been interrupted by a call to Thread.interrupt.

36.  type MongoNamespace = com.mongodb.MongoNamespace

    A MongoDB namespace, which includes a database name and collection name.

37.  type MongoNodeIsRecoveringException = com.mongodb.MongoNodeIsRecoveringException

    An exception indicating that the server is a member of a replica set but is in recovery mode, and therefore refused to execute the operation.

    An exception indicating that the server is a member of a replica set but is in recovery mode, and therefore refused to execute the operation. This can happen when a server is starting up and trying to join the replica set.

38.  type MongoNotPrimaryException = com.mongodb.MongoNotPrimaryException

    An exception indicating that the server is a member of a replica set but is not the primary, and therefore refused to execute either a write operation or a read operation that required a primary.

    An exception indicating that the server is a member of a replica set but is not the primary, and therefore refused to execute either a write operation or a read operation that required a primary. This can happen during a replica set election.

39.  type MongoQueryException = com.mongodb.MongoQueryException

    An exception indicating that a query operation failed on the server.

40.  type MongoSecurityException = com.mongodb.MongoSecurityException

    This exception is thrown when there is an error reported by the underlying client authentication mechanism.

41.  type MongoServerException = com.mongodb.MongoServerException

    An exception indicating that some error has been raised by a MongoDB server in response to an operation.

42.  type MongoSocketClosedException = com.mongodb.MongoSocketClosedException

    This exception is thrown when trying to read or write from a closed socket.

43.  type MongoSocketException = com.mongodb.MongoSocketException

    Subclass of MongoException representing a network-related exception

44.  type MongoSocketOpenException = com.mongodb.MongoSocketOpenException

    This exception is thrown when there is an exception opening a Socket.

45.  type MongoSocketReadException = com.mongodb.MongoSocketReadException

    This exception is thrown when there is an exception reading a response from a Socket.

46.  type MongoSocketReadTimeoutException = com.mongodb.MongoSocketReadTimeoutException

    This exception is thrown when there is a timeout reading a response from the socket.

47.  type MongoSocketWriteException = com.mongodb.MongoSocketWriteException

    This exception is thrown when there is an exception writing a response to a Socket.

48.  type MongoTimeoutException = com.mongodb.MongoTimeoutException

    An exception indicating that the driver has timed out waiting for either a server or a connection to become available.

49.  type MongoWaitQueueFullException = com.mongodb.MongoWaitQueueFullException

    An exception indicating that the queue for waiting for a pooled connection is full.

    An exception indicating that the queue for waiting for a pooled connection is full.

    See also

    http://api.mongodb.org/java/current/com/mongodb/connection/ConnectionPoolSettings.html#getMaxWaitQueueSize--

50.  type MongoWriteConcernException = com.mongodb.MongoWriteConcernException

    An exception indicating a failure to apply the write concern to the requested write operation

    An exception indicating a failure to apply the write concern to the requested write operation

    See also

    WriteConcern

51.  type MongoWriteException = com.mongodb.MongoWriteException

    An exception indicating the failure of a write operation.

52.  trait Observable[T] extends com.mongodb.async.client.Observable[T]

    A Observable represents a MongoDB operation.

    A Observable represents a MongoDB operation.

    As such it is a provider of a potentially unbounded number of sequenced elements, publishing them according to the demand received from its Observer(s).

    T

    the type of element signaled.

53.  trait ObservableImplicits extends AnyRef

    Extends the Java Observable and adds helpers to make Observables composable and simple to Subscribe to.

    Extends the Java Observable and adds helpers to make Observables composable and simple to Subscribe to.

    Automatically imported into the org.mongodb.scala namespace

54.  implicit class BoxedObservable[T] extends Observable[T]

    Definition Classes

    ObservableImplicits

55.  implicit class BoxedObserver[T] extends Observer[T]

    Definition Classes

    ObservableImplicits

56.  implicit class BoxedSubscription extends Subscription

    Definition Classes

    ObservableImplicits

57.  implicit class ScalaObservable[T] extends AnyRef

    Extends the Java Observable and adds helpers to make Observables composable and simple to Subscribe to.

    Extends the Java Observable and adds helpers to make Observables composable and simple to Subscribe to.

    T

    the type of result the Observable emits

    Definition Classes

    ObservableImplicits

58.  implicit class ScalaSingleObservable[T] extends AnyRef

    Extends SingleObservable to provide simple conversion to a future.

    Extends SingleObservable to provide simple conversion to a future.

    T

    the type of result

    Definition Classes

    ObservableImplicits

    Since

    2.0

59.  implicit class ToSingleObservable[T] extends SingleObservable[T]

    Converts an observable to a SingleObservable

    Converts an observable to a SingleObservable

    T

    the type of element signaled.

    Definition Classes

    ObservableImplicits

    Since

    2.0

60.  trait Observer[T] extends com.mongodb.async.client.Observer[T]

    A Scala based wrapper of the Observer interface which provides a mechanism for receiving push-based notifications.

    A Scala based wrapper of the Observer interface which provides a mechanism for receiving push-based notifications.

    Will receive a call to Observer.onSubscribe(subscription: Subscription) on subscription to the Observable.

    Default implementations of this trait are greedy and will call Subscription.request with Long.MaxValue so that all results are requested. Custom implementations of the onSubscribe method can be used to control "back-pressure" and ensure that only demand that the Observer is capable of handling is requested.

    After signaling demand:

    - One or more invocations of Observer.onNext up to the maximum number defined by Subscription.request - Single invocation of Observer.onError or Observer.onComplete which signals a terminal state after which no further events will be sent.

    T

    The type of element signaled.

61.  type ReadConcern = com.mongodb.ReadConcern

    Controls the level of isolation for reads.

    Controls the level of isolation for reads.

    Since

    1.1

62.  type ReadConcernLevel = com.mongodb.ReadConcernLevel

    The readConcern option allows clients to choose a level of isolation for their reads.

    The readConcern option allows clients to choose a level of isolation for their reads.

    Since

    1.1

    See also

    ReadConcern

63.  type ReadPreference = com.mongodb.ReadPreference

    Represents preferred replica set members to which a query or command can be sent.

64.  implicit class ScalaWriteConcern[T] extends AnyRef

    Definition Classes

    WriteConcernImplicits

65.  type ServerAddress = com.mongodb.ServerAddress

    Represents the location of a MongoDB server

66.  trait SingleObservable[T] extends Observable[T] with com.mongodb.async.client.Observable[T]

    A SingleObservable represents an Observable that contains only a single item.

    A SingleObservable represents an Observable that contains only a single item.

    T

    the type of element signaled.

    Since

    2.0

67.  trait Subscription extends com.mongodb.async.client.Subscription

    A Subscription represents a one-to-one lifecycle of a Observer subscribing to an Observable.

    A Subscription represents a one-to-one lifecycle of a Observer subscribing to an Observable.

    Instances can only be used once by a single Observer.

    It is used to both signal desire for data and to allow for unsubscribing.

68.  type Tag = com.mongodb.Tag

    A replica set tag

69.  type TagSet = com.mongodb.TagSet

    An immutable set of tags, used to select members of a replica set to use for read operations.

70.  type TaggableReadPreference = com.mongodb.TaggableReadPreference

    Represents ReadPreferences that can be combined with tags

71.  type TransactionOptions = com.mongodb.TransactionOptions

    Options for transactions

    Options for transactions

    Since

    2.4

72.  type WriteConcern = com.mongodb.WriteConcern

    Controls the acknowledgment of write operations with various options.

73.  type WriteConcernException = com.mongodb.WriteConcernException

    An exception representing an error reported due to a write failure.

74.  type WriteConcernResult = com.mongodb.WriteConcernResult

    The result of a successful write operation.

    The result of a successful write operation. If the write was unacknowledged, then wasAcknowledged will return false and all other methods with throw MongoUnacknowledgedWriteException.

    See also

    WriteConcern

75.  type WriteError = com.mongodb.WriteError

    Represents the details of a write error , e.g.

    Represents the details of a write error , e.g. a duplicate key error