Class: SQLite3::ResultSet

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/sqlite3/resultset.rb

Overview

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.

Defined Under Namespace

Classes: ArrayWithTypes, ArrayWithTypesAndFields, HashWithTypesAndFields

Instance Method Summary collapse

Constructor Details

#initialize(db, stmt) ⇒ ResultSet

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



49
50
51
52
 
# File 'lib/sqlite3/resultset.rb', line 49

def initialize db, stmt
  @db   = db
  @stmt = stmt
end

Instance Method Details

#close ⇒ Object

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.



115
116
117
 
# File 'lib/sqlite3/resultset.rb', line 115

def close
  @stmt.close
end

#closed? ⇒ Boolean

Queries whether the underlying statement has been closed or not.

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/sqlite3/resultset.rb', line 120

def closed?
  @stmt.closed?
end

#columns ⇒ Object

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



131
132
133
134
 
# File 'lib/sqlite3/resultset.rb', line 131

def columns
  must_be_open!
  @stmt.columns
end

#each ⇒ Object

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



97
98
99
100
101
102
 
# File 'lib/sqlite3/resultset.rb', line 97

def each
  must_be_open!
  while node = self.next
    yield node
  end
end

#each_hash ⇒ Object

Provides an internal iterator over the rows of the result set where each row is yielded as a hash.



106
107
108
109
110
 
# File 'lib/sqlite3/resultset.rb', line 106

def each_hash
  while node = next_hash
    yield node
  end
end

#eof? ⇒ Boolean

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

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/sqlite3/resultset.rb', line 64

def eof?
  @stmt.done?
end

#next ⇒ Object

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.



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/sqlite3/resultset.rb', line 81

def next
  must_be_open!
  if @db.results_as_hash
    return next_hash
  end

  row = @stmt.step
  return nil if @stmt.done?
  row = ArrayWithTypesAndFields.new(row)
  row.fields = @stmt.columns
  row.types = @stmt.types
  row
end

#next_hash ⇒ Object

Return the next row as a hash



137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/sqlite3/resultset.rb', line 137

def next_hash
  must_be_open!
  row = @stmt.step
  return nil if @stmt.done?

  # FIXME: this can be switched to a regular hash in 2.0
  row = HashWithTypesAndFields[*@stmt.columns.zip(row).flatten]

  # FIXME: these methods are deprecated for version 2.0, so we can remove
  # this code in 2.0
  row.fields = @stmt.columns
  row.types = @stmt.types
  row
end

#reset(*bind_params) ⇒ Object

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



56
57
58
59
60
61
 
# File 'lib/sqlite3/resultset.rb', line 56

def reset( *bind_params )
  must_be_open!
  @stmt.reset!
  @stmt.bind_params( *bind_params )
  @eof = false
end

#types ⇒ Object

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



125
126
127
128
 
# File 'lib/sqlite3/resultset.rb', line 125

def types
  must_be_open!
  @stmt.types
end