com.mongodb

Class WriteResult

java.lang.Object

com.mongodb.WriteResult

public class WriteResult
extends Object

This class lets you access the results of the previous write. if you have STRICT mode on, this just stores the result of that getLastError call if you don't, then this will actually do the getlasterror call. if another operation has been done on this connection in the interim, calls will fail

Method Summary

Methods

Modifier and Type	Method and Description
CommandResult	getCachedLastError() Deprecated. Use the appropriate WriteConcern and rely on the write operation to throw an exception on failure. For successful writes, use the helper methods to retrieve specific values from the write response.
String	getError() Deprecated. There should be no reason to use this method. The error message will be in the exception thrown for an unsuccessful write operation.
Object	getField(String name) Deprecated. There should be no reason to use this method. To get specific fields from a successful write, use the helper methods provided. Any error-related fields will be in the exception thrown for an unsuccessful write operation.
WriteConcern	getLastConcern() Gets the last WriteConcern used when calling getLastError().
CommandResult	getLastError() Deprecated. Use the appropriate WriteConcern and allow the write operation to throw an exception on failure. For successful writes, use the helper methods to retrieve specific values from the write response.
CommandResult	getLastError(WriteConcern concern) Deprecated. Use the appropriate WriteConcern and rely on the write operation to throw an exception on failure. For successful writes, use the helper methods to retrieve specific values from the write response.
int	getN() Gets the "n" field, which contains the number of documents affected in the write operation.
Object	getUpsertedId() Gets the _id value of an upserted document that resulted from this write.
boolean	isLazy() Deprecated. Call WriteResult.getLastConcern().isAcknowledged() instead
boolean	isUpdateOfExisting() Returns true if this write resulted in an update of an existing document.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getCachedLastError

@Deprecated
public CommandResult getCachedLastError()

Deprecated. Use the appropriate WriteConcern and rely on the write operation to throw an exception on failure. For successful writes, use the helper methods to retrieve specific values from the write response.

Gets the last result from getLastError().

Returns:

the result of the write operation

See Also:

getN(), getUpsertedId(), isUpdateOfExisting()

getLastConcern

public WriteConcern getLastConcern()

Gets the last WriteConcern used when calling getLastError().

Returns:

the write concern that was applied to the write operation

getLastError

@Deprecated
public CommandResult getLastError()

Deprecated. Use the appropriate WriteConcern and allow the write operation to throw an exception on failure. For successful writes, use the helper methods to retrieve specific values from the write response.

Calls getLastError(com.mongodb.WriteConcern) with a null write concern.

Returns:

the response to the write operation

Throws:

MongoException

See Also:

getN(), getUpsertedId(), isUpdateOfExisting()

getLastError

@Deprecated
public CommandResult getLastError(WriteConcern concern)

Deprecated. Use the appropriate WriteConcern and rely on the write operation to throw an exception on failure. For successful writes, use the helper methods to retrieve specific values from the write response.

This method does following: - returns the existing CommandResult if concern is null or less strict than the concern it was obtained with - otherwise attempts to obtain a CommandResult by calling getLastError with the concern

Parameters:

concern - the concern

Returns:

the response to the write operation

Throws:

MongoException

See Also:

getN(), getUpsertedId(), isUpdateOfExisting()

getError

@Deprecated
public String getError()

Deprecated. There should be no reason to use this method. The error message will be in the exception thrown for an unsuccessful write operation.

Gets the error message from the "err" field).

Returns:

the error

Throws:

MongoException

getN

public int getN()

Gets the "n" field, which contains the number of documents affected in the write operation.

Returns:

the number of documents modified by the write operation

Throws:

MongoException

getUpsertedId

public Object getUpsertedId()

Gets the _id value of an upserted document that resulted from this write. Note that for MongoDB servers prior to version 2.6, this method will return null unless the _id of the upserted document was of type ObjectId.

Returns:

the value of the _id of an upserted document

Since:

2.12

isUpdateOfExisting

public boolean isUpdateOfExisting()

Returns true if this write resulted in an update of an existing document.

Returns:

whether the write resulted in an update of an existing document.

Since:

2.12

getField

@Deprecated
public Object getField(String name)

Deprecated. There should be no reason to use this method. To get specific fields from a successful write, use the helper methods provided. Any error-related fields will be in the exception thrown for an unsuccessful write operation.

Gets a field from the response to the write operation.

Parameters:

name - field name

Returns:

the value of the field with the given name

Throws:

MongoException

See Also:

getN(), getUpsertedId(), isUpdateOfExisting()

isLazy

@Deprecated
public boolean isLazy()

Deprecated. Call WriteResult.getLastConcern().isAcknowledged() instead

Returns whether or not the result is lazy, meaning that getLastError was not called automatically

Returns:

true if the result is lazy

toString

public String toString()

Overrides:

toString in class Object