net.fehmicansaglam.tepkin.protocol

message

package message

Visibility
  1. Public
  2. All

Type Members

  1. case class DeleteMessage(fullCollectionName: String, selector: BsonDocument, singleRemove: Boolean = false) extends Message with Product with Serializable

    The OP_DELETE message is used to remove one or more documents from a collection.

    The OP_DELETE message is used to remove one or more documents from a collection. The format of the OP_DELETE message is:

    struct {
        MsgHeader header;             // standard message header
        int32     ZERO;               // 0 - reserved for future use
        cstring   fullCollectionName; // "dbname.collectionname"
        int32     flags;              // bit vector - see below for details.
        document  selector;           // query object.  See below for details.
    }
  2. case class GetMoreMessage(fullCollectionName: String, cursorID: Long, numberToReturn: Int = 0) extends Message with Product with Serializable

    The OP_GET_MORE message is used to query the database for documents in a collection.

    The OP_GET_MORE message is used to query the database for documents in a collection. The format of the OP_GET_MORE message is:

    struct {
        MsgHeader header;             // standard message header
        int32     ZERO;               // 0 - reserved for future use
        cstring   fullCollectionName; // "dbname.collectionname"
        int32     numberToReturn;     // number of documents to return
        int64     cursorID;           // cursorID from the OP_REPLY
    }
  3. case class InsertMessage(fullCollectionName: String, documents: Seq[BsonDocument], continueOnError: Boolean = false) extends Message with Product with Serializable

    The OP_INSERT message is used to insert one or more documents into a collection.

    The OP_INSERT message is used to insert one or more documents into a collection. The format of the OP_INSERT message is:

    struct {
        MsgHeader header;             // standard message header
        int32     flags;              // bit vector - see below
        cstring   fullCollectionName; // "dbname.collectionname"
        document* documents;          // one or more documents to insert into the collection
    }
  4. case class KillCursorsMessage(cursorIDs: Long*) extends Message with Product with Serializable

    The OP_KILL_CURSORS message is used to close an active cursor in the database.

    The OP_KILL_CURSORS message is used to close an active cursor in the database. This is necessary to ensure that database resources are reclaimed at the end of the query. The format of the OP_KILL_CURSORS message is:

    struct {
        MsgHeader header;            // standard message header
        int32     ZERO;              // 0 - reserved for future use
        int32     numberOfCursorIDs; // number of cursorIDs in message
        int64*    cursorIDs;         // sequence of cursorIDs to close
    }
  5. trait Message extends Writable

  6. case class QueryMessage(fullCollectionName: String, query: BsonDocument, fields: Option[BsonDocument] = None, numberToSkip: Int = 0, numberToReturn: Int = 0) extends Message with Product with Serializable

    The OP_QUERY message is used to query the database for documents in a collection.

    The OP_QUERY message is used to query the database for documents in a collection. The format of the OP_QUERY message is:

    struct OP_QUERY {
        MsgHeader header;                 // standard message header
        int32     flags;                  // bit vector of query options.  See below for details.
        cstring   fullCollectionName;     // "dbname.collectionname"
        int32     numberToSkip;           // number of documents to skip
        int32     numberToReturn;         // number of documents to return in the first OP_REPLY batch
        document  query;                  // query object.
      [ document  returnFieldsSelector; ] // Optional. Selector indicating the fields to return.
    }
  7. case class Reply(responseTo: Int, cursorID: Long, startingFrom: Int, numberReturned: Int, documents: List[BsonDocument]) extends Message with Product with Serializable

    The OP_REPLY message is sent by the database in response to an OP_QUERY or OP_GET_MORE message.

    The OP_REPLY message is sent by the database in response to an OP_QUERY or OP_GET_MORE message. The format of an OP_REPLY message is:

    struct {
        MsgHeader header;         // standard message header
        int32     responseFlags;  // bit vector - see details below
        int64     cursorID;       // cursor id if client needs to do get more's
        int32     startingFrom;   // where in the cursor this reply is starting
        int32     numberReturned; // number of documents in the reply
        document* documents;      // documents
    }
  8. case class UpdateMessage(fullCollectionName: String, selector: BsonDocument, update: BsonDocument, upsert: Boolean = false, multi: Boolean = false) extends Message with Product with Serializable

    The OP_UPDATE message is used to update a document in a collection.

    The OP_UPDATE message is used to update a document in a collection. The format of a OP_UPDATE message is the following:

    struct OP_UPDATE {
        MsgHeader header;             // standard message header
        int32     ZERO;               // 0 - reserved for future use
        cstring   fullCollectionName; // "dbname.collectionname"
        int32     flags;              // bit vector. see below
        document  selector;           // the query to select the document
        document  update;             // specification of the update to perform
    }

Value Members

  1. object Reply extends Serializable

  2. object RequestIDGenerator

Ungrouped