libpqxx  7.9.0
pqxx::internal::basic_transaction Class Referenceabstract

Helper base class for the transaction class template. More...

#include <transaction.hxx>

Inheritance diagram for pqxx::internal::basic_transaction:

Protected Member Functions

 basic_transaction (connection &c, zview begin_command, std::string_view tname)
 
 basic_transaction (connection &c, zview begin_command, std::string &&tname)
 
 basic_transaction (connection &c, zview begin_command)
 
virtual ~basic_transaction () noexcept override=0
 
- Protected Member Functions inherited from pqxx::dbtransaction
 dbtransaction (connection &c)
 Begin transaction. More...
 
 dbtransaction (connection &c, std::string_view tname)
 Begin transaction. More...
 
 dbtransaction (connection &c, std::string_view tname, std::shared_ptr< std::string > rollback_cmd)
 Begin transaction. More...
 
- Protected Member Functions inherited from pqxx::transaction_base
 transaction_base (connection &c, std::string_view tname, std::shared_ptr< std::string > rollback_cmd)
 Create a transaction (to be called by implementation classes only). More...
 
 transaction_base (connection &c, std::string_view tname)
 Create a transaction (to be called by implementation classes only). More...
 
 transaction_base (connection &c)
 Create a transaction (to be called by implementation classes only). More...
 
void register_transaction ()
 Register this transaction with the connection. More...
 
void close () noexcept
 End transaction. To be called by implementing class' destructor. More...
 
virtual void do_abort ()
 Transaction type-specific way of aborting a transaction. More...
 
void set_rollback_cmd (std::shared_ptr< std::string > cmd)
 Set the rollback command. More...
 
result direct_exec (std::string_view, std::string_view desc=""sv)
 Execute query on connection directly. More...
 
result direct_exec (std::shared_ptr< std::string >, std::string_view desc=""sv)
 

Additional Inherited Members

- Public Member Functions inherited from pqxx::transaction_base
 transaction_base ()=delete
 
 transaction_base (transaction_base const &)=delete
 
 transaction_base (transaction_base &&)=delete
 
transaction_baseoperator= (transaction_base const &)=delete
 
transaction_baseoperator= (transaction_base &&)=delete
 
virtual ~transaction_base ()=0
 
void commit ()
 Commit the transaction. More...
 
void abort ()
 Abort the transaction. More...
 
template<typename... ARGS>
auto esc (ARGS &&...args) const
 Escape string for use as SQL string literal in this transaction. More...
 
template<typename... ARGS>
auto esc_raw (ARGS &&...args) const
 Escape binary data for use as SQL string literal in this transaction. More...
 
std::string unesc_raw (zview text) const
 Unescape binary data, e.g. from a table field or notification payload. More...
 
bytes unesc_bin (zview text)
 Unescape binary data, e.g. from a table field or notification payload. More...
 
std::string unesc_raw (char const *text) const
 Unescape binary data, e.g. from a table field or notification payload. More...
 
bytes unesc_bin (char const text[])
 Unescape binary data, e.g. from a table field or notification payload. More...
 
template<typename T >
std::string quote (T const &t) const
 Represent object as SQL string, including quoting & escaping. More...
 
std::string quote (binarystring const &t) const
 
std::string quote_raw (unsigned char const bin[], std::size_t len) const
 Binary-escape and quote a binary string for use as an SQL constant. More...
 
std::string quote_raw (zview bin) const
 Binary-escape and quote a binary string for use as an SQL constant. More...
 
std::string quote_name (std::string_view identifier) const
 Escape an SQL identifier for use in a query. More...
 
std::string esc_like (std::string_view bin, char escape_char='\\') const
 Escape string for literal LIKE match. More...
 
template<>
zview query_value (zview query, std::string_view desc)=delete
 Forbidden specialisation: underlying buffer immediately goes out of scope. More...
 
result exec (std::string_view query, std::string_view desc)
 Execute a command. More...
 
result exec (std::string_view query)
 Execute a command. More...
 
result exec (std::stringstream const &query, std::string_view desc)
 Execute a command. More...
 
result exec0 (zview query, std::string_view desc)
 Execute command, which should return zero rows of data. More...
 
result exec0 (zview query)
 Execute command, which should return zero rows of data. More...
 
row exec1 (zview query, std::string_view desc)
 Execute command returning a single row of data. More...
 
row exec1 (zview query)
 Execute command returning a single row of data. More...
 
result exec_n (result::size_type rows, zview query, std::string_view desc)
 Execute command, expect given number of rows. More...
 
result exec_n (result::size_type rows, zview query)
 Execute command, expect given number of rows. More...
 
template<typename TYPE >
TYPE query_value (zview query, std::string_view desc)
 Perform query, expecting exactly 1 row with 1 field, and convert it. More...
 
template<typename TYPE >
TYPE query_value (zview query)
 Perform query, expecting exactly 1 row with 1 field, and convert it. More...
 
template<typename... TYPE>
std::tuple< TYPE... > query1 (zview query)
 Perform query returning exactly one row, and convert its fields. More...
 
template<typename... TYPE>
std::optional< std::tuple< TYPE... > > query01 (zview query)
 Query at most one row of data, and if there is one, convert it. More...
 
template<typename... TYPE>
auto stream (std::string_view query) &
 Execute a query, in streaming fashion; loop over the results row by row. More...
 
template<typename CALLABLE >
auto for_stream (std::string_view query, CALLABLE &&func)
 Perform a streaming query, and for each result row, call func. More...
 
template<typename CALLABLE >
auto for_each (std::string_view query, CALLABLE &&func)
 
template<typename... TYPE>
auto query (zview query)
 Execute query, read full results, then iterate rows of data. More...
 
template<typename... TYPE>
auto query_n (result::size_type rows, zview query)
 Perform query, expect given number of rows, iterate results. More...
 
template<typename CALLABLE >
void for_query (zview query, CALLABLE &&func)
 Execute a query, load the full result, and perform func for each row. More...
 
template<typename... Args>
result exec_params (zview query, Args &&...args)
 Execute an SQL statement with parameters. More...
 
template<typename... Args>
row exec_params1 (zview query, Args &&...args)
 
template<typename... Args>
result exec_params0 (zview query, Args &&...args)
 
template<typename... Args>
result exec_params_n (std::size_t rows, zview query, Args &&...args)
 
template<typename... Args>
result exec_params_n (result::size_type rows, zview query, Args &&...args)
 
template<typename... TYPE>
auto query (zview query, params const &parms)
 Execute parameterised query, read full results, iterate rows of data. More...
 
template<typename... TYPE>
auto query_n (result::size_type rows, zview query, params const &parms)
 
template<typename TYPE >
TYPE query_value (zview query, params const &parms)
 Perform query, expecting exactly 1 row with 1 field, and convert it. More...
 
template<typename... TYPE>
std::tuple< TYPE... > query1 (zview query, params const &parms)
 Perform query returning exactly one row, and convert its fields. More...
 
template<typename... TYPE>
std::optional< std::tuple< TYPE... > > query01 (zview query, params const &parms)
 Query at most one row of data, and if there is one, convert it. More...
 
template<typename CALLABLE >
void for_query (zview query, CALLABLE &&func, params const &parms)
 Execute a query, load the full result, and perform func for each row. More...
 
template<typename... Args>
result exec_prepared (zview statement, Args &&...args)
 Execute a prepared statement, with optional arguments. More...
 
template<typename... Args>
row exec_prepared1 (zview statement, Args &&...args)
 Execute a prepared statement, and expect a single-row result. More...
 
template<typename... Args>
result exec_prepared0 (zview statement, Args &&...args)
 Execute a prepared statement, and expect a result with zero rows. More...
 
template<typename... Args>
result exec_prepared_n (result::size_type rows, zview statement, Args &&...args)
 Execute a prepared statement, expect a result with given number of rows. More...
 
void process_notice (char const msg[]) const
 Have connection process a warning message. More...
 
void process_notice (zview msg) const
 Have connection process a warning message. More...
 
constexpr connectionconn () const noexcept
 The connection in which this transaction lives. More...
 
void set_variable (std::string_view var, std::string_view value)
 Set session variable using SQL "SET" command. More...
 
std::string get_variable (std::string_view)
 Read session variable using SQL "SHOW" command. More...
 
std::string_view name () const &noexcept
 Transaction name, if you passed one to the constructor; or empty string. More...
 

Detailed Description

Helper base class for the transaction class template.

Constructor & Destructor Documentation

◆ basic_transaction() [1/3]

pqxx::internal::basic_transaction::basic_transaction ( connection c,
zview  begin_command,
std::string_view  tname 
)
protected

Implementation of the pqxx::transaction class.

pqxx::transaction represents a regular database transaction.

Copyright (c) 2000-2024, Jeroen T. Vermeulen.

See COPYING for copyright license. If you did not receive a file called COPYING with this source code, please notify the distributor of this mistake, or contact the author.

References pqxx::transaction_base::direct_exec(), and pqxx::transaction_base::register_transaction().

◆ basic_transaction() [2/3]

pqxx::internal::basic_transaction::basic_transaction ( connection c,
zview  begin_command,
std::string &&  tname 
)
protected

◆ basic_transaction() [3/3]

pqxx::internal::basic_transaction::basic_transaction ( connection c,
zview  begin_command 
)
protected

◆ ~basic_transaction()

pqxx::internal::basic_transaction::~basic_transaction ( )
overrideprotectedpure virtualdefaultnoexcept

References pqxx::read_write.


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