Lightweight 0.20260303.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Lightweight::SqlResultCursor Class Reference

API for reading an SQL query result set. More...

#include <SqlStatement.hpp>

Public Member Functions

LIGHTWEIGHT_FORCE_INLINE SqlResultCursor (SqlStatement &stmt) noexcept
 Constructs a result cursor for the given SQL statement.
 
 SqlResultCursor (SqlResultCursor const &)=delete
 
SqlResultCursor & operator= (SqlResultCursor const &)=delete
 
constexpr SqlResultCursor (SqlResultCursor &&other) noexcept
 Move constructor.
 
constexpr SqlResultCursor & operator= (SqlResultCursor &&other) noexcept
 Move assignment operator.
 
LIGHTWEIGHT_FORCE_INLINE size_t NumRowsAffected () const
 Retrieves the number of rows affected by the last query.
 
LIGHTWEIGHT_FORCE_INLINE size_t NumColumnsAffected () const
 Retrieves the number of columns affected by the last query.
 
template<SqlOutputColumnBinder... Args>
LIGHTWEIGHT_FORCE_INLINE void BindOutputColumns (Args *... args)
 
template<SqlOutputColumnBinder T>
LIGHTWEIGHT_FORCE_INLINE void BindOutputColumn (SQLUSMALLINT columnIndex, T *arg)
 Binds a single output column at the given index to store fetched data.
 
LIGHTWEIGHT_FORCE_INLINE bool FetchRow ()
 Fetches the next row of the result set.
 
LIGHTWEIGHT_FORCE_INLINE std::expected< bool, SqlErrorInfo > TryFetchRow (std::source_location location=std::source_location::current()) noexcept
 Attempts to fetch the next row, returning an error info on failure instead of throwing.
 
template<typename... Records>
requires (((std::is_class_v<Records> && std::is_aggregate_v<Records>) && ...))
LIGHTWEIGHT_FORCE_INLINE void BindOutputColumnsToRecord (Records *... records)
 Binds the given records to the prepared statement to store the fetched data to.
 
template<SqlGetColumnNativeType T>
LIGHTWEIGHT_FORCE_INLINE bool GetColumn (SQLUSMALLINT column, T *result) const
 
template<SqlGetColumnNativeType T>
LIGHTWEIGHT_FORCE_INLINE T GetColumn (SQLUSMALLINT column) const
 Retrieves the value of the column at the given index for the currently selected row.
 
template<SqlGetColumnNativeType T>
LIGHTWEIGHT_FORCE_INLINE std::optional< T > GetNullableColumn (SQLUSMALLINT column) const
 
template<SqlGetColumnNativeType T>
T GetColumnOr (SQLUSMALLINT column, T &&defaultValue) const
 

Detailed Description

API for reading an SQL query result set.

Definition at line 274 of file SqlStatement.hpp.

Constructor & Destructor Documentation

◆ SqlResultCursor() [1/2]

LIGHTWEIGHT_FORCE_INLINE Lightweight::SqlResultCursor::SqlResultCursor ( SqlStatement &  stmt)
inlineexplicitnoexcept

Constructs a result cursor for the given SQL statement.

Definition at line 278 of file SqlStatement.hpp.

◆ SqlResultCursor() [2/2]

constexpr Lightweight::SqlResultCursor::SqlResultCursor ( SqlResultCursor &&  other)
inlineconstexprnoexcept

Move constructor.

Definition at line 288 of file SqlStatement.hpp.

◆ ~SqlResultCursor()

LIGHTWEIGHT_FORCE_INLINE Lightweight::SqlResultCursor::~SqlResultCursor ( )
inline

Definition at line 305 of file SqlStatement.hpp.

Member Function Documentation

◆ operator=()

constexpr SqlResultCursor & Lightweight::SqlResultCursor::operator= ( SqlResultCursor &&  other)
inlineconstexprnoexcept

Move assignment operator.

Definition at line 295 of file SqlStatement.hpp.

◆ NumRowsAffected()

LIGHTWEIGHT_FORCE_INLINE size_t Lightweight::SqlResultCursor::NumRowsAffected ( ) const
inline

