Class/Object

org.mongodb.scala

MongoClient

Related Docs: object MongoClient | package scala

Permalink

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

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

Linear Supertypes
Serializable, Serializable, Product, Equals, Closeable, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MongoClient
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Closeable
  7. AutoCloseable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MongoClient(wrapped: com.mongodb.async.client.MongoClient)

    Permalink

    wrapped

    the underlying java MongoClient

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. def close(): Unit

    Permalink

    Close the client, which will close all underlying cached resources, including, for example, sockets and background monitoring threads.

    Close the client, which will close all underlying cached resources, including, for example, sockets and background monitoring threads.

    Definition Classes
    MongoClient → Closeable → AutoCloseable

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def getDatabase(name: String): MongoDatabase

    Permalink

    Gets the database with the given name.

    Gets the database with the given name.

    name

    the name of the database

    returns

    the database

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. def listDatabaseNames(clientSession: ClientSession): Observable[String]

    Permalink

    Get a list of the database names

    Get a list of the database names

    List Databases

    clientSession

    the client session with which to associate this operation

    returns

    an iterable containing all the names of all the databases

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  13. def listDatabaseNames(): Observable[String]

    Permalink

    Get a list of the database names

    Get a list of the database names

    List Databases

    returns

    an iterable containing all the names of all the databases

  14. def listDatabases[TResult](clientSession: ClientSession)(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): ListDatabasesObservable[TResult]

    Permalink

    Gets the list of databases

    Gets the list of databases

    TResult

    the type of the class to use instead of Document.

    clientSession

    the client session with which to associate this operation

    returns

    the fluent list databases interface

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  15. def listDatabases[TResult]()(implicit e: DefaultsTo[TResult, Document], ct: ClassTag[TResult]): ListDatabasesObservable[TResult]

    Permalink

    Gets the list of databases

    Gets the list of databases

    TResult

    the type of the class to use instead of Document.

    returns

    the fluent list databases interface

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. lazy val settings: MongoClientSettings

    Permalink

    Gets the settings that this client uses to connect to server.

    Gets the settings that this client uses to connect to server.

    **Note**: MongoClientSettings is immutable.

    returns

    the settings

  20. def startSession(options: ClientSessionOptions): Observable[ClientSession]

    Permalink

    Creates a client session.

    Creates a client session.

    Note: A ClientSession instance can not be used concurrently in multiple asynchronous operations.

    options

    the options for the client session

    Since

    2.2

    Note

    Requires MongoDB 3.6 or greater

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped