com.mongodb.reactivestreams.client.MongoCluster Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-reactivestreams Show documentation
A Reactive Streams implementation of the MongoDB Java driver
The newest version!
/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.mongodb.reactivestreams.client;

import com.mongodb.ClientBulkWriteException;
import com.mongodb.ClientSessionOptions;
import com.mongodb.MongoClientSettings;
import com.mongodb.MongoException;
import com.mongodb.MongoNamespace;
import com.mongodb.ReadConcern;
import com.mongodb.ReadPreference;
import com.mongodb.WriteConcern;
import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Immutable;
import com.mongodb.annotations.Reason;
import com.mongodb.client.model.bulk.ClientBulkWriteOptions;
import com.mongodb.client.model.bulk.ClientBulkWriteResult;
import com.mongodb.client.model.bulk.ClientNamespacedDeleteManyModel;
import com.mongodb.client.model.bulk.ClientNamespacedUpdateManyModel;
import com.mongodb.client.model.bulk.ClientNamespacedWriteModel;
import com.mongodb.lang.Nullable;
import org.bson.Document;
import org.bson.codecs.configuration.CodecRegistry;
import org.bson.conversions.Bson;
import org.reactivestreams.Publisher;

import java.util.List;
import java.util.concurrent.TimeUnit;

/**
 * The client-side representation of a MongoDB cluster operations.
 *
 * 
 * The originating {@link MongoClient} is responsible for the closing of resources.
 * If the originator {@link MongoClient} is closed, then any cluster operations will fail.
 * 
 *
 * @see MongoClient
 * @since 5.2
 */
@Immutable
public interface MongoCluster {

    /**
     * Get the codec registry for the MongoCluster.
     *
     * @return the {@link CodecRegistry}
     * @since 5.2
     */
    CodecRegistry getCodecRegistry();

    /**
     * Get the read preference for the MongoCluster.
     *
     * @return the {@link ReadPreference}
     * @since 5.2
     */
    ReadPreference getReadPreference();

    /**
     * Get the write concern for the MongoCluster.
     *
     * @return the {@link WriteConcern}
     * @since 5.2
     */
    WriteConcern getWriteConcern();

    /**
     * Get the read concern for the MongoCluster.
     *
     * @return the {@link ReadConcern}
     * @since 5.2
     * @mongodb.driver.manual reference/readConcern/ Read Concern
     */
    ReadConcern getReadConcern();

    /**
     * The time limit for the full execution of an operation.
     *
     * If not null the following deprecated options will be ignored:
     * {@code waitQueueTimeoutMS}, {@code socketTimeoutMS}, {@code wTimeoutMS}, {@code maxTimeMS} and {@code maxCommitTimeMS}
     *
     * 
     *   {@code null} means that the timeout mechanism for operations will defer to using:
     *    
     *        {@code waitQueueTimeoutMS}: The maximum wait time in milliseconds that a thread may wait for a connection to become
     *        available
     *        {@code socketTimeoutMS}: How long a send or receive on a socket can take before timing out.
     *        {@code wTimeoutMS}: How long the server will wait for the write concern to be fulfilled before timing out.
     *        {@code maxTimeMS}: The cumulative time limit for processing operations on a cursor.
     *        See: cursor.maxTimeMS.
     *        {@code maxCommitTimeMS}: The maximum amount of time to allow a single {@code commitTransaction} command to execute.
     *        See: {@link com.mongodb.TransactionOptions#getMaxCommitTime}.
     *   
     *   
     *   {@code 0} means infinite timeout.
     *    {@code > 0} The time limit to use for the full execution of an operation.
     * 
     *
     * @param timeUnit the time unit
     * @return the timeout in the given time unit
     * @since 5.2
     */
    @Alpha(Reason.CLIENT)
    @Nullable
    Long getTimeout(TimeUnit timeUnit);

    /**
     * Create a new MongoCluster instance with a different codec registry.
     *
     * The {@link CodecRegistry} configured by this method is effectively treated by the driver as an instance of
     * {@link org.bson.codecs.configuration.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 org.bson.codecs.configuration.CodecRegistries}.
     *
     * @param codecRegistry the new {@link CodecRegistry} for the database
     * @return a new MongoCluster instance with the different codec registry
     * @see org.bson.codecs.configuration.CodecRegistries
     * @since 5.2
     */
    MongoCluster withCodecRegistry(CodecRegistry codecRegistry);

    /**
     * Create a new MongoCluster instance with a different read preference.
     *
     * @param readPreference the new {@link ReadPreference} for the database
     * @return a new MongoCluster instance with the different readPreference
     * @since 5.2
     */
    MongoCluster withReadPreference(ReadPreference readPreference);

