com.allanbank.mongodb.client.message

Class GetLastError

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.Query

com.allanbank.mongodb.client.message.GetLastError

All Implemented Interfaces:

Message, CursorableMessage

public class GetLastError
extends Query

Provides a convenient mechanism for creating a getlasterror command.

This is a helper class for retrieving the results of Delete, Insert, and Update commands. Get last error is not a part of the standard wire protocol but is provided here due to the frequency of usage.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields inherited from class com.allanbank.mongodb.client.message.Query

AWAIT_DATA_FLAG_BIT, DEFAULT_BATCH_SIZE, EXHAUST_FLAG_BIT, NO_CURSOR_TIMEOUT_FLAG_BIT, OPLOG_REPLAY_FLAG_BIT, PARTIAL_FLAG_BIT, REPLICA_OK_FLAG_BIT, TAILABLE_CURSOR_FLAG_BIT

Fields inherited from class com.allanbank.mongodb.client.message.AbstractMessage

HEADER_SIZE, myCollectionName, myDatabaseName

Constructor Summary

Constructors

Constructor and Description
GetLastError(String dbName, boolean fsync, boolean waitForJournal, int w, int wtimeout) Create a new GetLastError.
GetLastError(String dbName, Durability durability) Create a new GetLastError.

Method Summary

Methods

Modifier and Type	Method and Description
String	toString()

Methods inherited from class com.allanbank.mongodb.client.message.Query

equals, getBatchSize, getLimit, getNumberToReturn, getNumberToSkip, getOperationName, getQuery, getReturnFields, hashCode, isAwaitData, isBatchSizeSet, isExhaust, isLimitSet, isNoCursorTimeout, isPartial, isTailable, size, validateSize, write, write

Methods inherited from class com.allanbank.mongodb.client.message.AbstractMessage

finishHeader, getCollectionName, getDatabaseName, getReadPreference, getRequiredVersionRange, init, writeHeader, writeHeader

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.allanbank.mongodb.client.message.CursorableMessage

getCollectionName

Methods inherited from interface com.allanbank.mongodb.client.Message

getDatabaseName, getReadPreference, getRequiredVersionRange

Constructor Detail

GetLastError

public GetLastError(String dbName,
            boolean fsync,
            boolean waitForJournal,
            int w,
            int wtimeout)

Create a new GetLastError.

Parameters:

dbName - The name of the database.

fsync - If true the command waits for an fsync of the data to have completed.

waitForJournal - If true the command waits for the preceding command to have been written to the journal.

w - The replication factor to wait for.

wtimeout - The amount of time (in milliseconds) to wait for the write to finish.

GetLastError

public GetLastError(String dbName,
            Durability durability)

Create a new GetLastError.

Parameters:

dbName - The name of the database.

durability - The Durability requested.

Method Detail

toString

public String toString()

Overridden to returns the getLastError on a single line.

Overrides:

toString in class Object