Interface CountOptions

Hierarchy

Properties

authdb?: string
bsonRegExp?: boolean

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

Default Value

false

checkKeys?: boolean

the serializer will check if keys are valid.序列化程序将检查键是否有效。

Default Value

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.允许指定我们希望返回哪些字段作为未序列化的原始缓冲区。

Default Value

null

hint?: string | Document

An index name hint for the query.查询的索引名称提示。

ignoreUndefined?: boolean

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

Default Value

true

limit?: number

The maximum amounts to count before aborting.中止前要计数的最大数量。

maxTimeMS?: number

Number of milliseconds to wait before aborting the query.中止查询前等待的毫秒数。

noResponse?: boolean
omitReadPreference?: boolean
promoteBuffers?: boolean

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

Default Value

false

promoteLongs?: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits.当反序列化Long时,如果它小于53位,则将其放入Number中。

Default Value

true

promoteValues?: boolean

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

Default Value

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. 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:如果您需要维护自己的可编辑字节克隆,以延长进程的使用寿命,建议您分配自己的缓冲区并克隆内容:

Example

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

Remarks

Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946). It does correctly work at Db, Collection, and per operation the same as other BSON options work.

readConcern?: ReadConcernLike

Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)

readPreference?: ReadPreferenceLike

The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

retryWrites?: boolean

Should retry failed writes

serializeFunctions?: boolean

serialize the javascript functions

Default Value

false

session?: ClientSession

Specify ClientSession for this command

skip?: number

The number of documents to skip.

useBigInt64?: boolean

when deserializing a Long return as a BigInt.

Default Value

false

willRetryWrite?: boolean

Write Concern as an object

Generated using TypeDoc