    /**
     * Create a new MongoCluster instance with a different write concern.
     *
     * @param writeConcern the new {@link WriteConcern} for the database
     * @return a new MongoCluster instance with the different writeConcern
     * @since 5.2
     */
    MongoCluster withWriteConcern(WriteConcern writeConcern);

    /**
     * Create a new MongoCluster instance with a different read concern.
     *
     * @param readConcern the new {@link ReadConcern} for the database
     * @return a new MongoCluster instance with the different ReadConcern
     * @since 5.2
     * @mongodb.driver.manual reference/readConcern/ Read Concern
     */
    MongoCluster withReadConcern(ReadConcern readConcern);

    /**
     * Create a new MongoCluster instance with the set time limit for the full execution of an operation.
     *
     * 
     *   {@code 0} means infinite timeout.
     *    {@code > 0} The time limit to use for the full execution of an operation.
     * 
     *
     * @param timeout the timeout, which must be greater than or equal to 0
     * @param timeUnit the time unit
     * @return a new MongoCluster instance with the set time limit for the full execution of an operation.
     * @since 5.2
     * @see #getTimeout
     */
    @Alpha(Reason.CLIENT)
    MongoCluster withTimeout(long timeout, TimeUnit timeUnit);

    /**
     * Gets a {@link MongoDatabase} instance for the given database name.
     *
     * @param databaseName the name of the database to retrieve
     * @return a {@code MongoDatabase} representing the specified database
     * @throws IllegalArgumentException if databaseName is invalid
     * @see MongoNamespace#checkDatabaseNameValidity(String)
     */
    MongoDatabase getDatabase(String databaseName);

    /**
     * Creates a client session with default options.
     *
     * Note: A ClientSession instance can not be used concurrently in multiple operations.
     *
     * @return the client session
     * @mongodb.server.release 3.6
     */
    Publisher startSession();

    /**
     * Creates a client session.
     *
     * Note: A ClientSession instance can not be used concurrently in multiple operations.
     *
     * @param options  the options for the client session
     * @return the client session
     * @mongodb.server.release 3.6
     */
    Publisher startSession(ClientSessionOptions options);

    /**
     * Get a list of the database names
     *
     * @return an iterable containing all the names of all the databases
     * @mongodb.driver.manual reference/command/listDatabases List Databases
     */
    Publisher listDatabaseNames();

    /**
     * Get a list of the database names
     *
     * @param clientSession the client session with which to associate this operation
     * @return an iterable containing all the names of all the databases
     * @mongodb.driver.manual reference/command/listDatabases List Databases
     * @mongodb.server.release 3.6
     */
    Publisher listDatabaseNames(ClientSession clientSession);

    /**
     * Gets the list of databases
     *
     * @return the list databases iterable interface
     */
    ListDatabasesPublisher listDatabases();

    /**
     * Gets the list of databases
     *
     * @param clientSession the client session with which to associate this operation
     * @return the list databases iterable interface
     * @mongodb.driver.manual reference/command/listDatabases List Databases
     * @mongodb.server.release 3.6
     */
    ListDatabasesPublisher listDatabases(ClientSession clientSession);

    /**
     * Gets the list of databases
     *
     * @param resultClass the class to cast the database documents to
     * @param    the type of the class to use instead of {@code Document}.
     * @return the list databases iterable interface
     */
     ListDatabasesPublisher listDatabases(Class resultClass);

    /**
     * Gets the list of databases
     *
     * @param clientSession the client session with which to associate this operation
     * @param resultClass the class to cast the database documents to
     * @param    the type of the class to use instead of {@code Document}.
     * @return the list databases iterable interface
     * @mongodb.driver.manual reference/command/listDatabases List Databases
     * @mongodb.server.release 3.6
     */
     ListDatabasesPublisher listDatabases(ClientSession clientSession, Class resultClass);

    /**
     * Creates a change stream for this client.
     *
     * @return the change stream iterable
     * @mongodb.driver.dochub core/changestreams Change Streams
     * @since 3.8
     * @mongodb.server.release 4.0
     */
    ChangeStreamPublisher watch();

    /**
     * Creates a change stream for this client.
     *
     * @param resultClass the class to decode each document into
     * @param    the target document type of the iterable.
     * @return the change stream iterable
     * @mongodb.driver.dochub core/changestreams Change Streams
     * @since 3.8
     * @mongodb.server.release 4.0
     */
     ChangeStreamPublisher watch(Class resultClass);

