com.mongodb.connection

Interface Connection

All Superinterfaces:

ReferenceCounted

@ThreadSafe
public interface Connection
extends ReferenceCounted

A synchronous connection to a MongoDB server with blocking operations.

Implementations of this class are thread safe.

This interface is not stable. While methods will not be removed, new ones may be added.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
<T> T	command(String database, BsonDocument command, boolean slaveOk, FieldNameValidator fieldNameValidator, Decoder<T> commandResultDecoder) Deprecated. Prefer command(String, BsonDocument, ReadPreference, FieldNameValidator, Decoder, SessionContext)
<T> T	command(String database, BsonDocument command, ReadPreference readPreference, FieldNameValidator fieldNameValidator, Decoder<T> commandResultDecoder, SessionContext sessionContext) Execute the command.
WriteConcernResult	delete(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<DeleteRequest> deletes) Delete the documents using the delete wire protocol and apply the write concern.
BulkWriteResult	deleteCommand(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<DeleteRequest> deletes) Deprecated. Prefer deleteCommand(MongoNamespace, boolean, WriteConcern, List, SessionContext)
BulkWriteResult	deleteCommand(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<DeleteRequest> deletes, SessionContext sessionContext) Delete the documents using the delete command.
ConnectionDescription	getDescription() Gets the description of the connection.
<T> QueryResult<T>	getMore(MongoNamespace namespace, long cursorId, int numberToReturn, Decoder<T> resultDecoder) Get more result documents from a cursor.
WriteConcernResult	insert(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<InsertRequest> inserts) Insert the documents using the insert wire protocol and apply the write concern.
BulkWriteResult	insertCommand(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, Boolean bypassDocumentValidation, List<InsertRequest> inserts) Deprecated. Prefer insertCommand(MongoNamespace, boolean, WriteConcern, Boolean, List, SessionContext)
BulkWriteResult	insertCommand(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, Boolean bypassDocumentValidation, List<InsertRequest> inserts, SessionContext sessionContext) Insert the documents using the insert command.
BulkWriteResult	insertCommand(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<InsertRequest> inserts) Deprecated. Replaced by insertCommand(MongoNamespace, boolean, WriteConcern, Boolean, List)
void	killCursor(List<Long> cursors) Deprecated. Replaced by killCursor(MongoNamespace, List)
void	killCursor(MongoNamespace namespace, List<Long> cursors) Kills the given list of cursors.
<T> QueryResult<T>	query(MongoNamespace namespace, BsonDocument queryDocument, BsonDocument fields, int numberToReturn, int skip, boolean slaveOk, boolean tailableCursor, boolean awaitData, boolean noCursorTimeout, boolean partial, boolean oplogReplay, Decoder<T> resultDecoder) Deprecated. Replaced by query(MongoNamespace, BsonDocument, BsonDocument, int, int, int, boolean, boolean, boolean, boolean, boolean, boolean, Decoder)
<T> QueryResult<T>	query(MongoNamespace namespace, BsonDocument queryDocument, BsonDocument fields, int skip, int limit, int batchSize, boolean slaveOk, boolean tailableCursor, boolean awaitData, boolean noCursorTimeout, boolean partial, boolean oplogReplay, Decoder<T> resultDecoder) Execute the query.
Connection	retain() Retain an additional reference to this object.
WriteConcernResult	update(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<UpdateRequest> updates) Update the documents using the update wire protocol and apply the write concern.
BulkWriteResult	updateCommand(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, Boolean bypassDocumentValidation, List<UpdateRequest> updates) Deprecated. Prefer updateCommand(MongoNamespace, boolean, WriteConcern, Boolean, List, SessionContext)
BulkWriteResult	updateCommand(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, Boolean bypassDocumentValidation, List<UpdateRequest> updates, SessionContext sessionContext) Update the documents using the update command.
BulkWriteResult	updateCommand(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<UpdateRequest> updates) Deprecated. Replaced by updateCommand(MongoNamespace, boolean, WriteConcern, Boolean, List, SessionContext)}

Methods inherited from interface com.mongodb.binding.ReferenceCounted

getCount, release

Method Detail

retain

Connection retain()

Description copied from interface: ReferenceCounted

Retain an additional reference to this object. All retained references must be released, or there will be a leak.

Specified by:

retain in interface ReferenceCounted

Returns:

this

getDescription

ConnectionDescription getDescription()

Gets the description of the connection.

Returns:

the connection description

insert

