Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FindOptions<TSchema>

Type parameters

  • TSchema: Document = Document

    Unused schema definition, deprecated usage, only specify FindOptions with no generic未使用的架构定义,不推荐使用,仅指定FindOptions而不指定泛型

Hierarchy继承层级

Index索引

Properties属性

allowDiskUse?: boolean

Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)允许磁盘用于阻止超过100MB内存的排序操作。(MongoDB 3.2或更高版本)

allowPartialResults?: boolean

For queries against a sharded collection, allows the command (or subsequent getMore commands) to return partial results, rather than an error, if one or more queried shards are unavailable.对于针对分片集合的查询,如果一个或多个查询的分片不可用,则允许命令(或后续的getMore命令)返回部分结果,而不是错误。

authdb?: string
awaitData?: boolean

Specify if the cursor is a tailable-await cursor. 指定游标是否为可拖尾的等待游标。Requires tailable to be true要求可tailable为真

batchSize?: number

Set the batchSize for the getMoreCommand when iterating over the query results.迭代查询结果时,设置getMoreCommand的batchSize。

bsonRegExp?: boolean

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

checkKeys?: boolean

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

collation?: CollationOptions

Specify collation (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).指定更新操作的排序规则(MongoDB 3.4或更高版本)设置(有关可用字段,请参阅3.4文档)。

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

dbName?: string
enableUtf8Validation?: boolean

Enable utf8 validation when deserializing BSON documents. 反序列化BSON文档时启用utf8验证。Defaults to true.默认为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.允许指定是否存在我们希望作为非序列化原始缓冲区返回的字段。

fullResponse?: boolean
deprecated

This option does nothing

hint?: Hint

Tell the query to use specific indexes in the query. Object of indexes to use, {'_id':1}告诉查询在查询中使用特定索引。要使用的索引对象,{'_id':1}

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)序列化不会发出未定义的字段(默认值: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

Sets the limit of documents returned in the query.设置查询中返回的文档的限制。

max?: Document

The exclusive upper bound for a specific index特定索引的独占上界

maxAwaitTimeMS?: number

The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. 服务器等待新文档以满足可跟踪游标查询的最长时间。Requires tailable and awaitData to be true要求tailableawaitDatatrue

maxTimeMS?: number

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

min?: Document

The inclusive lower bound for a specific index特定索引的包含下限

noCursorTimeout?: boolean

The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. 服务器通常会在一段非活动时间(10分钟)后超时空闲游标,以防止内存过度使用。Set this option to prevent that.设置此选项可防止这种情况发生。

noResponse?: boolean
omitReadPreference?: boolean
oplogReplay?: boolean

Option to enable an optimized code path for queries looking for a particular range of ts values in the oplog. 选项为在oplog中查找特定范围的ts值的查询启用优化的代码路径。Requires tailable to be true.要求tailabletrue

deprecated

Starting from MongoDB 4.4 this flag is not needed and will be ignored.从MongoDB 4.4开始,此标志不需要,将被忽略。

projection?: Document

The fields to return in the query. 要在查询中返回的字段。Object of fields to either include or exclude (one of, not both), {'a':1, 'b': 1} or {'a': 0, 'b': 0}要包含或排除的字段的对象(一个,而不是两个)、{'a':1, 'b': 1}{'a': 0, 'b': 0}

promoteBuffers?: boolean

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

promoteLongs?: boolean

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

promoteValues?: boolean

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

raw?: boolean

Return BSON filled buffers from operations从操作返回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应重试失败的写入

returnKey?: boolean

If true, returns only the index keys in the resulting documents.如果为true,则只返回结果文档中的索引键。

serializeFunctions?: boolean

serialize the javascript functions (default:false).序列化javascript函数(默认值:false)。

session?: ClientSession

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

showRecordId?: boolean

Determines whether to return the record identifier for each document. 确定是否返回每个文档的记录标识符。If true, adds a field $recordId to the returned documents.如果为true,则在返回的文档中添加字段$recordId

singleBatch?: boolean

Determines whether to close the cursor after the first batch. Defaults to false.确定是否在第一批之后关闭游标。默认为false

skip?: number

Set to skip N documents ahead in your query (useful for pagination).设置为在查询中跳过前面的N个文档(对于分页很有用)。

sort?: Sort

Set to sort the documents coming back from the query. 设置为对查询返回的文档进行排序。Array of indexes, [['a', 1]] etc.索引数组,[['a',1]]等。

tailable?: boolean

Specify if the cursor is tailable.指定游标是否可拖尾。

timeout?: boolean

Specify if the cursor can timeout.指定游标是否可以超时。

willRetryWrite?: boolean

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

Generated using TypeDoc