com.mongodb.connection

Interface Connection

All Superinterfaces:

ReferenceCounted

@ThreadSafe
public interface Connection
extends ReferenceCounted

A connection to a MongoDB server with blocking and non-blocking operations.

Implementations of this class are thread safe.

Since:

3.0

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	command(String database, BsonDocument command, boolean slaveOk, FieldNameValidator fieldNameValidator, Decoder<T> commandResultDecoder) Execute the command.
<T> void	commandAsync(String database, BsonDocument command, boolean slaveOk, FieldNameValidator fieldNameValidator, Decoder<T> commandResultDecoder, SingleResultCallback<T> callback) Execute the command asynchronously.
WriteConcernResult	delete(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<DeleteRequest> deletes) Delete the documents using the delete wire protocol and apply the write concern.
void	deleteAsync(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<DeleteRequest> deletes, SingleResultCallback<WriteConcernResult> callback) Delete the documents using the delete wire protocol and apply the write concern asynchronously.
BulkWriteResult	deleteCommand(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<DeleteRequest> deletes) Delete the documents using the delete command.
void	deleteCommandAsync(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<DeleteRequest> deletes, SingleResultCallback<BulkWriteResult> callback) Delete the documents using the delete command asynchronously.
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.
<T> void	getMoreAsync(MongoNamespace namespace, long cursorId, int numberToReturn, Decoder<T> resultDecoder, SingleResultCallback<QueryResult<T>> callback) Get more result documents from a cursor asynchronously.
WriteConcernResult	insert(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<InsertRequest> inserts) Insert the documents using the insert wire protocol and apply the write concern.
void	insertAsync(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<InsertRequest> inserts, SingleResultCallback<WriteConcernResult> callback) Insert the documents using the insert wire protocol and apply the write concern asynchronously.
BulkWriteResult	insertCommand(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<InsertRequest> inserts) Insert the documents using the insert command.
void	insertCommandAsync(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<InsertRequest> inserts, SingleResultCallback<BulkWriteResult> callback) Insert the documents using the insert command asynchronously.
void	killCursor(List<Long> cursors) Kills the given list of cursors.
void	killCursorAsync(List<Long> cursors, SingleResultCallback<Void> callback) Asynchronously 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) Execute the query.
<T> void	queryAsync(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, SingleResultCallback<QueryResult<T>> callback) Execute the query asynchronously.
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.
void	updateAsync(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<UpdateRequest> updates, SingleResultCallback<WriteConcernResult> callback) Update the documents using the update wire protocol and apply the write concern asynchronously.
BulkWriteResult	updateCommand(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<UpdateRequest> updates) Update the documents using the update command.
void	updateCommandAsync(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, List<UpdateRequest> updates, SingleResultCallback<BulkWriteResult> callback) Update the documents using the update command asynchronously.

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

insertAsync

void insertAsync(MongoNamespace namespace,
               boolean ordered,
               WriteConcern writeConcern,
               List<InsertRequest> inserts,
               SingleResultCallback<WriteConcernResult> callback)

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

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

inserts - the inserts

callback - the callback to be passed the write 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

updateAsync

void updateAsync(MongoNamespace namespace,
               boolean ordered,
               WriteConcern writeConcern,
               List<UpdateRequest> updates,
               SingleResultCallback<WriteConcernResult> callback)

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

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

updates - the updates

callback - the callback to be passed the write 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

deleteAsync

void deleteAsync(MongoNamespace namespace,
               boolean ordered,
               WriteConcern writeConcern,
               List<DeleteRequest> deletes,
               SingleResultCallback<WriteConcernResult> callback)

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

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

deletes - the deletes

callback - the callback to be passed the write result

insertCommand

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

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

insertCommandAsync

void insertCommandAsync(MongoNamespace namespace,
                      boolean ordered,
                      WriteConcern writeConcern,
                      List<InsertRequest> inserts,
                      SingleResultCallback<BulkWriteResult> callback)

Insert the documents using the insert command asynchronously.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

inserts - the inserts

callback - the callback to be passed the bulk write result

updateCommand

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

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

updateCommandAsync

void updateCommandAsync(MongoNamespace namespace,
                      boolean ordered,
                      WriteConcern writeConcern,
                      List<UpdateRequest> updates,
                      SingleResultCallback<BulkWriteResult> callback)

Update the documents using the update command asynchronously.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

updates - the updates

callback - the callback to be passed the BulkWriteResult

deleteCommand

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

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

deleteCommandAsync

void deleteCommandAsync(MongoNamespace namespace,
                      boolean ordered,
                      WriteConcern writeConcern,
                      List<DeleteRequest> deletes,
                      SingleResultCallback<BulkWriteResult> callback)

Delete the documents using the delete command asynchronously.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

deletes - the deletes

callback - the callback to be passed the BulkWriteResult

command

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

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

commandAsync

<T> void commandAsync(String database,
                    BsonDocument command,
                    boolean slaveOk,
                    FieldNameValidator fieldNameValidator,
                    Decoder<T> commandResultDecoder,
                    SingleResultCallback<T> callback)

Execute the command asynchronously.

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

callback - the callback to be passed the command result

query

<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)

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

queryAsync

<T> void queryAsync(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,
                  SingleResultCallback<QueryResult<T>> callback)

Execute the query asynchronously.

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

callback - the callback to be passed the write result

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

getMoreAsync

<T> void getMoreAsync(MongoNamespace namespace,
                    long cursorId,
                    int numberToReturn,
                    Decoder<T> resultDecoder,
                    SingleResultCallback<QueryResult<T>> callback)

Get more result documents from a cursor asynchronously.

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 result documents

callback - the callback to be passed the query result

killCursor

void killCursor(List<Long> cursors)

Kills the given list of cursors.

Parameters:

cursors - the cursors

killCursorAsync

void killCursorAsync(List<Long> cursors,
                   SingleResultCallback<Void> callback)

Asynchronously Kills the given list of cursors.

Parameters:

cursors - the cursors

callback - the callback that is called once the cursors have been killed