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/concat.hxx"
33 #include "pqxx/internal/encoding_group.hxx"
34 #include "pqxx/isolation.hxx"
35 #include "pqxx/result.hxx"
36 #include "pqxx/row.hxx"
37 #include "pqxx/stream_from.hxx"
41 class transaction_subtransaction;
42 class transaction_sql_cursor;
43 class transaction_stream_to;
44 class transaction_transactionfocus;
50 using namespace std::literals;
108 [[nodiscard]] std::string
esc(
char const text[])
const
110 return conn().esc(text);
113 [[nodiscard]] std::string
esc(
char const text[], std::size_t maxlen)
const
115 return conn().esc(text, maxlen);
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 #include "pqxx/internal/ignore-deprecated-pre.hxx"
139 return conn().esc_raw(data, len);
140 #include "pqxx/internal/ignore-deprecated-post.hxx"
143 [[nodiscard]] std::string esc_raw(
zview)
const;
151 return conn().unesc_raw(text);
158 [[nodiscard]] std::string
unesc_raw(
char const *text)
const
160 return conn().unesc_raw(text);
165 template<
typename T> [[nodiscard]] std::string
quote(T
const &t)
const
167 #include "pqxx/internal/ignore-deprecated-pre.hxx"
168 return conn().quote(t);
169 #include "pqxx/internal/ignore-deprecated-post.hxx"
173 [[nodiscard]] std::string
174 quote_raw(
unsigned char const bin[], std::size_t len)
const
176 #include "pqxx/internal/ignore-deprecated-pre.hxx"
177 return conn().quote_raw(bin, len);
178 #include "pqxx/internal/ignore-deprecated-post.hxx"
182 [[nodiscard]] std::string quote_raw(
zview bin)
const;
185 [[nodiscard]] std::string
quote_name(std::string_view identifier)
const
187 return conn().quote_name(identifier);
191 [[nodiscard]] std::string
192 esc_like(std::string_view bin,
char escape_char =
'\\')
const
194 return conn().esc_like(bin, escape_char);
225 exec(std::string_view query, std::string_view desc = std::string_view{});
234 std::stringstream
const &query, std::string_view desc = std::string_view{})
236 return exec(query.str(), desc);
247 return exec_n(0, query, desc);
259 return exec_n(1, query, desc).
front();
270 std::string_view desc = std::string_view{});
276 template<
typename TYPE>
279 row const r{exec1(query, desc)};
280 if (std::size(r) != 1)
281 throw usage_error{internal::concat(
282 "Queried single value from result with ", std::size(r),
" columns.")};
283 return r[0].
as<TYPE>();
327 template<
typename... TYPE> [[nodiscard]]
auto stream(std::string_view query)
329 return pqxx::internal::owning_stream_input_iteration<TYPE...>{
330 std::make_unique<pqxx::stream_from>(*
this,
from_query_t{}, query)};
365 return internal_exec_params(
366 query, internal::params(std::forward<Args>(args)...));
374 return exec_params_n(1, query, std::forward<Args>(args)...).
front();
382 return exec_params_n(0, query, std::forward<Args>(args)...);
388 template<
typename... Args>
391 auto const r{exec_params(query, std::forward<Args>(args)...)};
392 check_rowcount_params(rows, std::size(r));
427 template<
typename... Args>
430 return internal_exec_prepared(
431 statement, internal::params(std::forward<Args>(args)...));
437 template<
typename... Args>
440 return exec_prepared_n(1, statement, std::forward<Args>(args)...).
front();
446 template<
typename... Args>
449 return exec_prepared_n(0, statement, std::forward<Args>(args)...);
456 template<
typename... Args>
460 auto const r{exec_prepared(statement, std::forward<Args>(args)...)};
461 check_rowcount_prepared(statement, rows, std::size(r));
491 void set_variable(std::string_view var, std::string_view value);
497 std::string get_variable(std::string_view);
500 [[nodiscard]] std::string_view
name() const noexcept {
return m_name; }
509 std::shared_ptr<std::string> rollback_cmd) :
510 m_conn{c}, m_name{tname}, m_rollback_cmd{rollback_cmd}
525 void register_transaction();
528 void close() noexcept;
531 virtual
void do_commit() = 0;
537 virtual
void do_abort();
540 void set_rollback_cmd(std::shared_ptr<std::
string> cmd)
542 m_rollback_cmd = cmd;
546 result direct_exec(std::string_view, std::string_view desc =
""sv);
548 direct_exec(std::shared_ptr<std::string>, std::string_view desc =
""sv);
559 PQXX_PRIVATE
void check_pending_error();
561 template<
typename T>
bool parm_is_null(T *p)
const noexcept
565 template<
typename T>
bool parm_is_null(T)
const noexcept {
return false; }
567 result internal_exec_prepared(zview statement, internal::params
const &args);
569 result internal_exec_params(zview query, internal::params
const &args);
572 void check_rowcount_prepared(
578 check_rowcount_params(std::size_t expected_rows, std::size_t actual_rows);
581 [[nodiscard]] std::string description()
const;
583 friend class pqxx::internal::gate::transaction_transactionfocus;
584 PQXX_PRIVATE
void register_focus(internal::transactionfocus *);
585 PQXX_PRIVATE
void unregister_focus(internal::transactionfocus *) noexcept;
586 PQXX_PRIVATE
void register_pending_error(
zview) noexcept;
587 PQXX_PRIVATE
void register_pending_error(std::string &&) noexcept;
595 internal::transactionfocus const *m_focus =
nullptr;
597 status m_status = status::active;
598 bool m_registered = false;
600 std::
string m_pending_error;
603 std::shared_ptr<std::
string> m_rollback_cmd;
605 constexpr static std::string_view s_type_name{
"transaction"sv};
612 std::string_view transaction_base::query_value<std::string_view>(
613 zview query, std::string_view desc) =
delete;
616 zview transaction_base::query_value<zview>(
617 zview query, std::string_view desc) =
delete;
625 template<pqxx::isolation_level isolation, pqxx::write_policy rw>
630 inline constexpr
zview begin_cmd<read_committed, write_policy::read_write>{
633 inline constexpr zview begin_cmd<read_committed, write_policy::read_only>{
634 "BEGIN READ ONLY"_zv};
636 inline constexpr zview begin_cmd<repeatable_read, write_policy::read_write>{
637 "BEGIN ISOLATION LEVEL REPEATABLE READ"_zv};
639 inline constexpr zview begin_cmd<repeatable_read, write_policy::read_only>{
640 "BEGIN ISOLATION LEVEL REPEATABLE READ READ ONLY"_zv};
642 inline constexpr zview begin_cmd<serializable, write_policy::read_write>{
643 "BEGIN ISOLATION LEVEL SERIALIZABLE"_zv};
645 inline constexpr zview begin_cmd<serializable, write_policy::read_only>{
646 "BEGIN ISOLATION LEVEL SERIALIZABLE READ ONLY"_zv};
649 #include "pqxx/internal/compiler-internal-post.hxx"
std::string esc(char const text[]) const
Escape string for use as SQL string literal in this transaction.
Definition: transaction_base.hxx:108
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:26
Internal items for libpqxx' own use. Do not use these yourself.
Definition: composite.hxx:74
const zview begin_cmd
The SQL command for starting a given type of transaction.
Definition: connection.hxx:95
Connection to a database.
Definition: connection.hxx:170
Result set containing data returned by a query or command.
Definition: result.hxx:71
result_size_type size_type
Definition: result.hxx:73
Reference to one row in a result.
Definition: row.hxx:46
reference front() const noexcept
Definition: row.cxx:54
std::tuple< TYPE... > as() const
Definition: row.hxx:185
Interface definition (and common code) for "transaction" classes.
Definition: transaction_base.hxx:72
result exec_prepared(zview statement, Args &&...args)
Execute a prepared statement, with optional arguments.
Definition: transaction_base.hxx:428
row exec1(zview query, std::string_view desc=std::string_view{})
Execute command returning a single row of data.
Definition: transaction_base.hxx:257
void process_notice(zview msg) const
Have connection process a warning message.
Definition: transaction_base.hxx:474
std::string unesc_raw(char const *text) const
Unescape binary data, e.g. from a table field or notification payload.
Definition: transaction_base.hxx:158
transaction_base & operator=(transaction_base &&)=delete
result exec_prepared_n(result::size_type rows, zview statement, Args &&...args)
Execute a prepared statement, expect a result with given number of rows.
Definition: transaction_base.hxx:458
transaction_base(transaction_base const &)=delete
TYPE query_value(zview query, std::string_view desc=std::string_view{})
Perform query, expecting exactly 1 row with 1 field, and convert it.
Definition: transaction_base.hxx:277
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).
Definition: transaction_base.hxx:507
std::string quote(T const &t) const
Represent object as SQL string, including quoting & escaping.
Definition: transaction_base.hxx:165
row exec_params1(zview query, Args &&...args)
Definition: transaction_base.hxx:372
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:113
std::string esc(std::string_view text) const
Escape string for use as SQL string literal in this transaction.
Definition: transaction_base.hxx:118
auto stream(std::string_view query)
Execute a query, and loop over the results row by row.
Definition: transaction_base.hxx:327
transaction_base(transaction_base &&)=delete
result exec_params(zview query, Args &&...args)
Execute an SQL statement with parameters.
Definition: transaction_base.hxx:363
std::string_view name() const noexcept
Transaction name, if you passed one to the constructor; or empty string.
Definition: transaction_base.hxx:500
transaction_base()=delete
result exec_params0(zview query, Args &&...args)
Definition: transaction_base.hxx:380
std::string unesc_raw(zview text) const
Unescape binary data, e.g. from a table field or notification payload.
Definition: transaction_base.hxx:149
result exec_prepared0(zview statement, Args &&...args)
Execute a prepared statement, and expect a result with zero rows.
Definition: transaction_base.hxx:447
std::string esc_like(std::string_view bin, char escape_char='\\') const
Escape string for literal LIKE match.
Definition: transaction_base.hxx:192
connection & conn() const
The connection in which this transaction lives.
Definition: transaction_base.hxx:478
result exec0(zview query, std::string_view desc=std::string_view{})
Execute command, which should return zero rows of data.
Definition: transaction_base.hxx:245
result exec(std::stringstream const &query, std::string_view desc=std::string_view{})
Execute a command.
Definition: transaction_base.hxx:233
row exec_prepared1(zview statement, Args &&...args)
Execute a prepared statement, and expect a single-row result.
Definition: transaction_base.hxx:438
std::string quote_name(std::string_view identifier) const
Escape an SQL identifier for use in a query.
Definition: transaction_base.hxx:185
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.
Definition: transaction_base.hxx:174
result exec_params_n(std::size_t rows, zview query, Args &&...args)
Definition: transaction_base.hxx:389
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
transaction_base & operator=(transaction_base const &)=delete
void process_notice(char const msg[]) const
Have connection process a warning message.
Definition: transaction_base.hxx:472
Marker for stream_from constructors: "stream from query.".
Definition: types.hxx:60
Marker-type wrapper: zero-terminated std::string_view.
Definition: zview.hxx:38