com.allanbank.mongodb.connection.message

Class Command

java.lang.Object

com.allanbank.mongodb.connection.message.AbstractMessage

com.allanbank.mongodb.connection.message.Query

com.allanbank.mongodb.connection.message.Command

All Implemented Interfaces:

Message

Direct Known Subclasses:

AdminCommand

public class Command
extends Query

Helper class to make generating command queries easier.

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

Modifier and Type	Field and Description
static String	COMMAND_COLLECTION The collection to use when issuing commands to the database.

Fields inherited from class com.allanbank.mongodb.connection.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.connection.message.AbstractMessage

HEADER_SIZE, myCollectionName, myDatabaseName

Constructor Summary

Constructors

Constructor and Description
Command(String databaseName, Document commandDocument) Create a new Command.
Command(String databaseName, Document commandDocument, ReadPreference readPreference) Create a new Command.

Method Summary

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

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

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

getCollectionName, getDatabaseName, getReadPreference, init, writeHeader

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_COLLECTION

public static final String COMMAND_COLLECTION

The collection to use when issuing commands to the database.

See Also:

Constant Field Values

Constructor Detail

Command

public Command(String databaseName,
       Document commandDocument)

Create a new Command.

Parameters:

databaseName - The name of the database.

commandDocument - The command document containing the command and options.

Command

public Command(String databaseName,
       Document commandDocument,
       ReadPreference readPreference)

Create a new Command.

Parameters:

databaseName - The name of the database.

commandDocument - The command document containing the command and options.

readPreference - The preference for which servers to use to retrieve the results.