Class: SQLite3::ResultSet

Class | SQLite3::ResultSet
In: | lib/sqlite3/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 closed? columns each eof? new next reset types

### Included Modules

Enumerable

### Classes and Modules

Class SQLite3::ResultSet::ArrayWithTypes
Class SQLite3::ResultSet::ArrayWithTypesAndFields
Class SQLite3::ResultSet::HashWithTypes

### Public Class methods

new( db, stmt )

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

### Public Instance methods

close()

Closes the statement that spawned this result set. Use with caution! Closing a result set will automatically close any other result sets that were spawned from the same statement.

closed?()

Queries whether the underlying statement has been closed or not.

columns()

Returns the names of the columns returned by this result set.

each() {|row| ...}

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

eof?()

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

next()

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( *bind_params )

Reset the cursor, so that a result set which has reached end-of-file can be rewound and reiterated.

types()

Returns the types of the columns returned by this result set.

[Validate]