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<typename Record , typename... ColumnAccessors>
LIGHTWEIGHT_FORCE_INLINE void	FetchAllRowWise (std::vector< Record > &out, std::size_t arrayDepth, ColumnAccessors const &... accessors)
	Fast bulk retrieval: materializes this result set into `out` via native ODBC row-wise array fetch. Forwards to `SqlStatement::FetchAllRowWise`; see its contract (eligibility and alignment preconditions are the caller's responsibility).

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 467 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 471 of file SqlStatement.hpp.

◆ SqlResultCursor() [2/2]

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

inlineconstexprnoexcept

Move constructor.

Definition at line 481 of file SqlStatement.hpp.

◆ ~SqlResultCursor()

LIGHTWEIGHT_FORCE_INLINE Lightweight::SqlResultCursor::~SqlResultCursor ( )

inline

Definition at line 498 of file SqlStatement.hpp.

Member Function Documentation

◆ operator=()

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

inlineconstexprnoexcept

Move assignment operator.

Definition at line 488 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 508 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 514 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 523 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 530 of file SqlStatement.hpp.

◆ FetchRow()

LIGHTWEIGHT_FORCE_INLINE bool Lightweight::SqlResultCursor::FetchRow ( )

inline

Fetches the next row of the result set.

Definition at line 536 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 542 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 551 of file SqlStatement.hpp.

◆ FetchAllRowWise()

template<typename Record , typename... ColumnAccessors>

LIGHTWEIGHT_FORCE_INLINE void Lightweight::SqlResultCursor::FetchAllRowWise	(	std::vector< Record > &	out,
		std::size_t	arrayDepth,
		ColumnAccessors const &...	accessors
	)

inline

Fast bulk retrieval: materializes this result set into out via native ODBC row-wise array fetch. Forwards to SqlStatement::FetchAllRowWise; see its contract (eligibility and alignment preconditions are the caller's responsibility).

Parameters

out	Destination vector; results are appended.
arrayDepth	Requested maximum rows per `SQLFetchScroll` round-trip.
accessors	One invocable per result column; `accessor(record)` yields its mutable value.

Definition at line 563 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 574 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 581 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 590 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 599 of file SqlStatement.hpp.

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

Lightweight/SqlStatement.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SqlResultCursor() [1/2]

◆ SqlResultCursor() [2/2]

◆ ~SqlResultCursor()

Member Function Documentation

◆ operator=()

◆ NumRowsAffected()

◆ NumColumnsAffected()

◆ BindOutputColumns()

◆ BindOutputColumn()

◆ FetchRow()

◆ TryFetchRow()

◆ BindOutputColumnsToRecord()

◆ FetchAllRowWise()

◆ GetColumn() [1/2]

◆ GetColumn() [2/2]

◆ GetNullableColumn()

◆ GetColumnOr()