WriteConcernResult insert(MongoNamespace namespace,
                          boolean ordered,
                          WriteConcern writeConcern,
                          List<InsertRequest> inserts)

Insert the documents using the insert wire protocol and apply the write concern.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

inserts - the inserts

Returns:

the write concern result

update

WriteConcernResult update(MongoNamespace namespace,
                          boolean ordered,
                          WriteConcern writeConcern,
                          List<UpdateRequest> updates)

Update the documents using the update wire protocol and apply the write concern.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

updates - the updates

Returns:

the write concern result

delete

WriteConcernResult delete(MongoNamespace namespace,
                          boolean ordered,
                          WriteConcern writeConcern,
                          List<DeleteRequest> deletes)

Delete the documents using the delete wire protocol and apply the write concern.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

deletes - the deletes

Returns:

the write concern result

insertCommand

@Deprecated
BulkWriteResult insertCommand(MongoNamespace namespace,
                                          boolean ordered,
                                          WriteConcern writeConcern,
                                          List<InsertRequest> inserts)

Deprecated. Replaced by insertCommand(MongoNamespace, boolean, WriteConcern, Boolean, List)

Insert the documents using the insert command.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

inserts - the inserts

Returns:

the bulk write result

insertCommand

@Deprecated
BulkWriteResult insertCommand(MongoNamespace namespace,
                                          boolean ordered,
                                          WriteConcern writeConcern,
                                          Boolean bypassDocumentValidation,
                                          List<InsertRequest> inserts)

Deprecated. Prefer insertCommand(MongoNamespace, boolean, WriteConcern, Boolean, List, SessionContext)

Insert the documents using the insert command.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

bypassDocumentValidation - the bypassDocumentValidation flag

inserts - the inserts

Returns:

the bulk write result

Since:

3.2

MongoDB documentation

Insert

insertCommand

BulkWriteResult insertCommand(MongoNamespace namespace,
                              boolean ordered,
                              WriteConcern writeConcern,
                              Boolean bypassDocumentValidation,
                              List<InsertRequest> inserts,
                              SessionContext sessionContext)

Insert the documents using the insert command.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

bypassDocumentValidation - the bypassDocumentValidation flag

inserts - the inserts

sessionContext - the session context

Returns:

the bulk write result

Since:

3.6

MongoDB documentation

Insert

updateCommand

@Deprecated
BulkWriteResult updateCommand(MongoNamespace namespace,
                                          boolean ordered,
                                          WriteConcern writeConcern,
                                          List<UpdateRequest> updates)

Deprecated. Replaced by updateCommand(MongoNamespace, boolean, WriteConcern, Boolean, List, SessionContext)}

Update the documents using the update command.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

updates - the updates

Returns:

the bulk write result

updateCommand

@Deprecated
BulkWriteResult updateCommand(MongoNamespace namespace,
                                          boolean ordered,
                                          WriteConcern writeConcern,
                                          Boolean bypassDocumentValidation,
                                          List<UpdateRequest> updates)

Deprecated. Prefer updateCommand(MongoNamespace, boolean, WriteConcern, Boolean, List, SessionContext)

Update the documents using the update command.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

bypassDocumentValidation - the bypassDocumentValidation flag

updates - the updates

Returns:

the bulk write result

Since:

3.2

MongoDB documentation

Update

updateCommand

BulkWriteResult updateCommand(MongoNamespace namespace,
                              boolean ordered,
                              WriteConcern writeConcern,
                              Boolean bypassDocumentValidation,
                              List<UpdateRequest> updates,
                              SessionContext sessionContext)

Update the documents using the update command.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

bypassDocumentValidation - the bypassDocumentValidation flag

updates - the updates

sessionContext - the session context

Returns:

the bulk write result

Since:

3.6

MongoDB documentation

Update

deleteCommand

@Deprecated
BulkWriteResult deleteCommand(MongoNamespace namespace,
                                          boolean ordered,
                                          WriteConcern writeConcern,
                                          List<DeleteRequest> deletes)

Deprecated. Prefer deleteCommand(MongoNamespace, boolean, WriteConcern, List, SessionContext)

Delete the documents using the delete command.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

deletes - the deletes

Returns:

the bulk write result

deleteCommand

BulkWriteResult deleteCommand(MongoNamespace namespace,
                              boolean ordered,
                              WriteConcern writeConcern,
                              List<DeleteRequest> deletes,
                              SessionContext sessionContext)

