Optional
allowOptional
authdbOptional
awaitIf awaitData is set to true, when the cursor reaches the end of the capped collection, MongoDB blocks the query thread for a period of time waiting for new data to arrive.如果awaitData设置为true
,当游标到达封顶集合的末尾时,MongoDB会阻塞查询线程一段时间,等待新数据到达。When new data is inserted into the capped collection, the blocked thread is signaled to wake up and return the next batch to the client.当新数据被插入到有上限的集合中时,被阻塞的线程会被通知唤醒并将下一批返回给客户端。
Optional
batchSpecifies the number of documents to return in each response from MongoDB指定MongoDB每次响应返回的文档数
Optional
bsonreturn BSON regular expressions as BSONRegExp instances.将BSON正则表达式作为BSONRegExp实例返回。
false
Optional
bypassAllow driver to bypass schema validation.允许驱动程序绕过架构验证。
Optional
checkthe serializer will check if keys are valid.序列化程序将检查键是否有效。
false
Optional
collationSpecify collation.指定排序规则。
Optional
commentComment to apply to the operation.要应用于操作的注释。
In server versions pre-4.4, 'comment' must be string. 在4.4之前的服务器版本中,“comment”必须是字符串。A server error will be thrown if any other type is provided.如果提供了任何其他类型,则会引发服务器错误。
In server versions 4.4 and above, 'comment' can be any valid BSON type.在服务器版本4.4及更高版本中,“comment”可以是任何有效的BSON类型。
Optional
cursorReturn the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.将查询作为游标返回,在2.6>上,它将作为实际游标返回。在2.6之前,它将以模拟游标的形式返回。
Optional
dbOptional
enableEnable utf8 validation when deserializing BSON documents. Defaults to true.在反序列化BSON文档时启用utf8验证。默认为true
。
Optional
explainSpecifies the verbosity mode for the explain output.指定解释输出的详细模式。
Optional
fieldsallow to specify if there what fields we wish to return as unserialized raw buffer.允许指定我们希望返回哪些字段作为未序列化的原始缓冲区。
null
Optional
hintAdd an index selection hint to an aggregation command向聚合命令添加索引选择提示
Optional
ignoreserialize will not emit undefined fields note that the driver sets this to 序列化不会发出未定义的字段请注意,驱动程序将其设置为false
false
true
Optional
letMap of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).可以使用$$var
访问的参数名称和值的映射(需要MongoDB 5.0)。
Optional
maxWhen applicable 适用时,maxAwaitTimeMS
controls the amount of time subsequent getMores that a cursor uses to fetch more data should take. (ex. cursor.next())maxAwaitTimeMS
控制游标用于获取更多数据的getMores之后的时间量。(例如cursor.next()
)
Optional
maxWhen applicable 如果适用,maxTimeMS
controls the amount of time the initial command that constructs a cursor should take. (ex. find, aggregate, listCollections)maxTimeMS
控制构造游标的初始命令应该花费的时间。(例如find
、aggregate
、listCollections
)
Optional
noOptional
noOptional
omitOptional
outOptional
promotewhen deserializing a Binary will return it as a node.js Buffer instance.当反序列化Binary时,它将作为nodejs Buffer实例返回。
false
Optional
promotewhen deserializing a Long will fit it into a Number if it's smaller than 53 bits.当反序列化Long时,如果它小于53位,则将其放入Number中。
true
Optional
promotewhen deserializing will promote BSON values to their Node.js closest equivalent types.反序列化时将BSON值提升为其Node.js最接近的等效类型。
true
Optional
rawEnabling the raw option will return a Node.js Buffer which is allocated using allocUnsafe API.启用raw选项将返回使用allocUnsafe API分配的Node.js缓冲区。
See this section from the Node.js Docs here for more detail about what "unsafe" refers to in this context.请参阅Node.js文档中的这一部分,了解有关“不安全”在本文中所指内容的更多详细信息。
If you need to maintain your own editable clone of the bytes returned for an extended life time of the process, it is recommended you allocate your own buffer and clone the contents:如果您需要维护自己的可编辑字节克隆,以延长进程的使用寿命,建议您分配自己的缓冲区并克隆内容:
const raw = await collection.findOne({}, { raw: true });
const myBuffer = Buffer.alloc(raw.byteLength);
myBuffer.set(raw, 0);
// Only save and use `myBuffer` beyond this point仅在此点之后保存和使用“myBuffer”
Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946).请注意,有一个已知的限制,即此选项不能在MongoClient级别使用(请参阅NODE-3946)。
It does correctly work at 它在Db
, Collection
, and per operation the same as other BSON options work.Db
、Collection
和每个操作中都能正常工作,与其他BSON选项的工作方式相同。
Optional
readSpecify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)指定集合的读取关注和级别。(仅支持MongoDB 3.2或更高版本)
Optional
readThe preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).首选读取首选项(ReadPreference.primary
, ReadPreference.primary_preferred
, ReadPreference.secondary
, ReadPreference.secondary_preferred
, ReadPreference.nearest
)。
Optional
retryShould retry failed writes
Optional
serializeserialize the javascript functions序列化javascript函数
false
Optional
sessionSpecify ClientSession for this command为此命令指定ClientSession
Optional
tailableBy default, MongoDB will automatically close a cursor when the client has exhausted all results in the cursor. 默认情况下,当客户端用完游标中的所有结果时,MongoDB会自动关闭游标。However, for capped collections you may use a Tailable Cursor that remains open after the client exhausts the results in the initial cursor.但是,对于封顶集合,您可以使用Tailable Cursor,该Cursor在客户端用完初始游标中的结果后保持打开状态。
Optional
usewhen deserializing a Long return as a BigInt.当将Long返回反序列化为BigInt时。
false
Optional
willOptional
writeWrite Concern as an object将关注作为对象写入
Generated using TypeDoc
allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).allowDiskUse让服务器知道是否可以使用磁盘存储聚合的临时结果(需要mongodb 2.6>)。