Interface InsertOneOptions

interface InsertOneOptions {
    authdb?: string;
    bsonRegExp?: boolean;
    bypassDocumentValidation?: boolean;
    checkKeys?: boolean;
    collation?: CollationOptions;
    comment?: unknown;
    dbName?: string;
    enableUtf8Validation?: boolean;
    explain?: ExplainVerbosityLike | ExplainCommandOptions;
    fieldsAsRaw?: Document;
    forceServerObjectId?: boolean;
    ignoreUndefined?: boolean;
    maxTimeMS?: number;
    promoteBuffers?: boolean;
    promoteLongs?: boolean;
    promoteValues?: boolean;
    raw?: boolean;
    readConcern?: ReadConcernLike;
    readPreference?: ReadPreferenceLike;
    serializeFunctions?: boolean;
    session?: ClientSession;
    timeoutMS?: number;
    useBigInt64?: boolean;
    willRetryWrite?: boolean;
    writeConcern?: WriteConcern | WriteConcernSettings;
}

Hierarchy (view full)

Properties

authdb?: string
bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.将BSON正则表达式作为BSONRegExp实例返回。

false

bypassDocumentValidation?: boolean

Allow driver to bypass schema validation.允许驱动程序绕过架构验证。

checkKeys?: boolean

the serializer will check if keys are valid.串行器将检查键是否有效。

false

collation?: CollationOptions

Collation

comment?: unknown

Comment to apply to the operation.注释适用于操作。

In server versions pre-4.4, 'comment' must be string. A server error will be thrown if any other type is provided.在4.4之前的服务器版本中,'comment'必须是字符串。如果提供任何其他类型,将引发服务器错误。

In server versions 4.4 and above, 'comment' can be any valid BSON type.在服务器版本4.4及更高版本中,“comment”可以是任何有效的BSON类型。

dbName?: string
enableUtf8Validation?: boolean

Enable utf8 validation when deserializing BSON documents. Defaults to true.在反序列化BSON文档时启用utf8验证。默认为true

Specifies the verbosity mode for the explain output.指定解释输出的详细程度模式。

fieldsAsRaw?: Document

allow to specify if there what fields we wish to return as unserialized raw buffer.允许指定是否有我们希望作为未序列化的原始缓冲区返回的字段。

null

forceServerObjectId?: boolean

Force server to assign _id values instead of driver.强一致性务器分配_id值而不是驱动程序。

ignoreUndefined?: boolean

serialize will not emit undefined fields note that the driver sets this to falseserialize不会发出未定义的字段,请注意驱动程序将其设置为false

true

maxTimeMS?: number

maxTimeMS is a server-side time limit in milliseconds for processing an operation.maxTimeMS是处理操作的服务器端时间限制(以毫秒为单位)。

promoteBuffers?: boolean

when deserializing a Binary will return it as a node.js Buffer instance.当反序列化Binary时,它将作为nodejs Buffer实例返回。

false

promoteLongs?: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits.当反序列化一个Long时,如果它小于53位,它将适合一个Number。

true

promoteValues?: boolean

when deserializing will promote BSON values to their Node.js closest equivalent types.当反序列化将BSON值提升到其Node.js最接近的等效类型时。

true

raw?: boolean

Enabling 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.它在DbCollection和每次操作中都能正常工作,与其他BSON选项的工作方式相同。

readConcern?: ReadConcernLike

Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)指定集合的读取关注和级别。(仅支持MongoDB 3.2或更高版本)

readPreference?: ReadPreferenceLike

The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).首选的读取首选项(ReadPreference.primaryReadPreference.primary_preferredReadPreference.secondaryReadPreference.secondary_preferredReadPreference.nearest)。

serializeFunctions?: boolean

serialize the javascript functions序列化javascript函数

false

session?: ClientSession

Specify ClientSession for this command为此命令指定ClientSession

timeoutMS?: number

Specifies the time an operation will run until it throws a timeout error指定操作运行到抛出超时错误的时间

useBigInt64?: boolean

when deserializing a Long return as a BigInt.当将Long返回反序列化为BigInt时。

false

willRetryWrite?: boolean

Write Concern as an object将问题作为对象写入