class SQLite3::ResultSet

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 SQLite3::Statement#execute.

Public Class Methods

new(db, stmt) click to toggle source

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

# File lib/sqlite3/resultset.rb, line 34
def initialize db, stmt
  @db   = db
  @stmt = stmt
end

Public Instance Methods

close() click to toggle source

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.

# File lib/sqlite3/resultset.rb, line 105
def close
  @stmt.close
end
closed?() click to toggle source

Queries whether the underlying statement has been closed or not.

# File lib/sqlite3/resultset.rb, line 110
def closed?
  @stmt.closed?
end
columns() click to toggle source

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

# File lib/sqlite3/resultset.rb, line 120
def columns
  @stmt.columns
end
each( ) { |node| ... } click to toggle source

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

# File lib/sqlite3/resultset.rb, line 96
def each( &block )
  while node = self.next
    yield node
  end
end
eof?() click to toggle source

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

# File lib/sqlite3/resultset.rb, line 48
def eof?
  @stmt.done?
end
next() click to toggle source

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 SQLite3::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.

# File lib/sqlite3/resultset.rb, line 65
def next
  row = @stmt.step
  return nil if @stmt.done?

  if @db.type_translation
    row = @stmt.types.zip(row).map do |type, value|
      @db.translator.translate( type, value )
    end
  end

  if @db.results_as_hash
    new_row = HashWithTypes[*@stmt.columns.zip(row).flatten]
    row.each_with_index { |value,idx|
      new_row[idx] = value
    }
    row = new_row
  else
    if row.respond_to?(:fields)
      row = ArrayWithTypes.new(row)
    else
      row = ArrayWithTypesAndFields.new(row)
    end
    row.fields = @stmt.columns
  end

  row.types = @stmt.types
  row
end
reset( *bind_params ) click to toggle source

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

# File lib/sqlite3/resultset.rb, line 41
def reset( *bind_params )
  @stmt.reset!
  @stmt.bind_params( *bind_params )
  @eof = false
end
types() click to toggle source

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

# File lib/sqlite3/resultset.rb, line 115
def types
  @stmt.types
end