com.mongodb.reactivestreams.client.MongoDatabase 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
Show all versions of mongodb-driver-reactivestreams Show documentation
A Reactive Streams implementation of the MongoDB Java driver
/*
* 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.ReadConcern;
import com.mongodb.ReadPreference;
import com.mongodb.WriteConcern;
import com.mongodb.annotations.Alpha;
import com.mongodb.annotations.Reason;
import com.mongodb.annotations.ThreadSafe;
import com.mongodb.client.model.CreateCollectionOptions;
import com.mongodb.client.model.CreateViewOptions;
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 MongoDatabase interface.
*
* Note: Additions to this interface will not be considered to break binary compatibility.
* @since 1.0
*/
@ThreadSafe
public interface MongoDatabase {
/**
* Gets the name of the database.
*
* @return the database name
*/
String getName();
/**
* Get the codec registry for the MongoDatabase.
*
* @return the {@link org.bson.codecs.configuration.CodecRegistry}
*/
CodecRegistry getCodecRegistry();
/**
* Get the read preference for the MongoDatabase.
*
* @return the {@link com.mongodb.ReadPreference}
*/
ReadPreference getReadPreference();
/**
* Get the write concern for the MongoDatabase.
*
* @return the {@link com.mongodb.WriteConcern}
*/
WriteConcern getWriteConcern();
/**
* Get the read concern for the MongoCollection.
*
* @return the {@link com.mongodb.ReadConcern}
* @since 1.2
* @mongodb.server.release 3.2
*/
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 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 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 org.bson.codecs.configuration.CodecRegistry} for the collection
* @return a new MongoDatabase instance with the different codec registry
* @see org.bson.codecs.configuration.CodecRegistries
*/
MongoDatabase withCodecRegistry(CodecRegistry codecRegistry);
/**
* Create a new MongoDatabase instance with a different read preference.
*
* @param readPreference the new {@link com.mongodb.ReadPreference} for the collection
* @return a new MongoDatabase instance with the different readPreference
*/
MongoDatabase withReadPreference(ReadPreference readPreference);
/**
* Create a new MongoDatabase instance with a different write concern.
*
* @param writeConcern the new {@link com.mongodb.WriteConcern} for the collection
* @return a new MongoDatabase instance with the different writeConcern
*/
MongoDatabase withWriteConcern(WriteConcern writeConcern);
/**
* Create a new MongoDatabase instance with a different read concern.
*
* @param readConcern the new {@link ReadConcern} for the collection
* @return a new MongoDatabase instance with the different ReadConcern
* @since 1.2
* @mongodb.server.release 3.2
*/
MongoDatabase withReadConcern(ReadConcern readConcern);
/**
* Create a new MongoDatabase 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 MongoDatabase instance with the set time limit for the full execution of an operation.
* @since 5.2
* @see #getTimeout
*/
@Alpha(Reason.CLIENT)
MongoDatabase withTimeout(long timeout, TimeUnit timeUnit);
/**
* Gets a collection.
*
* @param collectionName the name of the collection to return
* @return the collection
*/
MongoCollection getCollection(String collectionName);
/**
* Gets a collection, with a specific default document class.
*
* @param collectionName the name of the collection to return
* @param clazz the default class to cast any documents returned from the database into.
* @param the type of the class to use instead of {@code Document}.
* @return the collection
*/
MongoCollection getCollection(String collectionName, Class clazz);
/**
* Executes command in the context of the current database.
*
* Note: The behavior of {@code runCommand} is undefined if the provided command document includes a {@code maxTimeMS} field and the
* {@code timeoutMS} setting has been set.
*
* @param command the command to be run
* @return a publisher containing the command result
*/
Publisher runCommand(Bson command);
/**
* Executes command in the context of the current database.
*
* Note: The behavior of {@code runCommand} is undefined if the provided command document includes a {@code maxTimeMS} field and the
* {@code timeoutMS} setting has been set.
*
* @param command the command to be run
* @param readPreference the {@link com.mongodb.ReadPreference} to be used when executing the command
* @return a publisher containing the command result
*/
Publisher runCommand(Bson command, ReadPreference readPreference);
/**
* Executes command in the context of the current database.
*
* Note: The behavior of {@code runCommand} is undefined if the provided command document includes a {@code maxTimeMS} field and the
* {@code timeoutMS} setting has been set.
*
* @param command the command to be run
* @param clazz the default class to cast any documents returned from the database into.
* @param the type of the class to use instead of {@code Document}.
* @return a publisher containing the command result
*/
Publisher runCommand(Bson command, Class clazz);
/**
* Executes command in the context of the current database.
*
* Note: The behavior of {@code runCommand} is undefined if the provided command document includes a {@code maxTimeMS} field and the
* {@code timeoutMS} setting has been set.
*
* @param command the command to be run
* @param readPreference the {@link com.mongodb.ReadPreference} to be used when executing the command
* @param clazz the default class to cast any documents returned from the database into.
* @param the type of the class to use instead of {@code Document}.
* @return a publisher containing the command result
*/
Publisher runCommand(Bson command, ReadPreference readPreference, Class clazz);
/**
* Executes command in the context of the current database.
*
* Note: The behavior of {@code runCommand} is undefined if the provided command document includes a {@code maxTimeMS} field and the
* {@code timeoutMS} setting has been set.
*
* @param clientSession the client session with which to associate this operation
* @param command the command to be run
* @return a publisher containing the command result
* @mongodb.server.release 3.6
* @since 1.7
*/
Publisher runCommand(ClientSession clientSession, Bson command);
/**
* Executes command in the context of the current database.
*
* Note: The behavior of {@code runCommand} is undefined if the provided command document includes a {@code maxTimeMS} field and the
* {@code timeoutMS} setting has been set.
*
* @param clientSession the client session with which to associate this operation
* @param command the command to be run
* @param readPreference the {@link com.mongodb.ReadPreference} to be used when executing the command
* @return a publisher containing the command result
* @mongodb.server.release 3.6
* @since 1.7
*/
Publisher runCommand(ClientSession clientSession, Bson command, ReadPreference readPreference);
/**
* Executes command in the context of the current database.
*
* Note: The behavior of {@code runCommand} is undefined if the provided command document includes a {@code maxTimeMS} field and the
* {@code timeoutMS} setting has been set.
*
* @param clientSession the client session with which to associate this operation
* @param command the command to be run
* @param clazz the default class to cast any documents returned from the database into.
* @param the type of the class to use instead of {@code Document}.
* @return a publisher containing the command result
* @mongodb.server.release 3.6
* @since 1.7
*/
Publisher runCommand(ClientSession clientSession, Bson command, Class clazz);
/**
* Executes command in the context of the current database.
*
* Note: The behavior of {@code runCommand} is undefined if the provided command document includes a {@code maxTimeMS} field and the
* {@code timeoutMS} setting has been set.
*
* @param clientSession the client session with which to associate this operation
* @param command the command to be run
* @param readPreference the {@link com.mongodb.ReadPreference} to be used when executing the command
* @param clazz the default class to cast any documents returned from the database into.
* @param the type of the class to use instead of {@code Document}.
* @return a publisher containing the command result
* @mongodb.server.release 3.6
* @since 1.7
*/
Publisher runCommand(ClientSession clientSession, Bson command, ReadPreference readPreference, Class clazz);
/**
* Drops this database.
*
* @return a publisher identifying when the database has been dropped
* @mongodb.driver.manual reference/commands/dropDatabase/#dbcmd.dropDatabase Drop database
*/
Publisher drop();
/**
* Drops this database.
*
* @param clientSession the client session with which to associate this operation
* @return a publisher identifying when the database has been dropped
* @mongodb.driver.manual reference/commands/dropDatabase/#dbcmd.dropDatabase Drop database
* @mongodb.server.release 3.6
* @since 1.7
*/
Publisher drop(ClientSession clientSession);
/**
* Gets the names of all the collections in this database.
*
* @return a publisher with all the names of all the collections in this database
* @mongodb.driver.manual reference/command/listCollections listCollections
*/
ListCollectionNamesPublisher listCollectionNames();
/**
* Gets the names of all the collections in this database.
*
* @param clientSession the client session with which to associate this operation
* @return a publisher with all the names of all the collections in this database
* @mongodb.driver.manual reference/command/listCollections listCollections
* @mongodb.server.release 3.6
* @since 1.7
*/
ListCollectionNamesPublisher listCollectionNames(ClientSession clientSession);
/**
* Finds all the collections in this database.
*
* @return the fluent list collections interface
* @mongodb.driver.manual reference/command/listCollections listCollections
*/
ListCollectionsPublisher listCollections();
/**
* Finds all the collections in this database.
*
* @param clazz the class to decode each document into
* @param the target document type of the iterable.
* @return the fluent list collections interface
* @mongodb.driver.manual reference/command/listCollections listCollections
*/
ListCollectionsPublisher listCollections(Class clazz);
/**
* Finds all the collections in this database.
*
* @param clientSession the client session with which to associate this operation
* @return the fluent list collections interface
* @mongodb.driver.manual reference/command/listCollections listCollections
* @mongodb.server.release 3.6
* @since 1.7
*/
ListCollectionsPublisher listCollections(ClientSession clientSession);
/**
* Finds all the collections in this database.
*
* @param clientSession the client session with which to associate this operation
* @param clazz the class to decode each document into
* @param the target document type of the iterable.
* @return the fluent list collections interface
* @mongodb.driver.manual reference/command/listCollections listCollections
* @mongodb.server.release 3.6
* @since 1.7
*/
ListCollectionsPublisher listCollections(ClientSession clientSession, Class clazz);
/**
* Create a new collection with the given name.
*
* @param collectionName the name for the new collection to create
* @return a publisher identifying when the collection has been created
* @mongodb.driver.manual reference/commands/create Create Command
*/
Publisher createCollection(String collectionName);
/**
* Create a new collection with the selected options
*
* @param collectionName the name for the new collection to create
* @param options various options for creating the collection
* @return a publisher identifying when the collection has been created
* @mongodb.driver.manual reference/commands/create Create Command
*/
Publisher createCollection(String collectionName, CreateCollectionOptions options);
/**
* Create a new collection with the given name.
*
* @param clientSession the client session with which to associate this operation
* @param collectionName the name for the new collection to create
* @return a publisher identifying when the collection has been created
* @mongodb.driver.manual reference/commands/create Create Command
* @mongodb.server.release 3.6
* @since 1.7
*/
Publisher createCollection(ClientSession clientSession, String collectionName);
/**
* Create a new collection with the selected options
*
* @param clientSession the client session with which to associate this operation
* @param collectionName the name for the new collection to create
* @param options various options for creating the collection
* @return a publisher identifying when the collection has been created
* @mongodb.driver.manual reference/commands/create Create Command
* @mongodb.server.release 3.6
* @since 1.7
*/
Publisher createCollection(ClientSession clientSession, String collectionName, CreateCollectionOptions options);
/**
* Creates a view with the given name, backing collection/view name, and aggregation pipeline that defines the view.
*
* @param viewName the name of the view to create
* @param viewOn the backing collection/view for the view
* @param pipeline the pipeline that defines the view
* @return an observable identifying when the collection view has been created
* @since 1.3
* @mongodb.server.release 3.4
* @mongodb.driver.manual reference/command/create Create Command
*/
Publisher createView(String viewName, String viewOn, List pipeline);
/**
* Creates a view with the given name, backing collection/view name, aggregation pipeline, and options that defines the view.
*
* @param viewName the name of the view to create
* @param viewOn the backing collection/view for the view
* @param pipeline the pipeline that defines the view
* @param createViewOptions various options for creating the view
* @return an observable identifying when the collection view has been created
* @since 1.3
* @mongodb.server.release 3.4
* @mongodb.driver.manual reference/command/create Create Command
*/
Publisher createView(String viewName, String viewOn, List pipeline, CreateViewOptions createViewOptions);
/**
* Creates a view with the given name, backing collection/view name, and aggregation pipeline that defines the view.
*
* @param clientSession the client session with which to associate this operation
* @param viewName the name of the view to create
* @param viewOn the backing collection/view for the view
* @param pipeline the pipeline that defines the view
* @return an observable identifying when the collection view has been created
* @mongodb.driver.manual reference/command/create Create Command
* @mongodb.server.release 3.6
* @since 1.7
*/
Publisher createView(ClientSession clientSession, String viewName, String viewOn, List pipeline);
/**
* Creates a view with the given name, backing collection/view name, aggregation pipeline, and options that defines the view.
*
* @param clientSession the client session with which to associate this operation
* @param viewName the name of the view to create
* @param viewOn the backing collection/view for the view
* @param pipeline the pipeline that defines the view
* @param createViewOptions various options for creating the view
* @return an observable identifying when the collection view has been created
* @mongodb.driver.manual reference/command/create Create Command
* @mongodb.server.release 3.6
* @since 1.7
*/
Publisher createView(ClientSession clientSession, String viewName, String viewOn, List pipeline,
CreateViewOptions createViewOptions);
/**
* Creates a change stream for this database.
*
* @return the change stream iterable
* @mongodb.driver.dochub core/changestreams Change Streams
* @since 1.9
* @mongodb.server.release 4.0
*/
ChangeStreamPublisher watch();
/**
* Creates a change stream for this database.
*
* @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 1.9
* @mongodb.server.release 4.0
*/
ChangeStreamPublisher watch(Class resultClass);
/**
* Creates a change stream for this database.
*
* @param pipeline the aggregation pipeline to apply to the change stream.
* @return the change stream iterable
* @mongodb.driver.dochub core/changestreams Change Streams
* @since 1.9
* @mongodb.server.release 4.0
*/
ChangeStreamPublisher watch(List pipeline);
/**
* Creates a change stream for this database.
*
* @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 1.9
* @mongodb.server.release 4.0
*/
ChangeStreamPublisher watch(List pipeline, Class resultClass);
/**
* Creates a change stream for this database.
*
* @param clientSession the client session with which to associate this operation
* @return the change stream iterable
* @since 1.9
* @mongodb.server.release 4.0
* @mongodb.driver.dochub core/changestreams Change Streams
*/
ChangeStreamPublisher watch(ClientSession clientSession);
/**
* Creates a change stream for this database.
*
* @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 1.9
* @mongodb.server.release 4.0
* @mongodb.driver.dochub core/changestreams Change Streams
*/
ChangeStreamPublisher watch(ClientSession clientSession, Class resultClass);
/**
* Creates a change stream for this database.
*
* @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 1.9
* @mongodb.server.release 4.0
* @mongodb.driver.dochub core/changestreams Change Streams
*/
ChangeStreamPublisher watch(ClientSession clientSession, List pipeline);
/**
* Creates a change stream for this database.
*
* @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 1.9
* @mongodb.server.release 4.0
* @mongodb.driver.dochub core/changestreams Change Streams
*/
ChangeStreamPublisher watch(ClientSession clientSession, List pipeline, Class resultClass);
/**
* Runs an aggregation framework pipeline on the database for pipeline stages
* that do not require an underlying collection, such as {@code $currentOp} and {@code $listLocalSessions}.
*
* @param pipeline the aggregation pipeline
* @return an iterable containing the result of the aggregation operation
* @since 1.11
* @mongodb.driver.manual reference/command/aggregate/#dbcmd.aggregate Aggregate Command
* @mongodb.server.release 3.6
*/
AggregatePublisher aggregate(List pipeline);
/**
* Runs an aggregation framework pipeline on the database for pipeline stages
* that do not require an underlying collection, such as {@code $currentOp} and {@code $listLocalSessions}.
*
* @param pipeline the aggregation pipeline
* @param resultClass the class to decode each document into
* @param the target document type of the iterable.
* @return an iterable containing the result of the aggregation operation
* @since 1.11
* @mongodb.driver.manual reference/command/aggregate/#dbcmd.aggregate Aggregate Command
* @mongodb.server.release 3.6
*/
AggregatePublisher aggregate(List pipeline, Class resultClass);
/**
* Runs an aggregation framework pipeline on the database for pipeline stages
* that do not require an underlying collection, such as {@code $currentOp} and {@code $listLocalSessions}.
*
* @param clientSession the client session with which to associate this operation
* @param pipeline the aggregation pipeline
* @return an iterable containing the result of the aggregation operation
* @since 1.11
* @mongodb.driver.manual reference/command/aggregate/#dbcmd.aggregate Aggregate Command
* @mongodb.server.release 3.6
*/
AggregatePublisher aggregate(ClientSession clientSession, List pipeline);
/**
* Runs an aggregation framework pipeline on the database for pipeline stages
* that do not require an underlying collection, such as {@code $currentOp} and {@code $listLocalSessions}.
*
* @param clientSession the client session with which to associate this operation
* @param pipeline the aggregation pipeline
* @param resultClass the class to decode each document into
* @param the target document type of the iterable.
* @return an iterable containing the result of the aggregation operation
* @since 1.11
* @mongodb.driver.manual reference/command/aggregate/#dbcmd.aggregate Aggregate Command
* @mongodb.server.release 3.6
*/
AggregatePublisher aggregate(ClientSession clientSession, List pipeline, Class resultClass);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy