MongoDB的Wire协议

在本页面

• 介绍
• TCP / IP套接字
• 消息类型和格式
• 标准消息头
• 客户端请求消息

• 数据库响应消息

  介绍

MongoDB有线协议是一个简单的基于套接字的请求-响应风格的协议。客户端通过一个常规的TCP/IP套接字与数据库服务器通信。

TCP / IP套接字

客户机应该使用常规的TCP/IP套接字连接到数据库。没有连接握手。

Port

实例mongod和mongos的默认端口号是27017。mongod和mongos的xw端口号是可配置的，可能会有所不同。

字节次序

MongoDB线路协议中的所有整数都使用little-end字节顺序:也就是说，最低有效字节优先。

消息类型和格式

有两种类型的消息:客户机请求和数据库响应。

注意

该页面使用类似于C的struct形式描述消息结构。

本文档中使用的类型(cstring、int32等)与BSON规范中定义的类型相同。

为了表示重复，文档使用了来自BSON规范的星号符号。例如，int64*表示可以将一个或多个指定类型依次写入套接字。

标准的消息标题类型为MsgHeader。整型常量用大写字母表示(例如:0表示整数值0)。

标准消息头

通常，每个消息由一个标准消息头和特定于请求的数据组成。标准消息头的结构如下:

struct MsgHeader {
    int32   messageLength; // total message size, including this
    int32   requestID;     // identifier for this message
    int32   responseTo;    // requestID from the original request
                           //   (used in responses from db)
    int32   opCode;        // request type - see table below for details
}

请求操作码

注意

启动MongoDB 2.6和maxWireVersion3,MongoDB使用数据库命令插入,更新,和删除而不是OP_INSERT,OP_UPDATE和OP_DELETE公认写。大多数驱动程序继续对未确认的写操作使用操作码。

在4.2版本中，MongoDB删除了内部不赞成的OP_COMMAND和OP_COMMANDREPLY协议。

以下是支持的操作码:

客户端请求消息

客户端可以发送除OP_REPLY之外的所有操作码的请求消息。OP_REPLY为数据库保留使用。

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

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

OP_UPDATE

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

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
}

没有对OP_UPDATE消息的响应。

OP_INSERT

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

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
}

没有对OP_INSERT消息的响应。

OP_QUERY

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

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.  See below for details.
  [ document  returnFieldsSelector; ] // Optional. Selector indicating the fields
                                      //  to return.  See below for details.
}

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

OP_GET_MORE

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

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
}

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

OP_DELETE

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

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.
}

没有对OP_DELETE消息的响应。

OP_KILL_CURSORS

OP_KILL_CURSORS消息用于关闭数据库中的活动游标。这对于确保在查询结束时回收数据库资源是必要的。OP_KILL_CURSORS消息的格式为:

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
}

如果游标读取,直到耗尽(读,直到OP_QUERY或OP_GET_MORE返回0光标id),不需要杀死光标。

OP_MSG

新版本MongoDB: 3.6

OP_MSG是一种可扩展的消息格式，旨在包含其他操作码的功能。此操作码的格式如下:

OP_MSG {
    MsgHeader header;          // standard message header
    uint32 flagBits;           // message flags
    Sections[] sections;       // data sections
    optional<uint32> checksum; // optional CRC-32C checksum
}

标志位

整数flagBits是位掩码编码标志，用于修改 OP_MSG 的格式和行为。

前16位(0-15)是必须的，如果设置了未知位，解析器一定会出错。

最后16位(16-31)是可选的，解析器一定会忽略任何未知的设置位。代理和其他消息转代必须在转发消息之前清除任何未知的可选位。

部分

一个OP_MSG消息包含一个或多个部分。每个节以表示其类型的kind字节开始。kind字节之后的所有内容构成了节的有效负载。

下面是可用的部分类型。

Kind 0: 身体

主体部分被编码为一个单个 BSON对象。BSON对象中的大小也用作部分的大小。本节类是标准命令请求和应答体。

所有顶级字段必须有一个唯一的名称。

Kind 1: 文档顺序

Checksum

每个消息可能以CRC-32CChecksum结束，它涵盖了消息中除了Checksum本身之外的所有字节。

从MongoDB 4.2开始:

• 如果不使用TLS/SSL连接，mongod实例、mongos实例和mongo shell实例将使用Checksum交换消息。
• 如果使用TLS/SSL连接，mongod 实例、 mongos实例和 mongo shell实例将跳过Checksum。

如果显示带有Checksum的消息，驱动程序和较老的二进制文件将忽略Checksum。

Checksum的存在是由checksumPresent标志位来表示的。

数据库响应消息

OP_REPLY

OP_REPLY消息由数据库发送，以响应一个OP_QUERY或OP_GET_MORE消息。OP_REPLY消息的格式为:

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
}

参见

原文 - MongoDB Wire Protocol