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.
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 @driver = @db.driver @stmt = stmt commence 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.
# File lib/sqlite3/resultset.rb, line 159 def close @stmt.close end
Queries whether the underlying statement has been closed or not.
# File lib/sqlite3/resultset.rb, line 164 def closed? @stmt.closed? end
Returns the names of the columns returned by this result set.
# File lib/sqlite3/resultset.rb, line 174 def columns @stmt.columns end
Required by the Enumerable mixin. Provides an internal iterator over the rows of the result set.
# File lib/sqlite3/resultset.rb, line 150 def each while row=self.next yield row end end
Query whether the cursor has reached the end of the result set or not.
# File lib/sqlite3/resultset.rb, line 72 def eof? @eof end
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.
# File lib/sqlite3/resultset.rb, line 89 def next return nil if @eof @stmt.must_be_open! unless @first_row result = @driver.step( @stmt.handle ) check result end @first_row = false unless @eof row = [] @driver.data_count( @stmt.handle ).times do |column| type = @driver.column_type( @stmt.handle, column ) if type == Constants::ColumnType::TEXT row << @driver.column_text( @stmt.handle, column ) elsif type == Constants::ColumnType::NULL row << nil elsif type == Constants::ColumnType::BLOB row << @driver.column_blob( @stmt.handle, column ) else row << @driver.column_text( @stmt.handle, column ) end end 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 ).to_a.flatten ) ] row.each_with_index { |value,idx| value.taint 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 row.each { |column| column.taint } end row.types = @stmt.types return row end nil end
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 62 def reset( *bind_params ) @stmt.must_be_open! @stmt.reset!(false) @driver.reset( @stmt.handle ) @stmt.bind_params( *bind_params ) @eof = false commence end
Generated with the Darkfish Rdoc Generator 2.