MongoDB 通信协议

• 简介
• TCP/IP套接字
• 报文类型格式
• 标准报文头
• 客户端请求报文
• 数据库响应报文

简介

MongoDB 通信协议是简单的基于套接字的请求响应风格的协议。客户端和数据库服务器通过长连接的 TCP/IP 套接字来进行交互。

套接字

客户端通过长连接的 TCP/IP 套接字来与数据库连接，没有连接握手阶段。

端口

mongod和mongos进程默认端口号为 27017，此外端口是可以配置修改的。

字节序

MongoDB 通信协议的数据采用小端字节序。

报文类型格式

报文类型有两种，客户端请求和数据库响应。

注解

• 本文使用 C 语言风格的结构体来描述报文格式。
• 文档中使用的类型如 (
  cstring
  ,
  int32
  , 等.) 对应于BSON 类型说明中的数据类型格式
  .
• 文档中使用星号表示法来表示重复，例如 int64* 表示一个或多个 int64 类型（具体可见BSON 类型说明）可以被一个接一个的往套接字中写入。
• 本文将标准头部命名为 MsgHeader。整型常量使用大写字母表示 (例如，ZERO 表示整型值 0)。

标准报文头

一般来说，每个消息包含一个标准的消息头紧随其后的是特定数据。标准的消息头的结构如下:

struct MsgHeader {
    int32   messageLength; // 总报文大小，包含本字段
    int32   requestID;     // 报文标识 ID
    int32   responseTo;    // 数据库响应报文标识 ID，和 requestID 一样，
                           // 表明响应回该 requestID 对应的请求
    int32   opCode;        // 请求类型 - 具体参照下表
}

请求操作码

注释

自 MongoDB 2.6 和maxWireVersion 3, MongoDB 驱动使用数据库命令insert,update, 和delete方式代替 OP_INSERT,OP_UPDATE, 和OP_DELETE操作码方式。许多驱动仍然在使用操作码方式。

重点

OP_COMMAND 和 OP_COMMANDREPLY 是集群内部操作命令，不需要实现。

OP_COMMAND 和 OP_COMMANDREPLY 操作协议格式是非固定的，不支持向后兼容。

协议支持的 操作码 (Opcode) 如下:

客户端请求报文

客户端可以发送指定除OP_REPLYopCode以外的所有请求消息。OP_REPLY被保留供数据库使用。

只有OP_QUERY和OP_GET_MORE消息导致数据库的响应。将不会有任何其他消息发送回应。

您可以使用getLastError命令确定消息是否成功。

OP_UPDATE

OP_UPDATE消息用于更新集合中的文档。OP_UPDATE消息的格式如下：

struct OP_UPDATE {
    MsgHeader header;             // 标准报文头
    int32     ZERO;               // 0 - 保留给以后使用
    cstring   fullCollectionName; // "dbname.collectionname"
    int32     flags;              // 矢量位，见下表
    document  selector;           // 文档查询条件
    document  update;             // 指定要执行的更新
}

没有对OP_UPDATE消息的响应。

OP_INSERT

OP_INSERT消息用于将一个或多个文档插入到集合中。OP_INSERT消息的格式是

struct {
    MsgHeader header;             // 标准的报文头
    int32     flags;              // 位向量 - 见下面
    cstring   fullCollectionName; // "dbname.collectionname"
    document* documents;          // 一个或多个要插入集合的文档
}

对OP_INSERT消息没有响应。

OP_QUERY

OP_QUERY消息用于在数据库中查询集合中的文档。OP_QUERY消息的格式是：

struct OP_QUERY {
    MsgHeader header;                 // 标准的报文头
    int32     flags;                  // 查询选项的位向量。详情请参阅下文。
    cstring   fullCollectionName ;    // "dbname.collectionname"
    int32     numberToSkip;           // 要跳过的文件数
    int32     numberToReturn;         // 表示第一个 OP_REPLY 响应中的文档返回数，
    document  query;                  // 查询条件，见下表
  [ document  returnFieldsSelector; ] // 用于限制返回文档的字段，见下表
}

数据库将用OP_REPLY消息响应OP_QUERY消息。

OP_GET_MORE

OP_GET_MORE消息用于在数据库中查询集合中的文档。OP_GET_MORE消息的格式是：

struct {
    MsgHeader header;             // 标准报文头
    int32     ZERO;               // 0 - 保留给以后使用
    cstring   fullCollectionName; // "dbname.collectionname"
    int32     numberToReturn;     // 返回的文档数量
    int64     cursorID;           // cursorID 会在 OP_REPLY 中设置
}

数据库将用OP_REPLY消息响应OP_GET_MORE消息。

OP_DELETE

OP_DELETE消息用于从集合中删除一个或多个文档。OP_DELETE消息的格式是：

struct {
    MsgHeader header;             // 标准报文头
    int32     ZERO;               // 0 - 保留给以后使用
    cstring   fullCollectionName; // "dbname.collectionname"
    int32     flags;              // 矢量位，见下表
    document  selector;           // 查询过滤条件，见下表
}

没有响应OP_DELETE消息。

OP_KILL_CURSORS

OP_KILL_CURSORS消息用于关闭数据库中的活动光标。这是确保在查询结束时回收数据库资源所必需的。OP_KILL_CURSORS消息的格式是：

struct {
    MsgHeader header;            // 标准报文头部
    int32     ZERO;              // 0 - 保留以后使用
    int32     numberOfCursorIDs; // CursorID 数量
    int64*    cursorIDs;         // 需要关闭的游标
}

如果游标被读取直到耗尽（读取直到OP_QUERY或OP_GET_MORE为游标ID返回0），则不需要终止游标。

OP_COMMAND

警告

OP_COMMAND是集群内部的，不应该由客户端或驱动程序来实现。

的OP_COMMAND格式和协议是不稳定的，而不保持向后兼容版本之间可能会改变。

OP_COMMAND是一个有线协议消息，用于在一个MongoDB服务器向另一个MongoDB服务器发出的集群内数据库命令请求。接收数据库发回一个OP_COMMANDREPLY作为对一个响应OP_COMMAND。

struct {
   MsgHeader header;     // 标准报文头部
   cstring database;     // 要运行该命令的数据库的名称
   cstring commandName;  // 命令名称
   document metadata;    // 命令描述信息
   document commandArgs; // 命令参数
   inputDocs;            // 用于输入到命令的零个或多个文档
}

数据库响应报文

OP_REPLY

该OP_REPLY消息由数据库发送，以响应OP_QUERY或OP_GET_MORE消息。OP_REPLY消息的格式是：

struct {
    MsgHeader header;         // 标准报文头
    int32     responseFlags;  // 适量位，见下表
    int64     cursorID;       // 游标 id，在 OP\_GET\_MORE 时会被用到
    int32     startingFrom;   // 光标起始位置
    int32     numberReturned; // 响应中的文档数量
    document* documents;      // 响应文档
}

OP_COMMANDREPLY

警告

OP_COMMANDREPLY是集群内部的，不应该由客户端或驱动程序来实现。

的OP_COMMANDREPLY格式和协议是不稳定的，而不保持向后兼容版本之间可能会改变。

这OP_COMMANDREPLY是一个有线协议消息，用于在内部响应由一个MongoDB服务器向另一个服务器发出的集群内OP_COMMAND请求。

格式OP_COMMANDREPLY是：

struct {
   MsgHeader header;       // 标准报文头
   document metadata;      // 一个 BSON 格式的命令描述信息
   document commandReply;  // 一个 BSON 格式的命令响应
   document outputDocs;    // 返回内容文档
}