    /**
     * Creates a change stream for this client.
     *
     * @param pipeline the aggregation pipeline to apply to the change stream.
     * @return the change stream iterable
     * @mongodb.driver.dochub core/changestreams Change Streams
     * @since 3.8
     * @mongodb.server.release 4.0
     */
    ChangeStreamPublisher watch(List pipeline);

    /**
     * Creates a change stream for this client.
     *
     * @param pipeline    the aggregation pipeline to apply to the change stream
     * @param resultClass the class to decode each document into
     * @param    the target document type of the iterable.
     * @return the change stream iterable
     * @mongodb.driver.dochub core/changestreams Change Streams
     * @since 3.8
     * @mongodb.server.release 4.0
     */
     ChangeStreamPublisher watch(List pipeline, Class resultClass);

    /**
     * Creates a change stream for this client.
     *
     * @param clientSession the client session with which to associate this operation
     * @return the change stream iterable
     * @since 3.8
     * @mongodb.server.release 4.0
     * @mongodb.driver.dochub core/changestreams Change Streams
     */
    ChangeStreamPublisher watch(ClientSession clientSession);

    /**
     * Creates a change stream for this client.
     *
     * @param clientSession the client session with which to associate this operation
     * @param resultClass the class to decode each document into
     * @param    the target document type of the iterable.
     * @return the change stream iterable
     * @since 3.8
     * @mongodb.server.release 4.0
     * @mongodb.driver.dochub core/changestreams Change Streams
     */
     ChangeStreamPublisher watch(ClientSession clientSession, Class resultClass);

    /**
     * Creates a change stream for this client.
     *
     * @param clientSession the client session with which to associate this operation
     * @param pipeline the aggregation pipeline to apply to the change stream.
     * @return the change stream iterable
     * @since 3.8
     * @mongodb.server.release 4.0
     * @mongodb.driver.dochub core/changestreams Change Streams
     */
    ChangeStreamPublisher watch(ClientSession clientSession, List pipeline);

    /**
     * Creates a change stream for this client.
     *
     * @param clientSession the client session with which to associate this operation
     * @param pipeline    the aggregation pipeline to apply to the change stream
     * @param resultClass the class to decode each document into
     * @param    the target document type of the iterable.
     * @return the change stream iterable
     * @since 3.8
     * @mongodb.server.release 4.0
     * @mongodb.driver.dochub core/changestreams Change Streams
     */
     ChangeStreamPublisher watch(ClientSession clientSession, List pipeline, Class resultClass);

    /**
     * Executes a client-level bulk write operation.
     * This method is functionally equivalent to {@link #bulkWrite(List, ClientBulkWriteOptions)}
     * with the {@linkplain ClientBulkWriteOptions#clientBulkWriteOptions() default options}.
     * 
     * This operation supports {@linkplain MongoClientSettings#getRetryWrites() retryable writes}.
     * Depending on the number of {@code models}, encoded size of {@code models}, and the size limits in effect,
     * executing this operation may require multiple {@code bulkWrite} commands.
     * The eligibility for retries is determined per each {@code bulkWrite} command:
     * {@link ClientNamespacedUpdateManyModel}, {@link ClientNamespacedDeleteManyModel} in a command render it non-retryable.
     * 
     * This operation is not supported by MongoDB Atlas Serverless instances.
     *
     * @param models The {@linkplain ClientNamespacedWriteModel individual write operations}.
     * @return The {@link Publisher} signalling at most one element {@link ClientBulkWriteResult} if the operation is successful,
     * or the following errors:
     * 
     *     
     *     {@link ClientBulkWriteException} - If and only if the operation is unsuccessful or partially unsuccessful,
     *     and there is at least one of the following pieces of information to report:
     *     {@link ClientBulkWriteException#getWriteConcernErrors()}, {@link ClientBulkWriteException#getWriteErrors()},
     *     {@link ClientBulkWriteException#getPartialResult()}.
     *     
     *     {@link MongoException} - Only if the operation is unsuccessful.
     * 
     * @since 5.3
     * @mongodb.server.release 8.0
     * @mongodb.driver.manual reference/command/bulkWrite/ bulkWrite
     */
    Publisher bulkWrite(List models);

