Class SQLite::ResultSet
In: lib/sqlite/resultset.rb
Parent: Object

The ResultSet object encapsulates the enumerability of a query‘s output. It is a simple cursor over the data that the query returns. It will very rarely (if ever) be instantiated directly. Instead, client‘s should obtain a ResultSet instance via Statement#execute.

Methods

close   each   eof?   new   next   reset  

Included Modules

Enumerable

Classes and Modules

Module SQLite::ResultSet::FieldsContainer
Module SQLite::ResultSet::TypesContainer

Attributes

columns  [R]  An array of the column names for this result set (may be empty)
types  [R]  An array of the column types for this result set (may be empty)

Public Class methods

Create a new ResultSet attached to the given database, using the given sql text.

Public Instance methods

Close the result set. Attempting to perform any operation (including close) on a closed result set will have undefined results.

Required by the Enumerable mixin. Provides an internal iterator over the rows of the result set.

Query whether the cursor has reached the end of the result set or not.

Obtain the next row from the cursor. If there are no more rows to be had, this will return nil. If type translation is active on the corresponding database, the values in the row will be translated according to their types.

The returned value will be an array, unless Database#results_as_hash has been set to true, in which case the returned value will be a hash.

For arrays, the column names are accessible via the fields property, and the column types are accessible via the types property.

For hashes, the column names are the keys of the hash, and the column types are accessible via the types property.

Reset the cursor, so that a result set which has reached end-of-file can be rewound and reiterated. Note: this uses an experimental API, which is subject to change. Use at your own risk.

[Validate]