com.mongodb.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 Show documentation
Show all versions of mongodb-driver Show documentation
The MongoDB Driver uber-artifact that combines mongodb-driver-sync and the legacy 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.client;
import com.mongodb.ReadConcern;
import com.mongodb.ReadPreference;
import com.mongodb.WriteConcern;
import com.mongodb.annotations.ThreadSafe;
import com.mongodb.client.model.CreateCollectionOptions;
import com.mongodb.client.model.CreateViewOptions;
import org.bson.Document;
import org.bson.codecs.configuration.CodecRegistry;
import org.bson.conversions.Bson;
import java.util.List;
/**
* The MongoDatabase interface.
*
* Note: Additions to this interface will not be considered to break binary compatibility.
*
* @since 3.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 MongoDatabase.
*
* @return the {@link com.mongodb.ReadConcern}
* @since 3.2
* @mongodb.server.release 3.2
* @mongodb.driver.manual reference/readConcern/ Read Concern
*/
ReadConcern getReadConcern();
/**
* Create a new MongoDatabase instance with a different codec registry.
*
* @param codecRegistry the new {@link org.bson.codecs.configuration.CodecRegistry} for the database
* @return a new MongoDatabase instance with the different codec registry
*/
MongoDatabase withCodecRegistry(CodecRegistry codecRegistry);
/**
* Create a new MongoDatabase instance with a different read preference.
*
* @param readPreference the new {@link ReadPreference} for the database
* @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 WriteConcern} for the database
* @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 database
* @return a new MongoDatabase instance with the different ReadConcern
* @since 3.2
* @mongodb.server.release 3.2
* @mongodb.driver.manual reference/readConcern/ Read Concern
*/
MongoDatabase withReadConcern(ReadConcern readConcern);
/**
* Gets a collection.
*
* @param collectionName the name of the collection to return
* @return the collection
* @throws IllegalArgumentException if collectionName is invalid
* @see com.mongodb.MongoNamespace#checkCollectionNameValidity(String)
*/
MongoCollection getCollection(String collectionName);
/**
* Gets a collection, with a specific default document class.
*
* @param collectionName the name of the collection to return
* @param documentClass 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 documentClass);
/**
* Executes the given command in the context of the current database with a read preference of {@link ReadPreference#primary()}.
*
* @param command the command to be run
* @return the command result
*/
Document runCommand(Bson command);
/**
* Executes the given command in the context of the current database with the given read preference.
*
* @param command the command to be run
* @param readPreference the {@link ReadPreference} to be used when executing the command
* @return the command result
*/
Document runCommand(Bson command, ReadPreference readPreference);
/**
* Executes the given command in the context of the current database with a read preference of {@link ReadPreference#primary()}.
*
* @param command the command to be run
* @param resultClass the class to decode each document into
* @param the type of the class to use instead of {@code Document}.
* @return the command result
*/
TResult runCommand(Bson command, Class resultClass);
/**
* Executes the given command in the context of the current database with the given read preference.
*
* @param command the command to be run
* @param readPreference the {@link ReadPreference} to be used when executing the command
* @param resultClass the class to decode each document into
* @param the type of the class to use instead of {@code Document}.
* @return the command result
*/
TResult runCommand(Bson command, ReadPreference readPreference, Class resultClass);
/**
* Executes the given command in the context of the current database with a read preference of {@link ReadPreference#primary()}.
*
* @param clientSession the client session with which to associate this operation
* @param command the command to be run
* @return the command result
* @since 3.6
* @mongodb.server.release 3.6
*/
Document runCommand(ClientSession clientSession, Bson command);
/**
* Executes the given command in the context of the current database with the given read preference.
*
* @param clientSession the client session with which to associate this operation
* @param command the command to be run
* @param readPreference the {@link ReadPreference} to be used when executing the command
* @return the command result
* @since 3.6
* @mongodb.server.release 3.6
*/
Document runCommand(ClientSession clientSession, Bson command, ReadPreference readPreference);
/**
* Executes the given command in the context of the current database with a read preference of {@link ReadPreference#primary()}.
*
* @param clientSession the client session with which to associate this operation
* @param command the command to be run
* @param resultClass the class to decode each document into
* @param the type of the class to use instead of {@code Document}.
* @return the command result
* @since 3.6
* @mongodb.server.release 3.6
*/
TResult runCommand(ClientSession clientSession, Bson command, Class resultClass);
/**
* Executes the given command in the context of the current database with the given read preference.
*
* @param clientSession the client session with which to associate this operation
* @param command the command to be run
* @param readPreference the {@link ReadPreference} to be used when executing the command
* @param resultClass the class to decode each document into
* @param the type of the class to use instead of {@code Document}.
* @return the command result
* @since 3.6
* @mongodb.server.release 3.6
*/
TResult runCommand(ClientSession clientSession, Bson command, ReadPreference readPreference, Class resultClass);
/**
* Drops this database.
*
* @mongodb.driver.manual reference/command/dropDatabase/#dbcmd.dropDatabase Drop database
*/
void drop();
/**
* Drops this database.
*
* @param clientSession the client session with which to associate this operation
* @since 3.6
* @mongodb.server.release 3.6
* @mongodb.driver.manual reference/command/dropDatabase/#dbcmd.dropDatabase Drop database
*/
void drop(ClientSession clientSession);
/**
* Gets the names of all the collections in this database.
*
* @return an iterable containing all the names of all the collections in this database
*/
MongoIterable listCollectionNames();
/**
* Finds all the collections in this database.
*
* @return the list collections iterable interface
* @mongodb.driver.manual reference/command/listCollections listCollections
*/
ListCollectionsIterable listCollections();
/**
* Finds all the collections in this database.
*
* @param resultClass the class to decode each document into
* @param the target document type of the iterable.
* @return the list collections iterable interface
* @mongodb.driver.manual reference/command/listCollections listCollections
*/
ListCollectionsIterable listCollections(Class resultClass);
/**
* Gets the names of all the collections in this database.
*
* @param clientSession the client session with which to associate this operation
* @return an iterable containing all the names of all the collections in this database
* @since 3.6
* @mongodb.server.release 3.6
*/
MongoIterable listCollectionNames(ClientSession clientSession);
/**
* Finds all the collections in this database.
*
* @param clientSession the client session with which to associate this operation
* @return the list collections iterable interface
* @since 3.6
* @mongodb.server.release 3.6
* @mongodb.driver.manual reference/command/listCollections listCollections
*/
ListCollectionsIterable listCollections(ClientSession clientSession);
/**
* Finds all the collections in 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 list collections iterable interface
* @since 3.6
* @mongodb.server.release 3.6
* @mongodb.driver.manual reference/command/listCollections listCollections
*/
ListCollectionsIterable listCollections(ClientSession clientSession, Class resultClass);
/**
* Create a new collection with the given name.
*
* @param collectionName the name for the new collection to create
* @mongodb.driver.manual reference/command/create Create Command
*/
void createCollection(String collectionName);
/**
* Create a new collection with the selected options
*
* @param collectionName the name for the new collection to create
* @param createCollectionOptions various options for creating the collection
* @mongodb.driver.manual reference/command/create Create Command
*/
void createCollection(String collectionName, CreateCollectionOptions createCollectionOptions);
/**
* 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
* @since 3.6
* @mongodb.server.release 3.6
* @mongodb.driver.manual reference/command/create Create Command
*/
void 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 createCollectionOptions various options for creating the collection
* @since 3.6
* @mongodb.server.release 3.6
* @mongodb.driver.manual reference/command/create Create Command
*/
void createCollection(ClientSession clientSession, String collectionName, CreateCollectionOptions createCollectionOptions);
/**
* 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
* @since 3.4
* @mongodb.server.release 3.4
* @mongodb.driver.manual reference/command/create Create Command
*/
void 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
* @since 3.4
* @mongodb.server.release 3.4
* @mongodb.driver.manual reference/command/create Create Command
*/
void 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
* @since 3.6
* @mongodb.server.release 3.6
* @mongodb.driver.manual reference/command/create Create Command
*/
void 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
* @since 3.6
* @mongodb.server.release 3.6
* @mongodb.driver.manual reference/command/create Create Command
*/
void 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 3.8
* @mongodb.server.release 4.0
*/
ChangeStreamIterable 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 3.8
* @mongodb.server.release 4.0
*/
ChangeStreamIterable 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 3.8
* @mongodb.server.release 4.0
*/
ChangeStreamIterable 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 3.8
* @mongodb.server.release 4.0
*/
ChangeStreamIterable 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 3.8
* @mongodb.server.release 4.0
* @mongodb.driver.dochub core/changestreams Change Streams
*/
ChangeStreamIterable 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 3.8
* @mongodb.server.release 4.0
* @mongodb.driver.dochub core/changestreams Change Streams
*/
ChangeStreamIterable 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 3.8
* @mongodb.server.release 4.0
* @mongodb.driver.dochub core/changestreams Change Streams
*/
ChangeStreamIterable 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 3.8
* @mongodb.server.release 4.0
* @mongodb.driver.dochub core/changestreams Change Streams
*/
ChangeStreamIterable 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 3.10
* @mongodb.driver.manual reference/command/aggregate/#dbcmd.aggregate Aggregate Command
* @mongodb.server.release 3.6
*/
AggregateIterable 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 3.10
* @mongodb.driver.manual reference/command/aggregate/#dbcmd.aggregate Aggregate Command
* @mongodb.server.release 3.6
*/
AggregateIterable 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 3.10
* @mongodb.driver.manual reference/command/aggregate/#dbcmd.aggregate Aggregate Command
* @mongodb.server.release 3.6
*/
AggregateIterable 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 3.10
* @mongodb.driver.manual reference/command/aggregate/#dbcmd.aggregate Aggregate Command
* @mongodb.server.release 3.6
*/
AggregateIterable aggregate(ClientSession clientSession, List pipeline, Class resultClass);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy