StormByte-Database 3.0.0
C++26 database module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Database::Postgres::PreparedSTMT Class Referencefinal

PostgreSQL prepared statement (PQexecPrepared). More...

#include <StormByte/database/postgres/prepared_stmt.hxx>

Inheritance diagram for StormByte::Database::Postgres::PreparedSTMT:
Collaboration diagram for StormByte::Database::Postgres::PreparedSTMT:

Public Member Functions

 PreparedSTMT (const PreparedSTMT &other)=delete
 Copy constructor (deleted).
 PreparedSTMT (PreparedSTMT &&other) noexcept
 Move constructor.
 ~PreparedSTMT () noexcept override
 Destructor.
PreparedSTMT & operator= (const PreparedSTMT &other)=delete
 Copy assignment (deleted).
PreparedSTMT & operator= (PreparedSTMT &&other) noexcept
 Move assignment.
 PreparedSTMT (ConstructionKey key, std::string_view name, std::string_view query, const StormByte::Safe::Shared< Logger::Log > &logger, const StormByte::Safe::Shared< StormByte::Database::Telemetry > &telemetry)
 Construct a PostgreSQL statement through its backend factory.
Public Member Functions inherited from StormByte::Database::PreparedSTMT
 PreparedSTMT (std::string_view name, std::string_view query, const StormByte::Safe::Shared< Logger::Log > &logger)
 Copy name, query and logger.
 PreparedSTMT (std::string_view name, std::string_view query, const StormByte::Safe::Shared< Logger::Log > &logger, const StormByte::Safe::Shared< Telemetry > &telemetry)
 Copy statement metadata and share connection telemetry.
 PreparedSTMT (const PreparedSTMT &other)=delete
 Copy constructor (deleted).
 PreparedSTMT (PreparedSTMT &&other) noexcept
 Move constructor.
PreparedSTMT & operator= (const PreparedSTMT &other)=delete
 Copy assignment (deleted).
PreparedSTMT & operator= (PreparedSTMT &&other) noexcept
 Move assignment.
template<typename... Args>
ExpectedRows Execute (Args &&...args)
 Bind arguments and execute.
std::string_view Name () const noexcept
 Statement name.
std::string_view Query () const noexcept
 SQL text.

Friends

class Postgres

Additional Inherited Members

Protected Member Functions inherited from StormByte::Database::PreparedSTMT
void RecordBackendEvent (BackendEvent event) noexcept
 Record a backend event against the owning connection.
template<typename T>
void Bind (StormByte::Size index, T &&value) noexcept
 Bind a value at index.
void Bind (StormByte::Size index, std::nullptr_t) noexcept
 Bind SQL NULL at index.
Protected Attributes inherited from StormByte::Database::PreparedSTMT
StormByte::Safe::Shared< Logger::Log > m_logger
 Shared logger, safe across the DLL boundary.
StormByte::Safe::Shared< Telemetry > m_telemetry
 Shared connection telemetry.

Detailed Description

PostgreSQL prepared statement (PQexecPrepared).

Constructor & Destructor Documentation

◆ PreparedSTMT() [1/3]

StormByte::Database::Postgres::PreparedSTMT::PreparedSTMT ( const PreparedSTMT & other)
delete

Copy constructor (deleted).

◆ PreparedSTMT() [2/3]

StormByte::Database::Postgres::PreparedSTMT::PreparedSTMT ( PreparedSTMT && other)
noexcept

Move constructor.

◆ ~PreparedSTMT()

StormByte::Database::Postgres::PreparedSTMT::~PreparedSTMT ( )
overridevirtualnoexcept

Destructor.

Reimplemented from StormByte::Database::PreparedSTMT.

◆ PreparedSTMT() [3/3]

StormByte::Database::Postgres::PreparedSTMT::PreparedSTMT ( ConstructionKey key,
std::string_view name,
std::string_view query,
const StormByte::Safe::Shared< Logger::Log > & logger,
const StormByte::Safe::Shared< StormByte::Database::Telemetry > & telemetry )

Construct a PostgreSQL statement through its backend factory.

Parameters
keyInternal construction key.
nameStatement name.
querySQL text.
loggerNon-owning logger observer.
telemetryShared operation telemetry.

Member Function Documentation

◆ operator=() [1/2]

PreparedSTMT & StormByte::Database::Postgres::PreparedSTMT::operator= ( const PreparedSTMT & other)
delete

Copy assignment (deleted).

◆ operator=() [2/2]

PreparedSTMT & StormByte::Database::Postgres::PreparedSTMT::operator= ( PreparedSTMT && other)
noexcept

Move assignment.

◆ Postgres

friend class Postgres
friend

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