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, clients should obtain a ResultSet instance via Statement#execute.

Public Class Methods

new (db, stmt)

Source

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

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

Public Instance Methods

close ()

Source

# File lib/sqlite3/resultset.rb, line 75
def close
  @stmt.close
end

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? ()

Source

# File lib/sqlite3/resultset.rb, line 80
def closed?
  @stmt.closed?
end

Queries whether the underlying statement has been closed or not.

columns ()

Source

# File lib/sqlite3/resultset.rb, line 90
def columns
  @stmt.columns
end

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

each () { |node| ... }

Source

# File lib/sqlite3/resultset.rb, line 53
def each
  return enum_for(__method__) unless block_given?
  while (node = self.next)
    yield node
  end
  self
end

With a block given, iterates over the rows of the result set, passing each to the block. Returns self. With no block given, returns a new Enumerator.

each_hash () { |node| ... }

Source

# File lib/sqlite3/resultset.rb, line 64
def each_hash
  return enum_for(__method__) unless block_given?
  while (node = next_hash)
    yield node
  end
  self
end

With a block given, iterates over the rows of the result set, passing each to the block as a hash. Returns self. With no block given, returns a new Enumerator.

eof? ()

Source

# File lib/sqlite3/resultset.rb, line 31
def eof?
  @stmt.done?
end

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

next ()

Source

# File lib/sqlite3/resultset.rb, line 46
def next
  @stmt.step
end

Obtain the next row from the cursor. If there are no more rows to be had, this will return nil.

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.

next_hash ()

Source

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

  @stmt.columns.zip(row).to_h
end

Return the next row as a hash

reset (*bind_params)

Source

# File lib/sqlite3/resultset.rb, line 25
def reset(*bind_params)
  @stmt.reset!
  @stmt.bind_params(*bind_params)
end

Resets the cursor to the first row, so that you can iterate over the result set again after it reaches the end.

This method binds each argument to the statement with Statement#bind_params. The values that you bound before stay bound unless you bind new values to the same parameters.

types ()

Source

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

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