Delete the documents using the delete command.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

deletes - the deletes

sessionContext - the session context

Returns:

the bulk write result

Since:

3.6

command

@Deprecated
<T> T command(String database,
                          BsonDocument command,
                          boolean slaveOk,
                          FieldNameValidator fieldNameValidator,
                          Decoder<T> commandResultDecoder)

Deprecated. Prefer command(String, BsonDocument, ReadPreference, FieldNameValidator, Decoder, SessionContext)

Execute the command.

Type Parameters:

T - the type of the result

Parameters:

database - the database to execute the command in

command - the command document

slaveOk - whether the command can run on a secondary

fieldNameValidator - the field name validator for the command document

commandResultDecoder - the decoder for the result

Returns:

the command result

command

<T> T command(String database,
              BsonDocument command,
              ReadPreference readPreference,
              FieldNameValidator fieldNameValidator,
              Decoder<T> commandResultDecoder,
              SessionContext sessionContext)

Execute the command.

Type Parameters:

T - the type of the result

Parameters:

database - the database to execute the command in

command - the command document

readPreference - the read preference that was applied to get this connection

fieldNameValidator - the field name validator for the command document

commandResultDecoder - the decoder for the result

sessionContext - the session context

Returns:

the command result

Since:

3.6

query

@Deprecated
<T> QueryResult<T> query(MongoNamespace namespace,
                                     BsonDocument queryDocument,
                                     BsonDocument fields,
                                     int numberToReturn,
                                     int skip,
                                     boolean slaveOk,
                                     boolean tailableCursor,
                                     boolean awaitData,
                                     boolean noCursorTimeout,
                                     boolean partial,
                                     boolean oplogReplay,
                                     Decoder<T> resultDecoder)

Deprecated. Replaced by query(MongoNamespace, BsonDocument, BsonDocument, int, int, int, boolean, boolean, boolean, boolean, boolean, boolean, Decoder)

Execute the query.

Type Parameters:

T - the query result document type

Parameters:

namespace - the namespace to query

queryDocument - the query document

fields - the field to include or exclude

numberToReturn - the number of documents to return

skip - the number of documents to skip

slaveOk - whether the query can run on a secondary

tailableCursor - whether to return a tailable cursor

awaitData - whether a tailable cursor should wait before returning if no documents are available

noCursorTimeout - whether the cursor should not timeout

partial - whether partial results from sharded clusters are acceptable

oplogReplay - whether to replay the oplog

resultDecoder - the decoder for the query result documents

Returns:

the query results

query

<T> QueryResult<T> query(MongoNamespace namespace,
                         BsonDocument queryDocument,
                         BsonDocument fields,
                         int skip,
                         int limit,
                         int batchSize,
                         boolean slaveOk,
                         boolean tailableCursor,
                         boolean awaitData,
                         boolean noCursorTimeout,
                         boolean partial,
                         boolean oplogReplay,
                         Decoder<T> resultDecoder)

Execute the query.

Type Parameters:

T - the query result document type

Parameters:

namespace - the namespace to query

queryDocument - the query document

fields - the field to include or exclude

skip - the number of documents to skip

limit - the maximum number of documents to return in all batches

batchSize - the maximum number of documents to return in this batch

slaveOk - whether the query can run on a secondary

tailableCursor - whether to return a tailable cursor

awaitData - whether a tailable cursor should wait before returning if no documents are available

noCursorTimeout - whether the cursor should not timeout

partial - whether partial results from sharded clusters are acceptable

oplogReplay - whether to replay the oplog

resultDecoder - the decoder for the query result documents

Returns:

the query results

Since:

3.1

getMore

<T> QueryResult<T> getMore(MongoNamespace namespace,
                           long cursorId,
                           int numberToReturn,
                           Decoder<T> resultDecoder)

Get more result documents from a cursor.

Type Parameters:

T - the type of the query result documents

Parameters:

namespace - the namespace to get more documents from

cursorId - the cursor id

numberToReturn - the number of documents to return

resultDecoder - the decoder for the query results

Returns:

the query results

killCursor

@Deprecated
void killCursor(List<Long> cursors)

Deprecated. Replaced by killCursor(MongoNamespace, List)

Kills the given list of cursors.

Parameters:

cursors - the cursors

killCursor

void killCursor(MongoNamespace namespace,
                List<Long> cursors)

Kills the given list of cursors.

Parameters:

namespace - the namespace to in which the cursors live

cursors - the cursors