    /**
     * Executes a client-level bulk write operation.
     * 
     * This operation supports {@linkplain MongoClientSettings#getRetryWrites() retryable writes}.
     * Depending on the number of {@code models}, encoded size of {@code models}, and the size limits in effect,
     * executing this operation may require multiple {@code bulkWrite} commands.
     * The eligibility for retries is determined per each {@code bulkWrite} command:
     * {@link ClientNamespacedUpdateManyModel}, {@link ClientNamespacedDeleteManyModel} in a command render it non-retryable.
     * 
     * This operation is not supported by MongoDB Atlas Serverless instances.
     *
     * @param models The {@linkplain ClientNamespacedWriteModel individual write operations}.
     * @param options The options.
     * @return The {@link Publisher} signalling at most one element {@link ClientBulkWriteResult} if the operation is successful,
     * or the following errors:
     * 
     *     
     *     {@link ClientBulkWriteException} - If and only if the operation is unsuccessful or partially unsuccessful,
     *     and there is at least one of the following pieces of information to report:
     *     {@link ClientBulkWriteException#getWriteConcernErrors()}, {@link ClientBulkWriteException#getWriteErrors()},
     *     {@link ClientBulkWriteException#getPartialResult()}.
     *     
     *     {@link MongoException} - Only if the operation is unsuccessful.
     * 
     * @since 5.3
     * @mongodb.server.release 8.0
     * @mongodb.driver.manual reference/command/bulkWrite/ bulkWrite
     */
    Publisher bulkWrite(
            List models,
            ClientBulkWriteOptions options);

    /**
     * Executes a client-level bulk write operation.
     * This method is functionally equivalent to {@link #bulkWrite(ClientSession, List, ClientBulkWriteOptions)}
     * with the {@linkplain ClientBulkWriteOptions#clientBulkWriteOptions() default options}.
     * 
     * This operation supports {@linkplain MongoClientSettings#getRetryWrites() retryable writes}.
     * Depending on the number of {@code models}, encoded size of {@code models}, and the size limits in effect,
     * executing this operation may require multiple {@code bulkWrite} commands.
     * The eligibility for retries is determined per each {@code bulkWrite} command:
     * {@link ClientNamespacedUpdateManyModel}, {@link ClientNamespacedDeleteManyModel} in a command render it non-retryable.
     * 
     * This operation is not supported by MongoDB Atlas Serverless instances.
     *
     * @param clientSession The {@linkplain ClientSession client session} with which to associate this operation.
     * @param models The {@linkplain ClientNamespacedWriteModel individual write operations}.
     * @return The {@link Publisher} signalling at most one element {@link ClientBulkWriteResult} if the operation is successful,
     * or the following errors:
     * 
     *     
     *     {@link ClientBulkWriteException} - If and only if the operation is unsuccessful or partially unsuccessful,
     *     and there is at least one of the following pieces of information to report:
     *     {@link ClientBulkWriteException#getWriteConcernErrors()}, {@link ClientBulkWriteException#getWriteErrors()},
     *     {@link ClientBulkWriteException#getPartialResult()}.
     *     
     *     {@link MongoException} - Only if the operation is unsuccessful.
     * 
     * @since 5.3
     * @mongodb.server.release 8.0
     * @mongodb.driver.manual reference/command/bulkWrite/ bulkWrite
     */
    Publisher bulkWrite(
            ClientSession clientSession,
            List models);

    /**
     * Executes a client-level bulk write operation.
     * 
     * This operation supports {@linkplain MongoClientSettings#getRetryWrites() retryable writes}.
     * Depending on the number of {@code models}, encoded size of {@code models}, and the size limits in effect,
     * executing this operation may require multiple {@code bulkWrite} commands.
     * The eligibility for retries is determined per each {@code bulkWrite} command:
     * {@link ClientNamespacedUpdateManyModel}, {@link ClientNamespacedDeleteManyModel} in a command render it non-retryable.
     * 
     * This operation is not supported by MongoDB Atlas Serverless instances.
     *
     * @param clientSession The {@linkplain ClientSession client session} with which to associate this operation.
     * @param models The {@linkplain ClientNamespacedWriteModel individual write operations}.
     * @param options The options.
     * @return The {@link Publisher} signalling at most one element {@link ClientBulkWriteResult} if the operation is successful,
     * or the following errors:
     * 
     *     
     *     {@link ClientBulkWriteException} - If and only if the operation is unsuccessful or partially unsuccessful,
     *     and there is at least one of the following pieces of information to report:
     *     {@link ClientBulkWriteException#getWriteConcernErrors()}, {@link ClientBulkWriteException#getWriteErrors()},
     *     {@link ClientBulkWriteException#getPartialResult()}.
     *     
     *     {@link MongoException} - Only if the operation is unsuccessful.
     * 
     * @since 5.3
     * @mongodb.server.release 8.0
     * @mongodb.driver.manual reference/command/bulkWrite/ bulkWrite
     */
    Publisher bulkWrite(
            ClientSession clientSession,
            List models,
            ClientBulkWriteOptions options);
}