Optional
authdbOptional
bsonfalse
Optional
bypassIf true, allows the write to opt-out of document level validation如果为true
,则允许写入选择退出文档级验证
Optional
checkthe serializer will check if keys are valid.序列化程序将检查键是否有效。
false
Optional
collationSpecifies a 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
dbOptional
enableEnable utf8 validation when deserializing BSON documents. 在反序列化BSON文档时启用utf8验证。Defaults to true.默认为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
hintSpecify that the update query should only consider plans using the hinted index指定更新查询应仅考虑使用提示索引的计划
Optional
ignoreserialize will not emit undefined fields note that the driver sets this to serialize不会发出未定义的字段请注意,驱动程序将其设置为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
maxOptional
noOptional
omitOptional
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
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
upsertWhen true, creates a new document if no document matches the query如果为true
,则在没有文档与查询匹配的情况下创建新文档
Optional
usewhen deserializing a Long return as a BigInt.当将Long返回反序列化为BigInt时。
false
Optional
willOptional
writeWrite Concern as an object将关注作为对象写入
Generated using TypeDoc
return BSON regular expressions as BSONRegExp instances.将BSON正则表达式作为BSONRegExp实例返回。