Package com.mongodb.reactivestreams.client

Interface MongoClient

  • All Superinterfaces:
    AutoCloseable, Closeable
    @Immutable
public interface MongoClient
extends Closeable
    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.

    Since:
    1.0

    • Method Detail

      • getDatabase

        MongoDatabase getDatabase​(String name)
        Gets the database with the given name.
        Parameters:
        name - the name of the database
        Returns:
        the database

      • close

        void close()
        Close the client, which will close all underlying cached resources, including, for example, sockets and background monitoring threads.
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface Closeable

      • listDatabaseNames

        org.reactivestreams.Publisher<String> listDatabaseNames()
        Get a list of the database names
        Returns:
        an iterable containing all the names of all the databases
        MongoDB documentation
        List Databases

      • listDatabaseNames

        org.reactivestreams.Publisher<String> listDatabaseNames​(ClientSession clientSession)
        Get a list of the database names
        Parameters:
        clientSession - the client session with which to associate this operation
        Returns:
        an iterable containing all the names of all the databases
        Since:
        1.7
        MongoDB documentation
        List Databases
        Since server release
        3.6

      • listDatabases

        <TResult> ListDatabasesPublisher<TResult> listDatabases​(Class<TResult> clazz)
        Gets the list of databases
        Type Parameters:
        TResult - the type of the class to use instead of Document.
        Parameters:
        clazz - the class to cast the database documents to
        Returns:
        the fluent list databases interface

      • listDatabases

        ListDatabasesPublisher<Document> listDatabases​(ClientSession clientSession)
        Gets the list of databases
        Parameters:
        clientSession - the client session with which to associate this operation
        Returns:
        the fluent list databases interface
        Since:
        1.7
        Since server release
        3.6

      • listDatabases

        <TResult> ListDatabasesPublisher<TResult> listDatabases​(ClientSession clientSession,
                                                        Class<TResult> clazz)
        Gets the list of databases
        Type Parameters:
        TResult - the type of the class to use instead of Document.
        Parameters:
        clientSession - the client session with which to associate this operation
        clazz - the class to cast the database documents to
        Returns:
        the fluent list databases interface
        Since:
        1.7
        Since server release
        3.6

      • watch

        <TResult> ChangeStreamPublisher<TResult> watch​(Class<TResult> resultClass)
        Creates a change stream for this client.
        Type Parameters:
        TResult - the target document type of the iterable.
        Parameters:
        resultClass - the class to decode each document into
        Returns:
        the change stream iterable
        Since:
        1.9
        MongoDB documentation
        Change Streams
        Since server release
        4.0

      • watch

        ChangeStreamPublisher<Document> watch​(List<? extends Bson> pipeline)
        Creates a change stream for this client.
        Parameters:
        pipeline - the aggregation pipeline to apply to the change stream.
        Returns:
        the change stream iterable
        Since:
        1.9
        MongoDB documentation
        Change Streams
        Since server release
        4.0

      • watch

        <TResult> ChangeStreamPublisher<TResult> watch​(List<? extends Bson> pipeline,
                                               Class<TResult> resultClass)
        Creates a change stream for this client.
        Type Parameters:
        TResult - the target document type of the iterable.
        Parameters:
        pipeline - the aggregation pipeline to apply to the change stream
        resultClass - the class to decode each document into
        Returns:
        the change stream iterable
        Since:
        1.9
        MongoDB documentation
        Change Streams
        Since server release
        4.0

      • watch

        ChangeStreamPublisher<Document> watch​(ClientSession clientSession)
        Creates a change stream for this client.
        Parameters:
        clientSession - the client session with which to associate this operation
        Returns:
        the change stream iterable
        Since:
        1.9
        MongoDB documentation
        Change Streams
        Since server release
        4.0

      • watch

        <TResult> ChangeStreamPublisher<TResult> watch​(ClientSession clientSession,
                                               Class<TResult> resultClass)
        Creates a change stream for this client.
        Type Parameters:
        TResult - the target document type of the iterable.
        Parameters:
        clientSession - the client session with which to associate this operation
        resultClass - the class to decode each document into
        Returns:
        the change stream iterable
        Since:
        1.9
        MongoDB documentation
        Change Streams
        Since server release
        4.0

      • watch

        ChangeStreamPublisher<Document> watch​(ClientSession clientSession,
                                      List<? extends Bson> pipeline)
        Creates a change stream for this client.
        Parameters:
        clientSession - the client session with which to associate this operation
        pipeline - the aggregation pipeline to apply to the change stream.
        Returns:
        the change stream iterable
        Since:
        1.9
        MongoDB documentation
        Change Streams
        Since server release
        4.0

      • watch

        <TResult> ChangeStreamPublisher<TResult> watch​(ClientSession clientSession,
                                               List<? extends Bson> pipeline,
                                               Class<TResult> resultClass)
        Creates a change stream for this client.
        Type Parameters:
        TResult - the target document type of the iterable.
        Parameters:
        clientSession - the client session with which to associate this operation
        pipeline - the aggregation pipeline to apply to the change stream
        resultClass - the class to decode each document into
        Returns:
        the change stream iterable
        Since:
        1.9
        MongoDB documentation
        Change Streams
        Since server release
        4.0

      • startSession

        org.reactivestreams.Publisher<ClientSession> startSession()
        Creates a client session.
        Returns:
        a publisher for the client session.
        Since:
        1.9
        Since server release
        3.6

      • startSession

        org.reactivestreams.Publisher<ClientSession> startSession​(ClientSessionOptions options)
        Creates a client session.
        Parameters:
        options - the options for the client session
        Returns:
        a publisher for the client session.
        Since:
        1.7
        Since server release
        3.6