14 #ifndef PQXX_H_TRANSACTION_BASE
15 #define PQXX_H_TRANSACTION_BASE
17 #include "pqxx/compiler-public.hxx"
18 #include "pqxx/internal/compiler-internal-pre.hxx"
20 #include <string_view>
31 #include "pqxx/connection.hxx"
32 #include "pqxx/internal/encoding_group.hxx"
33 #include "pqxx/isolation.hxx"
34 #include "pqxx/result.hxx"
35 #include "pqxx/row.hxx"
36 #include "pqxx/stream_from.hxx"
40 class transaction_subtransaction;
41 class transaction_sql_cursor;
42 class transaction_stream_to;
43 class transaction_transactionfocus;
102 [[nodiscard]] std::string esc(
char const text[])
const
105 return conn().esc(text);
108 [[nodiscard]] std::string
esc(
char const text[], std::size_t maxlen)
const
110 return conn().esc(text, maxlen);
113 [[nodiscard]] std::string
esc(std::string
const &text)
const
115 return conn().esc(text);
118 [[nodiscard]] std::string
esc(std::string_view text)
const
120 return conn().esc(text);
135 [[nodiscard]] std::string
136 esc_raw(
unsigned char const data[], std::size_t len)
const
138 return conn().esc_raw(data, len);
141 [[nodiscard]] std::string esc_raw(std::string
const &)
const;
147 [[nodiscard]] std::string
unesc_raw(std::string
const &text)
const
149 return conn().unesc_raw(text);
156 [[nodiscard]] std::string
unesc_raw(
char const *text)
const
158 return conn().unesc_raw(text);
163 template<
typename T>[[nodiscard]] std::string
quote(T
const &t)
const
165 return conn().quote(t);
169 [[nodiscard]] std::string
170 quote_raw(
unsigned char const bin[], std::size_t len)
const
172 return conn().quote_raw(bin, len);
175 [[nodiscard]] std::string quote_raw(std::string
const &bin)
const;
178 [[nodiscard]] std::string
quote_name(std::string_view identifier)
const
180 return conn().quote_name(identifier);
184 [[nodiscard]] std::string
185 esc_like(std::string
const &bin,
char escape_char =
'\\')
const
187 return conn().esc_like(bin, escape_char);
206 result exec(std::string_view query, std::string
const &desc = std::string{});
209 exec(std::stringstream
const &query, std::string
const &desc = std::string{})
211 return exec(query.str(), desc);
221 exec0(std::string
const &query, std::string
const &desc = std::string{})
223 return exec_n(0, query, desc);
233 row exec1(std::string
const &query, std::string
const &desc = std::string{})
235 return exec_n(1, query, desc).
front();
246 std::string
const &desc = std::string{});
249 template<
typename TYPE>
251 std::string
const &query, std::string
const &desc = std::string{})
253 row const r{exec1(query, desc)};
256 "Queried single value from result with " +
to_string(r.size()) +
258 return r[0].as<TYPE>();
301 template<
typename... TYPE>[[nodiscard]]
auto stream(std::string_view query)
303 return pqxx::internal::owning_stream_input_iteration<TYPE...>{
304 std::make_unique<pqxx::stream_from>(*
this,
from_query_t{}, query)};
336 template<
typename... Args>
340 return internal_exec_params(
341 query, internal::params(std::forward<Args>(args)...));
347 template<
typename... Args>
350 return exec_params_n(1, query, std::forward<Args>(args)...).
front();
356 template<
typename... Args>
359 return exec_params_n(0, query, std::forward<Args>(args)...);
365 template<
typename... Args>
369 auto const r{exec_params(query, std::forward<Args>(args)...)};
370 check_rowcount_params(rows, r.size());
404 template<
typename... Args>
407 return internal_exec_prepared(
409 internal::params(std::forward<Args>(args)...));
412 template<
typename... Args>
415 return internal_exec_prepared(
416 statement, internal::params(std::forward<Args>(args)...));
422 template<
typename... Args>
425 return exec_prepared_n(1, statement, std::forward<Args>(args)...).
front();
428 template<
typename... Args>
431 return exec_prepared_n(1, statement, std::forward<Args>(args)...).
front();
437 template<
typename... Args>
440 return exec_prepared_n(0, statement, std::forward<Args>(args)...);
443 template<
typename... Args>
446 return exec_prepared_n(0, statement, std::forward<Args>(args)...);
453 template<
typename... Args>
457 auto const r{exec_prepared(statement, std::forward<Args>(args)...)};
458 check_rowcount_prepared(statement, rows, r.size());
462 template<
typename... Args>
466 auto const r{exec_prepared(statement, std::forward<Args>(args)...)};
467 check_rowcount_prepared(statement, rows, r.size());
477 void process_notice(
char const msg[])
const { m_conn.process_notice(msg); }
482 m_conn.process_notice(msg);
500 void set_variable(std::string_view var, std::string_view value);
506 std::string get_variable(std::string_view);
516 void register_transaction();
519 void close() noexcept;
522 virtual
void do_commit() = 0;
524 virtual
void do_abort() = 0;
529 result direct_exec(std::string_view);
530 result direct_exec(std::shared_ptr<std::
string>);
542 PQXX_PRIVATE
void check_pending_error();
544 template<
typename T>
bool parm_is_null(T *p)
const noexcept
548 template<
typename T>
bool parm_is_null(T)
const noexcept {
return false; }
550 result internal_exec_prepared(zview statement, internal::params
const &args);
553 internal_exec_params(std::string
const &query, internal::params
const &args);
556 void check_rowcount_prepared(
562 check_rowcount_params(std::size_t expected_rows, std::size_t actual_rows);
564 friend class pqxx::internal::gate::transaction_transactionfocus;
565 PQXX_PRIVATE
void register_focus(internal::transactionfocus *);
566 PQXX_PRIVATE
void unregister_focus(internal::transactionfocus *) noexcept;
567 PQXX_PRIVATE
void register_pending_error(std::string
const &) noexcept;
572 status m_status = status::active;
573 bool m_registered =
false;
574 std::string m_pending_error;
582 template<pqxx::isolation_level isolation, pqxx::write_policy rw>
587 inline constexpr zview begin_cmd<read_committed, write_policy::read_write>{
590 inline constexpr zview begin_cmd<read_committed, write_policy::read_only>{
593 inline constexpr zview begin_cmd<repeatable_read, write_policy::read_write>{
594 "BEGIN ISOLATION LEVEL REPEATABLE READ"};
596 inline constexpr zview begin_cmd<repeatable_read, write_policy::read_only>{
597 "BEGIN ISOLATION LEVEL REPEATABLE READ READ ONLY"};
599 inline constexpr zview begin_cmd<serializable, write_policy::read_write>{
600 "BEGIN ISOLATION LEVEL SERIALIZABLE"};
602 inline constexpr zview begin_cmd<serializable, write_policy::read_only>{
603 "BEGIN ISOLATION LEVEL SERIALIZABLE READ ONLY"};
606 #include "pqxx/internal/compiler-internal-post.hxx"
std::string esc_raw(unsigned char const data[], std::size_t len) const
Escape binary data for use as SQL string literal in this transaction.
Definition: transaction_base.hxx:136
PQXX_PURE bool empty() const noexcept
Definition: result.cxx:106
std::string esc(std::string const &text) const
Escape string for use as SQL string literal in this transaction.
Definition: transaction_base.hxx:113
transaction_base()=delete
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:26
std::string quote_raw(unsigned char const bin[], std::size_t len) const
Binary-escape and quote a binarystring for use as an SQL constant.
Definition: transaction_base.hxx:170
result exec_prepared0(std::string const &statement, Args &&... args)
Execute a prepared statement, and expect a result with zero rows.
Definition: transaction_base.hxx:438
reference front() const noexcept
Definition: row.cxx:54
Definition: connection.hxx:67
result exec_params(std::string const &query, Args &&... args)
Execute an SQL statement with parameters.
Definition: transaction_base.hxx:338
std::string to_string(field const &value)
Convert a field to a string.
Definition: result.cxx:498
row exec_prepared1(zview statement, Args &&... args)
Definition: transaction_base.hxx:429
std::string unesc_raw(char const *text) const
Unescape binary data, e.g. from a table field or notification payload.
Definition: transaction_base.hxx:156
std::string unesc_raw(std::string const &text) const
Unescape binary data, e.g. from a table field or notification payload.
Definition: transaction_base.hxx:147
transaction_base & operator=(transaction_base const &)=delete
std::string esc(std::string_view text) const
Escape string for use as SQL string literal in this transaction.
Definition: transaction_base.hxx:118
Run-time failure encountered by libpqxx, similar to std::runtime_error.
Definition: except.hxx:44
Helper base class: object descriptions for error messages and such.
Definition: util.hxx:217
row exec1(std::string const &query, std::string const &desc=std::string{})
Execute query returning a single row of data.
Definition: transaction_base.hxx:233
void register_transaction()
Register this transaction with the connection.
Definition: transaction_base.cxx:60
Private namespace for libpqxx's internal use; do not access.
Definition: connection.hxx:61
result exec_prepared0(zview statement, Args &&... args)
Definition: transaction_base.hxx:444
constexpr char const * c_str() const noexcept
Either a null pointer, or a zero-terminated text buffer.
Definition: zview.hxx:53
row exec_prepared1(std::string const &statement, Args &&... args)
Execute a prepared statement, and expect a single-row result.
Definition: transaction_base.hxx:423
std::string esc(char const text[], std::size_t maxlen) const
Escape string for use as SQL string literal in this transaction.
Definition: transaction_base.hxx:108
result exec_prepared(std::string const &statement, Args &&... args)
Execute a prepared statement, with optional arguments.
Definition: transaction_base.hxx:405
transaction_base(transaction_base const &)=delete
Marker-type wrapper: zero-terminated std::string_view.
Definition: zview.hxx:33
Result set containing data returned by a query or command.
Definition: result.hxx:71
connection & conn() const
The connection in which this transaction lives.
Definition: transaction_base.hxx:487
void commit()
Commit the transaction.
Definition: transaction_base.cxx:68
void abort()
Abort the transaction.
Definition: transaction_base.cxx:142
void process_notice(std::string const &msg) const
Have connection process a warning message.
Definition: transaction_base.hxx:480
std::string quote_name(std::string_view identifier) const
Escape an SQL identifier for use in a query.
Definition: transaction_base.hxx:178
std::string get_variable(std::string_view)
Read session variable using SQL "SHOW" command.
Definition: transaction_base.cxx:307
Exception class for lost or failed backend connection.
Definition: except.hxx:69
Reference to one row in a result.
Definition: row.hxx:44
Internal error in libpqxx library.
Definition: except.hxx:159
result_size_type size_type
Definition: result.hxx:73
virtual ~transaction_base()=0
Definition: transaction_base.cxx:32
result exec0(std::string const &query, std::string const &desc=std::string{})
Execute query, which should zero rows of data.
Definition: transaction_base.hxx:221
TYPE query_value(std::string const &query, std::string const &desc=std::string{})
Execute query, expecting exactly 1 row with 1 field.
Definition: transaction_base.hxx:250
result exec_prepared_n(result::size_type rows, std::string const &statement, Args &&... args)
Execute a prepared statement, expect a result with given number of rows.
Definition: transaction_base.hxx:454
result exec(std::string_view query, std::string const &desc=std::string{})
Execute query.
Definition: transaction_base.cxx:198
row exec_params1(std::string const &query, Args &&... args)
Definition: transaction_base.hxx:348
result direct_exec(std::string_view)
Execute query on connection directly.
Definition: transaction_base.cxx:382
void close() noexcept
End transaction. To be called by implementing class' destructor.
Definition: transaction_base.cxx:313
auto stream(std::string_view query)
Execute a query, and loop over the results row by row.
Definition: transaction_base.hxx:301
result exec_params_n(std::size_t rows, std::string const &query, Args &&... args)
Definition: transaction_base.hxx:367
result exec_n(result::size_type rows, std::string const &query, std::string const &desc=std::string{})
Execute query, expect given number of rows.
Definition: transaction_base.cxx:238
std::string quote(T const &t) const
Represent object as SQL string, including quoting & escaping.
Definition: transaction_base.hxx:163
Connection to a database.
Definition: connection.hxx:137
result exec_prepared_n(result::size_type rows, zview statement, Args &&... args)
Definition: transaction_base.hxx:464
result exec(std::stringstream const &query, std::string const &desc=std::string{})
Definition: transaction_base.hxx:209
Query returned an unexpected number of rows.
Definition: except.hxx:201
Interface definition (and common code) for "transaction" classes.
Definition: transaction_base.hxx:69
result exec_params0(std::string const &query, Args &&... args)
Definition: transaction_base.hxx:357
"Help, I don't know whether transaction was committed successfully!"
Definition: except.hxx:108
void set_variable(std::string_view var, std::string_view value)
Set session variable using SQL "SET" command.
Definition: transaction_base.cxx:300
Error in usage of libpqxx library, similar to std::logic_error.
Definition: except.hxx:166
const zview begin_cmd
The SQL command for starting a given type of transaction.
std::string esc_like(std::string const &bin, char escape_char='\\') const
Escape string for literal LIKE match.
Definition: transaction_base.hxx:185
result exec_prepared(zview statement, Args &&... args)
Definition: transaction_base.hxx:413
Marker for stream_from constructors: "stream from query.".
Definition: types.hxx:60