#include <DatabaseResultSet.hpp>
Inheritance diagram for ledger::core::api::DatabaseResultSet:
Public Member Functions | |
| virtual std::shared_ptr< DatabaseResultRow > | getRow ()=0 |
| virtual int32_t | getUpdateCount ()=0 |
| virtual bool | hasNext ()=0 |
| virtual int32_t | available ()=0 |
| virtual void | next ()=0 |
| virtual void | close ()=0 |
| virtual std::shared_ptr< DatabaseError > | getError ()=0 |
Detailed Description
ResultSet is a cursor over a query result. It allows user to iterate through query rows. When you start iterating through result the cursor is placed before the first element of the set.
Member Function Documentation
◆ available()
|
pure virtual |
Returns the number of remaining rows before the result set needs to load more rows
- Returns
- The number of remaining rows before the result set needs to load more rows.
Implemented in Results.
◆ close()
|
pure virtual |
Close the result set.
Implemented in Results.
◆ getError()
|
pure virtual |
Get the last error that occured on the database.
Implemented in Results.
◆ getRow()
|
pure virtual |
Retrieve the current row pointed by the DatabaseResultSet. Return null if there is no row to retrieve.
- Returns
- The current row
Implemented in Results.
◆ getUpdateCount()
|
pure virtual |
Get the number of rows updated by the query (UPDATE, INSERT, DELETE...)
Implemented in Results.
◆ hasNext()
|
pure virtual |
Returns true if the result set has at least one remaining row to get.
- Returns
- true if the result set has at least one remaining row to get, false otherwise.
Implemented in Results.
◆ next()
|
pure virtual |
Internally move the result set to the next available row. This method may fail if there is no further row to fetch.
- Returns
- Return a result set pointing to the next row.
Implemented in Results.
The documentation for this class was generated from the following file:
- src/api/DatabaseResultSet.hpp
