Interface CountDocumentsOptions

Hierarchy

Properties

allowDiskUse?: boolean

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>)。

authdb?: string
batchSize?: number

The number of documents to return per batch. See aggregation documentation.每批要返回的文档数。请参阅聚合文档

bsonRegExp?: boolean

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

Default Value

false

bypassDocumentValidation?: boolean

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

checkKeys?: boolean

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

Default Value

false

collation?: CollationOptions

Specify collation.指定排序规则。

comment?: unknown

Comment 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类型。

cursor?: Document

Return 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之前,它将以模拟游标的形式返回。

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?: Hint

Add an index selection hint to an aggregation command向聚合命令添加索引选择提示

ignoreUndefined?: boolean

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

Default Value

true

let?: Document

Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).可以使用$$var访问的参数名称和值的映射(需要MongoDB 5.0)。

limit?: number

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

maxAwaitTimeMS?: number

The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.服务器等待新文档以满足可定制游标查询的最长时间。

maxTimeMS?: number

specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.指定处理游标上的操作的累积时间限制(以毫秒为单位)。MongoDB在以下最早的中断点中断操作。

noResponse?: boolean
omitReadPreference?: boolean
out?: string
promoteBuffers?: boolean

when deserializing a Binary will return it as a node.js Buffer instance.当反序列化Binary时,它将作为node.js 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.请参阅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:如果您需要维护自己的可编辑字节克隆,以延长进程的使用寿命,建议您分配自己的缓冲区并克隆内容:

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仅在此点之后保存和使用“myBuffer”

Remarks

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)。

retryWrites?: boolean

Should retry failed writes应重试失败的写入

serializeFunctions?: boolean

serialize the javascript functions序列化javascript函数

Default Value

false

session?: ClientSession

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

skip?: number

The number of documents to skip.要跳过的文档数。

useBigInt64?: boolean

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

Default Value

false

willRetryWrite?: boolean

Write Concern as an object将关注作为对象写入

Generated using TypeDoc