Retrieves the number of rows affected by the last query.

Definition at line 315 of file SqlStatement.hpp.

Referenced by Lightweight::DataMapper::Delete().

◆ NumColumnsAffected()

LIGHTWEIGHT_FORCE_INLINE size_t Lightweight::SqlResultCursor::NumColumnsAffected ( ) const
inline

Retrieves the number of columns affected by the last query.

Definition at line 321 of file SqlStatement.hpp.

Referenced by Lightweight::DataMapper::Query().

◆ BindOutputColumns()

template<SqlOutputColumnBinder... Args>
LIGHTWEIGHT_FORCE_INLINE void Lightweight::SqlResultCursor::BindOutputColumns ( Args *...  args)
inline

Binds the given arguments to the prepared statement to store the fetched data to.

The statement must be prepared before calling this function.

Definition at line 330 of file SqlStatement.hpp.

◆ BindOutputColumn()

template<SqlOutputColumnBinder T>
LIGHTWEIGHT_FORCE_INLINE void Lightweight::SqlResultCursor::BindOutputColumn ( SQLUSMALLINT  columnIndex,
T *  arg 
)
inline

Binds a single output column at the given index to store fetched data.

Definition at line 337 of file SqlStatement.hpp.

◆ FetchRow()

LIGHTWEIGHT_FORCE_INLINE bool Lightweight::SqlResultCursor::FetchRow ( )
inline

Fetches the next row of the result set.

Definition at line 343 of file SqlStatement.hpp.

Referenced by Lightweight::DataMapper::ConfigureRelationAutoLoading(), and Lightweight::DataMapper::Query().

◆ TryFetchRow()

LIGHTWEIGHT_FORCE_INLINE std::expected< bool, SqlErrorInfo > Lightweight::SqlResultCursor::TryFetchRow ( std::source_location  location = std::source_location::current())
inlinenoexcept

Attempts to fetch the next row, returning an error info on failure instead of throwing.

Definition at line 349 of file SqlStatement.hpp.

◆ BindOutputColumnsToRecord()

template<typename... Records>
requires (((std::is_class_v<Records> && std::is_aggregate_v<Records>) && ...))
LIGHTWEIGHT_FORCE_INLINE void Lightweight::SqlResultCursor::BindOutputColumnsToRecord ( Records *...  records)
inline

Binds the given records to the prepared statement to store the fetched data to.

Definition at line 358 of file SqlStatement.hpp.

◆ GetColumn() [1/2]

template<SqlGetColumnNativeType T>
LIGHTWEIGHT_FORCE_INLINE bool Lightweight::SqlResultCursor::GetColumn ( SQLUSMALLINT  column,
T *  result 
) const
inline

Retrieves the value of the column at the given index for the currently selected row.

Returns true if the value is not NULL, false otherwise.

Definition at line 367 of file SqlStatement.hpp.

Referenced by Lightweight::DataMapper::ConfigureRelationAutoLoading(), and Lightweight::DataMapper::Query().

◆ GetColumn() [2/2]

template<SqlGetColumnNativeType T>
LIGHTWEIGHT_FORCE_INLINE T Lightweight::SqlResultCursor::GetColumn ( SQLUSMALLINT  column) const
inline

Retrieves the value of the column at the given index for the currently selected row.

Definition at line 374 of file SqlStatement.hpp.

◆ GetNullableColumn()

template<SqlGetColumnNativeType T>
LIGHTWEIGHT_FORCE_INLINE std::optional< T > Lightweight::SqlResultCursor::GetNullableColumn ( SQLUSMALLINT  column) const
inline

Retrieves the value of the column at the given index for the currently selected row.

If the value is NULL, std::nullopt is returned.

Definition at line 383 of file SqlStatement.hpp.

◆ GetColumnOr()

template<SqlGetColumnNativeType T>
T Lightweight::SqlResultCursor::GetColumnOr ( SQLUSMALLINT  column,
T &&  defaultValue 
) const
inline

Retrieves the value of the column at the given index for the currently selected row.

If the value is NULL, the given defaultValue is returned.

Definition at line 392 of file SqlStatement.hpp.

The documentation for this class was generated from the following file: