Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Cursor

A cursor that reads progressively rows from the database, it is useful for reading very large result sets.

Hierarchy

  • Cursor

Index

Methods

Methods

close

  • close(): PromiseLike<void>
  • close(completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

  • Like {@link Cursor#close} but with a completionHandler called when the cursor has been released.

    Returns PromiseLike<void>

  • Like {@link Cursor#close} but with a completionHandler called when the cursor has been released.

    Parameters

    • completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

    Returns void

hasMore

  • hasMore(): boolean

  • Returns true when the cursor has results in progress and the {@link Cursor#read} should be called to retrieve them.

    Returns boolean

isClosed

  • isClosed(): boolean

  • Returns boolean

read

  • read(count: number): PromiseLike<RowSet<Row>>
  • read(count: number, handler: ((res: AsyncResult<RowSet<Row>>) => void) | Handler<AsyncResult<RowSet<Row>>>): void

  • Read rows from the cursor, the result is provided asynchronously to the handler.

    Parameters

    • count: number

    Returns PromiseLike<RowSet<Row>>

  • Read rows from the cursor, the result is provided asynchronously to the handler.

    Parameters

    • count: number
    • handler: ((res: AsyncResult<RowSet<Row>>) => void) | Handler<AsyncResult<RowSet<Row>>>

    Returns void

Generated using TypeDoc