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>
32 #include "pqxx/connection.hxx"
33 #include "pqxx/internal/concat.hxx"
34 #include "pqxx/internal/encoding_group.hxx"
35 #include "pqxx/isolation.hxx"
36 #include "pqxx/result.hxx"
37 #include "pqxx/row.hxx"
38 #include "pqxx/stream_from.hxx"
42 class transaction_subtransaction;
43 class transaction_sql_cursor;
44 class transaction_stream_to;
45 class transaction_transaction_focus;
51 using namespace std::literals;
54 class transaction_focus;
118 template<
typename... ARGS> [[nodiscard]]
auto esc(ARGS &&...args)
const
120 return conn().esc(std::forward<ARGS>(args)...);
135 template<
typename... ARGS> [[nodiscard]]
auto esc_raw(ARGS &&...args)
const
137 return conn().esc_raw(std::forward<ARGS>(args)...);
144 [[nodiscard, deprecated(
"Use unesc_bin() instead.")]] std::string
147 #include "pqxx/internal/ignore-deprecated-pre.hxx"
148 return conn().unesc_raw(
text);
149 #include "pqxx/internal/ignore-deprecated-post.hxx"
158 return conn().unesc_bin(
text);
165 [[nodiscard, deprecated(
"Use unesc_bin() instead.")]] std::string
168 #include "pqxx/internal/ignore-deprecated-pre.hxx"
169 return conn().unesc_raw(
text);
170 #include "pqxx/internal/ignore-deprecated-post.hxx"
177 [[nodiscard]] std::basic_string<std::byte>
unesc_bin(
char const text[])
179 return conn().unesc_bin(
text);
184 template<
typename T> [[nodiscard]] std::string
quote(T
const &t)
const
186 return conn().quote(t);
190 "Use std::basic_string<std::byte> instead of binarystring.")]] std::string
197 [[deprecated(
"Use quote(std::basic_string_view<std::byte>).")]] std::string
198 quote_raw(
unsigned char const bin[], std::size_t len)
const
204 [[deprecated(
"Use quote(std::basic_string_view<std::byte>).")]] std::string
205 quote_raw(
zview bin)
const;
207 #if defined(PQXX_HAVE_CONCEPTS)
210 template<binary DATA>
211 [[nodiscard]] std::string quote_raw(DATA
const &data)
const
213 return conn().quote_raw(data);
218 [[nodiscard]] std::string
quote_name(std::string_view identifier)
const
220 return conn().quote_name(identifier);
224 [[nodiscard]] std::string
225 esc_like(std::string_view bin,
char escape_char =
'\\')
const
227 return conn().esc_like(bin, escape_char);
258 exec(std::string_view query, std::string_view desc = std::string_view{});
267 std::stringstream
const &query, std::string_view desc = std::string_view{})
269 return exec(query.str(), desc);
280 return exec_n(0, query, desc);
292 return exec_n(1, query, desc).
front();
303 std::string_view desc = std::string_view{});
309 template<
typename TYPE>
312 row const r{exec1(query, desc)};
313 if (std::size(r) != 1)
314 throw usage_error{internal::concat(
315 "Queried single value from result with ", std::size(r),
" columns.")};
316 return r[0].
as<TYPE>();
368 template<
typename... TYPE> [[nodiscard]]
auto stream(std::string_view query)
371 return pqxx::internal::owning_stream_input_iteration<TYPE...>{
372 std::unique_ptr<stream_from>{
417 return exec_params_n(1, query, std::forward<Args>(args)...).
front();
425 return exec_params_n(0, query, std::forward<Args>(args)...);
431 template<
typename... Args>
434 auto const r{exec_params(query, std::forward<Args>(args)...)};
435 check_rowcount_params(rows, std::size(r));
473 template<
typename... Args>
477 return internal_exec_prepared(statement, pp.
make_c_params());
483 template<
typename... Args>
486 return exec_prepared_n(1, statement, std::forward<Args>(args)...).
front();
492 template<
typename... Args>
495 return exec_prepared_n(0, statement, std::forward<Args>(args)...);
502 template<
typename... Args>
506 auto const r{exec_prepared(statement, std::forward<Args>(args)...)};
507 check_rowcount_prepared(statement, rows, std::size(r));
537 void set_variable(std::string_view var, std::string_view value);
543 std::string get_variable(std::string_view);
546 [[nodiscard]] std::string_view
name() const noexcept {
return m_name; }
555 std::shared_ptr<std::string> rollback_cmd) :
556 m_conn{c}, m_name{tname}, m_rollback_cmd{rollback_cmd}
571 void register_transaction();
574 void close() noexcept;
577 virtual
void do_commit() = 0;
583 virtual
void do_abort();
586 void set_rollback_cmd(std::shared_ptr<std::
string> cmd)
588 m_rollback_cmd = cmd;
592 result direct_exec(std::string_view, std::string_view desc =
""sv);
594 direct_exec(std::shared_ptr<std::string>, std::string_view desc =
""sv);
605 PQXX_PRIVATE
void check_pending_error();
607 template<
typename T>
bool parm_is_null(T *p)
const noexcept
611 template<
typename T>
bool parm_is_null(T)
const noexcept {
return false; }
614 internal_exec_prepared(zview statement, internal::c_params
const &args);
616 result internal_exec_params(zview query, internal::c_params
const &args);
619 void check_rowcount_prepared(
625 check_rowcount_params(std::size_t expected_rows, std::size_t actual_rows);
628 [[nodiscard]] std::string description()
const;
630 friend class pqxx::internal::gate::transaction_transaction_focus;
633 PQXX_PRIVATE
void register_pending_error(
zview) noexcept;
634 PQXX_PRIVATE
void register_pending_error(std::string &&) noexcept;
644 status m_status = status::active;
645 bool m_registered = false;
647 std::
string m_pending_error;
650 std::shared_ptr<std::
string> m_rollback_cmd;
652 static constexpr std::string_view s_type_name{
"transaction"sv};
659 std::string_view transaction_base::query_value<std::string_view>(
660 zview query, std::string_view desc) =
delete;
663 zview transaction_base::query_value<zview>(
664 zview query, std::string_view desc) =
delete;
672 template<pqxx::isolation_level isolation, pqxx::write_policy rw>
677 inline constexpr
zview begin_cmd<read_committed, write_policy::read_write>{
680 inline constexpr zview begin_cmd<read_committed, write_policy::read_only>{
681 "BEGIN READ ONLY"_zv};
683 inline constexpr zview begin_cmd<repeatable_read, write_policy::read_write>{
684 "BEGIN ISOLATION LEVEL REPEATABLE READ"_zv};
686 inline constexpr zview begin_cmd<repeatable_read, write_policy::read_only>{
687 "BEGIN ISOLATION LEVEL REPEATABLE READ READ ONLY"_zv};
689 inline constexpr zview begin_cmd<serializable, write_policy::read_write>{
690 "BEGIN ISOLATION LEVEL SERIALIZABLE"_zv};
692 inline constexpr zview begin_cmd<serializable, write_policy::read_only>{
693 "BEGIN ISOLATION LEVEL SERIALIZABLE READ ONLY"_zv};
696 #include "pqxx/internal/compiler-internal-post.hxx"
auto esc(ARGS &&...args) const
Escape string for use as SQL string literal in this transaction.
Definition: transaction_base.hxx:118
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:26
std::basic_string_view< std::byte > binary_cast(TYPE const &data)
Cast binary data to a type that libpqxx will recognise as binary.
Definition: util.hxx:230
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
Binary data corresponding to PostgreSQL's "BYTEA" binary-string type.
Definition: binarystring.hxx:58
std::basic_string_view< std::byte > bytes_view() const
Read data as a std::basic_string_view<std::byte>.
Definition: binarystring.hxx:177
Connection to a database.
Definition: connection.hxx:181
Build a parameter list for a parameterised or prepared statement.
Definition: params.hxx:214
pqxx::internal::c_params make_c_params() const
For internal use: Generate a params object for use in calls.
Definition: params.cxx:92
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:184
Stream data from the database.
Definition: stream_from.hxx:73
static stream_from query(transaction_base &tx, std::string_view q)
Factory: Execute query, and stream the results.
Definition: stream_from.hxx:88
Interface definition (and common code) for "transaction" classes.
Definition: transaction_base.hxx:76
result exec_prepared(zview statement, Args &&...args)
Execute a prepared statement, with optional arguments.
Definition: transaction_base.hxx:474
row exec1(zview query, std::string_view desc=std::string_view{})
Execute command returning a single row of data.
Definition: transaction_base.hxx:290
void process_notice(zview msg) const
Have connection process a warning message.
Definition: transaction_base.hxx:520
std::string unesc_raw(char const *text) const
Unescape binary data, e.g. from a table field or notification payload.
Definition: transaction_base.hxx:166
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:504
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:310
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:553
std::string quote(T const &t) const
Represent object as SQL string, including quoting & escaping.
Definition: transaction_base.hxx:184
row exec_params1(zview query, Args &&...args)
Definition: transaction_base.hxx:415
auto esc_raw(ARGS &&...args) const
Escape binary data for use as SQL string literal in this transaction.
Definition: transaction_base.hxx:135
std::basic_string< std::byte > unesc_bin(char const text[])
Unescape binary data, e.g. from a table field or notification payload.
Definition: transaction_base.hxx:177
std::string quote(binarystring const &t) const
Definition: transaction_base.hxx:191
auto stream(std::string_view query)
Execute a query, and loop over the results row by row.
Definition: transaction_base.hxx:368
transaction_base(transaction_base &&)=delete
result exec_params(zview query, Args &&...args)
Execute an SQL statement with parameters.
Definition: transaction_base.hxx:406
std::string_view name() const noexcept
Transaction name, if you passed one to the constructor; or empty string.
Definition: transaction_base.hxx:546
transaction_base()=delete
result exec_params0(zview query, Args &&...args)
Definition: transaction_base.hxx:423
std::string unesc_raw(zview text) const
Unescape binary data, e.g. from a table field or notification payload.
Definition: transaction_base.hxx:145
result exec_prepared0(zview statement, Args &&...args)
Execute a prepared statement, and expect a result with zero rows.
Definition: transaction_base.hxx:493
std::string esc_like(std::string_view bin, char escape_char='\\') const
Escape string for literal LIKE match.
Definition: transaction_base.hxx:225
connection & conn() const
The connection in which this transaction lives.
Definition: transaction_base.hxx:524
result exec0(zview query, std::string_view desc=std::string_view{})
Execute command, which should return zero rows of data.
Definition: transaction_base.hxx:278
result exec(std::stringstream const &query, std::string_view desc=std::string_view{})
Execute a command.
Definition: transaction_base.hxx:266
row exec_prepared1(zview statement, Args &&...args)
Execute a prepared statement, and expect a single-row result.
Definition: transaction_base.hxx:484
std::string quote_name(std::string_view identifier) const
Escape an SQL identifier for use in a query.
Definition: transaction_base.hxx:218
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:198
std::basic_string< std::byte > unesc_bin(zview text)
Unescape binary data, e.g. from a table field or notification payload.
Definition: transaction_base.hxx:156
result exec_params_n(std::size_t rows, zview query, Args &&...args)
Definition: transaction_base.hxx:432
transaction_base & operator=(transaction_base const &)=delete
void process_notice(char const msg[]) const
Have connection process a warning message.
Definition: transaction_base.hxx:518
Base class for things that monopolise a transaction's attention.
Definition: transaction_focus.hxx:28
Marker-type wrapper: zero-terminated std::string_view.
Definition: zview.hxx:40