Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FindCursor<TSchema>

(?<=)Type parameters类型参数

Hierarchy层级

Index索引

Constructors构造函数

constructor

Events事件

Static Readonly CLOSE

CLOSE: "close" = ...

Properties属性

[kBuiltOptions]

[kBuiltOptions]: FindOptions<Document>
internal

[kClosed]

[kClosed]: boolean
internal

[kDocuments]

[kDocuments]: TSchema[]
internal

[kFilter]

[kFilter]: Document
internal

Optional [kId]

[kId]: Long
internal

[kInitialized]

[kInitialized]: boolean
internal

[kKilled]

[kKilled]: boolean
internal

[kNamespace]

[kNamespace]: MongoDBNamespace
internal

Optional [kNumReturned]

[kNumReturned]: number
internal

[kOptions]

internal

Optional [kServer]

[kServer]: Server
internal

Optional [kSession]

[kSession]: ClientSession
internal

[kTopology]

[kTopology]: Topology
internal

Optional [kTransform]

[kTransform]: (doc: TSchema) => Document
internal

Type declaration类型声明

    • internal

      Parameters参数

      • doc: TSchema

      Returns返回Document

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.设置或获取所有发射器的默认captureRejection值。

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. 此符号应用于安装仅用于监控'error'事件的侦听器。Listeners installed using this symbol are called before the regular 'error' listeners are called.在调用常规'error'侦听器之前,将调用使用此符号安装的侦听器。

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.使用此符号安装侦听器不会在发出'error'事件后更改行为,因此如果未安装常规的'error'侦听器,进程仍将崩溃。

Accessors访问器

closed

  • get closed(): boolean

cursorOptions

id

  • get id(): undefined | Long

killed

  • get killed(): boolean

loadBalanced

  • get loadBalanced(): boolean

namespace

readConcern

readPreference

server

  • get server(): undefined | Server

session

topology

Methods方法

[asyncIterator]

  • [asyncIterator](): AsyncIterator<TSchema, void, undefined>

_getMore

_initialize

