Interface for representing result sets as returned by execute().

Hierarchy

  • IResultSet

Properties

metaData: IMetaData[]

Contains an array of objects with metadata about the query.

Each column's name is always given. If extendedMetaData is true, additional information is included.

Methods

  • This function defines the default iterator for a result set that can be used to iterate over its rows. Using the default iterator, a result set can be iterated over using the for..of construct.

    Throws

    IError if the result set has already been closed

    Throws

    IError if the result set is already being iterated over

    Returns IterableIterator<any>

  • Closes a result set.

    Applications must always call this at the end of fetch or when no more rows are needed.

    It must also be called if no rows will ever be fetched from the result set.

    Returns any

  • This call fetches one row of the result set as an object or an array of column values, depending on the value of outFormat.

    At the end of fetching, the result set must be freed by calling close().

    Performance of getRow() can be tuned by adjusting the value of fetchArraySize.

    Returns any

  • This call fetches numRows rows of the result set as an object or an array of column values, depending on the value of outFormat.

    Parameters

    • numRows: number

      specifies the number of rows to be returned. the default value of numRows is 0 and it returns all rows.

      At the end of fetching, the result set must be freed by calling close().

      Performance of getRows() can be tuned by adjusting the value of fetchArraySize.

    Returns any[]

  • Convenience function for getting an iterator of this IResultSet.

    This is equivalent to calling rsSymbol.iterator.

    Returns

    an iterator over the rows of this IResultSet.

    Throws

    IError if the result set has already been closed

    Throws

    IError if the result set is already being iterated over

    Returns IterableIterator<any>