Class Result

A class representing a fully buffered set of results returned from QLDB.

Hierarchy

  • Result

Constructors

constructor

Properties

_ioUsage _resultList _timingInformation

Methods

getConsumedIOs getResultList getTimingInformation _fetchResultPages _readResultReadable bufferResultReadable

Constructors

Private constructor

  • Creates a Result.

    Parameters

    • resultList: Value[]

      A list of Ion values containing the statement execution's result returned from QLDB.

    • ioUsage: IOUsage

      Contains the number of consumed IO requests for the executed statement.

    • timingInformation: TimingInformation

      Holds server side processing time for the executed statement.

    Returns Result

Properties

Private _ioUsage

_ioUsage: IOUsage

Private _resultList

_resultList: Value[]

Private _timingInformation

_timingInformation: TimingInformation

Methods

getConsumedIOs

  • Returns the number of read IO request for the executed statement.

    Returns

    IOUsage, containing number of read IOs.

    Returns IOUsage

getResultList

  • Returns the list of results of the statement execution returned from QLDB.

    Returns

    A list of Ion values which wrap the Ion values returned from the QLDB statement execution.

    Returns Value[]

getTimingInformation

Static Private _fetchResultPages

  • _fetchResultPages(txnId: string, executeResult: ExecuteStatementResult, communicator: Communicator): Promise<Result>

  • Fetches all subsequent Pages given an initial Page, places each value of each Page in an Ion value.

    Returns

    Promise which fulfills with a Result, containing a list of Ion values, representing all the returned values of the result set, number of IOs for the request, and the time spent processing the request.

    Parameters

    • txnId: string

      The ID of the transaction the statement was executed in.

    • executeResult: ExecuteStatementResult

      The returned result from the statement execution.

    • communicator: Communicator

      The Communicator used for the statement execution.

    Returns Promise<Result>

Static Private _readResultReadable

  • _readResultReadable(resultReadable: ResultReadable): Promise<Value[]>

  • Helper method that reads a ResultReadable and extracts the results, placing them in an array of Ion values.

    Returns

    Promise which fulfills with a list of Ion values, representing all the returned values of the result set.

    Parameters

    Returns Promise<Value[]>

Static bufferResultReadable

  • Static method that creates a Result object by reading and buffering the contents of a ResultReadable.

    Returns

    Promise which fulfills with a Result.

    Parameters

    • resultReadable: ResultReadable

      A ResultReadable object to convert to a Result object.

    Returns Promise<Result>

Settings

Member Visibility

Theme

Generated using TypeDoc