addCursorFlag

  • addCursorFlag(flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial", value: boolean): FindCursor<TSchema>
  • Add a cursor flag to the cursor向游标添加游标标志

    Parameters参数

    • flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial"

      The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.要设置的标志必须是以下标志之一['tailable'、'oplogReplay'、'noCursorTimeout'、'waitdata'、'partial'-。

    • value: boolean

      The flag boolean value.标志布尔值。

    Returns返回FindCursor<TSchema>

addListener

addQueryModifier

  • addQueryModifier(name: string, value: string | number | boolean | Document): FindCursor<TSchema>
  • Add a query modifier to the cursor query向游标查询添加查询修饰符

    Parameters参数

    • name: string

      The query modifier (must start with $, such as $orderby etc)查询修饰符(必须以$开头,如$orderby等)

    • value: string | number | boolean | Document

      The modifier value.修饰符值。

    Returns返回FindCursor<TSchema>

allowDiskUse

batchSize

bufferedCount

  • bufferedCount(): number

clone

  • Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance返回此游标的新未初始化副本,其选项与在当前实例上设置的选项匹配

    Returns返回FindCursor<TSchema>

close

collation

  • Set the collation options for the cursor.设置游标的排序规则选项。

    Parameters参数

    • value: CollationOptions

      The cursor collation options (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).更新操作的游标排序选项(MongoDB 3.4或更高版本)设置(有关可用字段,请参阅3.4文档)。

    Returns返回FindCursor<TSchema>

comment

  • Add a comment to the cursor query allowing for tracking the comment in the log.向游标查询添加注释,以便跟踪日志中的注释。

    Parameters参数

    • value: string

      The comment attached to this query.附加到此查询的注释。

    Returns返回FindCursor<TSchema>

count

emit

  • emit<EventKey>(event: symbol | EventKey, ...args: Parameters<AbstractCursorEvents[EventKey]>): boolean

eventNames

  • eventNames(): string[]

explain

filter

forEach

  • forEach(iterator: (doc: TSchema) => boolean | void): Promise<void>
  • forEach(iterator: (doc: TSchema) => boolean | void, callback: Callback<void>): void
  • Iterates over all the documents for this cursor using the iterator, callback pattern.使用迭代器回调模式迭代此游标的所有文档。

    Parameters参数

    • iterator: (doc: TSchema) => boolean | void

      The iteration callback.迭代回调。

        • (doc: TSchema): boolean | void
        • Parameters参数

          • doc: TSchema

          Returns返回boolean | void

    Returns返回Promise<void>

  • Parameters参数

    • iterator: (doc: TSchema) => boolean | void
        • (doc: TSchema): boolean | void
        • Parameters参数

          • doc: TSchema

          Returns返回boolean | void

    • callback: Callback<void>

    Returns返回void

getMaxListeners

  • getMaxListeners(): number

hasNext

  • hasNext(): Promise<boolean>
  • hasNext(callback: Callback<boolean>): void

hint

  • Set the cursor hint设置游标提示

    Parameters参数

    • hint: Hint

      If specified, then the query system will only consider plans using the hinted index.如果指定,那么查询系统将只考虑使用暗示索引的计划。

    Returns返回FindCursor<TSchema>

limit

  • Set the limit for the cursor.设置游标的限制。

    Parameters参数

    • value: number

      The limit for the cursor query.游标查询的限制。

    Returns返回FindCursor<TSchema>

listenerCount

  • listenerCount<EventKey>(type: string | symbol | EventKey): number

listeners

map

  • map<T>(transform: (doc: TSchema) => T): FindCursor<T>
  • Map all documents using the provided function If there is a transform set on the cursor, that will be called first and the result passed to this function's transform.如果游标上有一个转换集,则使用提供的函数映射所有文档,该转换集将首先被调用,并将结果传递给该函数的转换。

    remarks

    Note for Typescript Users:Typescript用户注意: adding a transform changes the return type of the iteration of this cursor, it does not return a new instance of a cursor. 添加转换会更改此游标迭代的返回类型,但不会返回游标的新实例。This means when calling map, you should always assign the result to a new variable in order to get a correctly typed cursor variable. 这意味着在调用map时,应该始终将结果分配给一个新变量,以便获得正确类型的游标变量。Take note of the following example:请注意以下示例:

    Type parameters类型参数

    • T

    Parameters参数

    • transform: (doc: TSchema) => T
        • (doc: TSchema): T
        • Parameters参数

          • doc: TSchema

          Returns返回T

    Returns返回FindCursor<T>

max

  • Set the cursor max将游标设置为最大值

    Parameters参数

    • max: Document

      Specify a $max value to specify the exclusive upper bound for a specific index in order to constrain the results of find(). 指定$max值以指定特定索引的独占上限,以约束find()的结果。The $max specifies the upper bound for all keys of a specific index in order.$max按顺序指定特定索引的所有键的上限。

    Returns返回FindCursor<TSchema>

maxAwaitTimeMS

  • maxAwaitTimeMS(value: number): FindCursor<TSchema>
  • Set a maxAwaitTimeMS on a tailing cursor query to allow to customize the timeout value for the option awaitData (Only supported on MongoDB 3.2 or higher, ignored otherwise)在跟踪游标查询上设置maxAwaitTimeMS,以允许自定义选项awaitData的超时值(仅在MongoDB 3.2或更高版本上受支持,否则将被忽略)

    Parameters参数

    • value: number

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

    Returns返回FindCursor<TSchema>

maxTimeMS

  • Set a maxTimeMS on the cursor query, allowing for hard timeout limits on queries (Only supported on MongoDB 2.6 or higher)在游标查询上设置maxTimeMS,允许对查询进行硬超时限制(仅MongoDB 2.6或更高版本支持)

    Parameters参数

    • value: number

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

    Returns返回FindCursor<TSchema>

min

  • Set the cursor min将游标设置为min

    Parameters参数

    • min: Document

      Specify a $min value to specify the inclusive lower bound for a specific index in order to constrain the results of find(). 指定$min值以指定特定索引的包含下限,以约束find()的结果。The $min specifies the lower bound for all keys of a specific index in order.$min按顺序指定特定索引的所有键的下限。

    Returns返回FindCursor<TSchema>

next

  • next(): Promise<null | TSchema>
  • next(callback: Callback<null | TSchema>): void
  • next(callback?: Callback<null | TSchema>): void | Promise<null | TSchema>

off

on

once

prependListener

prependOnceListener

project

  • Add a project stage to the aggregation pipeline将项目阶段添加到聚合管道

    remarks

    In order to strictly type this function you must provide an interface that represents the effect of your projection on the result documents.为了严格地键入此函数,您必须提供一个接口来表示投影对结果文档的影响。

    By default chaining a projection to your cursor changes the returned type to the generic Document type. 默认情况下,将投影链接到光标会将返回的类型更改为通用Document类型。You should specify a parameterized type to have assertions on your final results.您应该指定一个参数化类型,以便对最终结果进行断言。

    example
    // Best way
    const docs: FindCursor<{ a: number }> = cursor.project<{ a: number }>({ _id: 0, a: true });
    // Flexible way
    const docs: FindCursor<Document> = cursor.project({ _id: 0, a: true });
    
    remarks

    Note for Typescript Users:Typescript用户注意: adding a transform changes the return type of the iteration of this cursor, it does not return a new instance of a cursor. 添加变换会更改此游标迭代的返回类型,但不会返回游标的新实例。This means when calling project, you should always assign the result to a new variable in order to get a correctly typed cursor variable. 这意味着在调用project时,应始终将结果分配给新变量,以便获得正确类型的游标变量。Take note of the following example:请注意以下示例:

    example
    const cursor: FindCursor<{ a: number; b: string }> = coll.find();
    const projectCursor = cursor.project<{ a: number }>({ _id: 0, a: true });
    const aPropOnlyArray: {a: number}[] = await projectCursor.toArray();
    // or always use chaining and save the final cursor
    const cursor = coll.find().project<{ a: string }>({
      _id: 0,
      a: { $convert: { input: '$a', to: 'string' }
    }});
    

    Type parameters类型参数

    Parameters参数

    Returns返回FindCursor<T>

rawListeners

readBufferedDocuments

  • readBufferedDocuments(number?: number): TSchema[]

removeAllListeners

  • removeAllListeners<EventKey>(event?: string | symbol | EventKey): FindCursor<TSchema>

removeListener

returnKey

  • Set the cursor returnKey. 设置游标返回键。If set to true, modifies the cursor to only return the index field or fields for the results of the query, rather than documents. 如果设置为true,则修改游标以仅返回查询结果的索引字段,而不是文档。If set to true and the query does not use an index to perform the read operation, the returned documents will not contain any fields.如果设置为true且查询不使用索引执行读取操作,则返回的文档将不包含任何字段。

    Parameters参数

    • value: boolean

      the returnKey value.返回键值。

    Returns返回FindCursor<TSchema>

rewind

  • rewind(): void
  • Rewind this cursor to its uninitialized state. 将游标倒回其未初始化状态。Any options that are present on the cursor will remain in effect. 游标上的任何选项都将保持有效。Iterating this cursor will cause new queries to be sent to the server, even if the resultant data has already been retrieved by this cursor.迭代此游标将导致向服务器发送新的查询,即使结果数据已被此游标检索。

    Returns返回void

setMaxListeners

showRecordId

  • showRecordId(value: boolean): FindCursor<TSchema>
  • Modifies the output of a query by adding a field $recordId to matching documents. 通过向匹配文档添加字段$recordId来修改查询的输出。$recordId is the internal key which uniquely identifies a document in a collection.$recordId是唯一标识集合中文档的内部键。

    Parameters参数

    • value: boolean

      The $showDiskLoc option has now been deprecated and replaced with the showRecordId field. $showDiskLoc选项现已被弃用,并替换为showRecordId字段。$showDiskLoc will still be accepted for OP_QUERY stye find.$showDiskLoc仍将被接受用于操作查询查找。

    Returns返回FindCursor<TSchema>

skip

  • Set the skip for the cursor.设置游标的跳过。

    Parameters参数

    • value: number

      The skip for the cursor query.游标查询的跳过。

    Returns返回FindCursor<TSchema>

sort

  • Sets the sort order of the cursor query.设置游标查询的排序顺序。

    Parameters参数

    • sort: Sort

      The key or keys set for the sort.为排序设置的一个或多个键。

    • Optional direction: SortDirection

      The direction of the sorting (1 or -1).排序的方向(1或-1)。

    Returns返回FindCursor<TSchema>

stream

toArray

  • toArray(): Promise<TSchema[]>
  • toArray(callback: Callback<TSchema[]>): void
  • Returns an array of documents. 返回一个文档数组。The caller is responsible for making sure that there is enough memory to store the results. 调用者负责确保有足够的内存来存储结果。Note that the array only contains partial results when this cursor had been previously accessed. 请注意,当以前访问过此游标时,数组仅包含部分结果。In that case, cursor.rewind() can be used to reset the cursor.在这种情况下,可以使用cursor.rewind()重置游标。

    Returns返回Promise<TSchema[]>

  • Parameters参数

    Returns返回void

tryNext

  • tryNext(): Promise<null | TSchema>
  • tryNext(callback: Callback<null | TSchema>): void

withReadConcern

withReadPreference

Static getEventListener

  • getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]
  • Returns a list listener for a specific emitter event name.返回特定发射器事件名称的列表侦听器。

    Parameters参数

    • emitter: DOMEventTarget | EventEmitter
    • name: string | symbol

    Returns返回Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters参数

    • emitter: EventEmitter
    • event: string | symbol

    Returns返回number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • Parameters参数

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns返回AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>
  • Parameters参数

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns返回Promise<any[]>

  • Parameters参数

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns返回Promise<any[]>

Generated using TypeDoc