fbcpp::StatementOptions Class Reference

Represents options used when preparing a Statement. More...

#include <Statement.h>

Public Member Functions
bool	getPrefetchLegacyPlan () const
	Reports whether the legacy textual plan should be prefetched during prepare.
StatementOptions &	setPrefetchLegacyPlan (bool value)
	Enables or disables prefetching of the legacy textual plan at prepare time.
bool	getPrefetchPlan () const
	Reports whether the structured plan should be prefetched during prepare.
StatementOptions &	setPrefetchPlan (bool value)
	Enables or disables prefetching of the structured plan at prepare time.
const std::optional< std::string > &	getCursorName () const
	Returns the cursor name to be set for the statement.
StatementOptions &	setCursorName (const std::string &value)
	Sets the cursor name for the statement.
CursorType	getCursorType () const
	Returns the cursor type to be used when opening a result set.
StatementOptions &	setCursorType (CursorType value)
	Sets the cursor type used when opening a result set.
unsigned	getDialect () const
	Returns the SQL dialect used when preparing the statement.
StatementOptions &	setDialect (unsigned value)
	Sets the SQL dialect used when preparing the statement.

Detailed Description

Represents options used when preparing a Statement.

Definition at line 88 of file Statement.h.

Member Function Documentation

getCursorName()

const std::optional< std::string > & fbcpp::StatementOptions::getCursorName ( ) const

inline

Returns the cursor name to be set for the statement.

Definition at line 132 of file Statement.h.

getCursorType()

CursorType fbcpp::StatementOptions::getCursorType ( ) const

inline

Returns the cursor type to be used when opening a result set.

Definition at line 151 of file Statement.h.

getDialect()

unsigned fbcpp::StatementOptions::getDialect ( ) const

inline

Returns the SQL dialect used when preparing the statement.

Definition at line 170 of file Statement.h.

getPrefetchLegacyPlan()

bool fbcpp::StatementOptions::getPrefetchLegacyPlan ( ) const

inline

Reports whether the legacy textual plan should be prefetched during prepare.

Definition at line 94 of file Statement.h.

getPrefetchPlan()

bool fbcpp::StatementOptions::getPrefetchPlan ( ) const

inline

Reports whether the structured plan should be prefetched during prepare.

Definition at line 113 of file Statement.h.

setCursorName()

StatementOptions & fbcpp::StatementOptions::setCursorName ( const std::string &  value )

inline

Sets the cursor name for the statement.

Parameters

value

The name of the cursor.

Returns

Reference to this instance for fluent configuration.

Definition at line 142 of file Statement.h.

setCursorType()

StatementOptions & fbcpp::StatementOptions::setCursorType ( CursorType  value )

inline

Sets the cursor type used when opening a result set.

Parameters

value

FORWARD_ONLY for streaming access, SCROLLABLE for bidirectional navigation.

Returns

Reference to this instance for fluent configuration.

Definition at line 161 of file Statement.h.

setDialect()

StatementOptions & fbcpp::StatementOptions::setDialect ( unsigned  value )

inline

Sets the SQL dialect used when preparing the statement.

Parameters

value

SQL dialect number (1 for InterBase compatibility, 3 for current).

Returns

Reference to this instance for fluent configuration.

Definition at line 180 of file Statement.h.

setPrefetchLegacyPlan()

StatementOptions & fbcpp::StatementOptions::setPrefetchLegacyPlan ( bool  value )

inline

Enables or disables prefetching of the legacy textual plan at prepare time.

Parameters

value

true to prefetch the legacy plan, false to skip it.

Returns

Reference to this instance for fluent configuration.

Definition at line 104 of file Statement.h.

setPrefetchPlan()

StatementOptions & fbcpp::StatementOptions::setPrefetchPlan ( bool  value )

inline

Enables or disables prefetching of the structured plan at prepare time.

Parameters

value

true to prefetch the optimized plan, false to skip it.

Returns

Reference to this instance for fluent configuration.

Definition at line 123 of file Statement.h.

---

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

• src/fb-cpp/Statement.h