13 #ifndef PQXX_H_CONNECTION 14 #define PQXX_H_CONNECTION 16 #include "pqxx/compiler-public.hxx" 17 #include "pqxx/internal/compiler-internal-pre.hxx" 22 #include <initializer_list> 26 #include <string_view> 29 #if __has_include(<ranges>) 33 #include "pqxx/errorhandler.hxx" 34 #include "pqxx/except.hxx" 35 #include "pqxx/prepared_statement.hxx" 36 #include "pqxx/separated_list.hxx" 37 #include "pqxx/strconv.hxx" 38 #include "pqxx/util.hxx" 39 #include "pqxx/zview.hxx" 73 #if defined(PQXX_HAVE_CONCEPTS) 76 concept ZKey_ZValues = std::ranges::input_range<T> and requires()
78 {std::tuple_size<typename std::ranges::iterator_t<T>::value_type>::value};
80 and std::tuple_size_v<typename std::ranges::iterator_t<T>::value_type> == 2 and
84 std::get<0>(*std::cbegin(t))
88 std::get<1>(*std::cbegin(t))
92 #endif // PQXX_HAVE_CONCEPTS 98 class connection_dbtransaction;
99 class connection_errorhandler;
100 class connection_largeobject;
101 class connection_notification_receiver;
102 class connection_pipeline;
103 class connection_sql_cursor;
104 class connection_stream_from;
105 class connection_stream_to;
106 class connection_transaction;
107 class const_connection_largeobject;
126 deprecated(
"Use connection::encrypt_password instead.")]] std::string
132 deprecated(
"Use connection::encrypt_password instead.")]]
inline std::string
135 #include "pqxx/internal/ignore-deprecated-pre.hxx" 137 #include "pqxx/internal/ignore-deprecated-post.hxx" 208 #if defined(PQXX_HAVE_CONCEPTS) 225 template<
internal::ZKey_ZValues MAPPING>
227 #endif // PQXX_HAVE_CONCEPTS 235 catch (std::exception
const &)
243 connection &operator=(connection &&rhs);
245 connection(connection
const &) =
delete;
246 connection &operator=(connection
const &) =
delete;
253 [[nodiscard]]
bool PQXX_PURE is_open()
const noexcept;
256 void process_notice(
char const[]) noexcept;
261 void process_notice(
zview) noexcept;
264 void trace(std::FILE *) noexcept;
276 [[nodiscard]]
char const *dbname()
const;
280 [[nodiscard]]
char const *username()
const;
283 [[nodiscard]]
char const *hostname()
const;
286 [[nodiscard]]
char const *port()
const;
289 [[nodiscard]]
int PQXX_PURE backendpid()
const noexcept;
307 [[nodiscard]]
int PQXX_PURE sock()
const noexcept;
313 [[nodiscard]]
int PQXX_PURE protocol_version()
const noexcept;
328 [[nodiscard]]
int PQXX_PURE server_version()
const noexcept;
352 [[nodiscard]] std::string get_client_encoding()
const;
361 set_client_encoding(encoding.
c_str());
368 void set_client_encoding(
char const encoding[]);
371 [[nodiscard]]
int PQXX_PRIVATE encoding_id()
const;
391 void set_variable(std::string_view var, std::string_view value);
397 std::string get_variable(std::string_view);
430 int await_notification();
441 int await_notification(std::time_t seconds,
long microseconds);
474 [[nodiscard]] std::string
482 char const user[],
char const password[],
char const *algorithm =
nullptr);
542 void prepare(
char const name[],
char const definition[]);
552 void prepare(
char const definition[]);
556 void unprepare(std::string_view name);
564 [[nodiscard]] std::string adorn_name(std::string_view);
577 [[nodiscard]] std::string
esc(
char const text[], std::size_t maxlen)
const 579 return esc(std::string_view(text, maxlen));
584 [[nodiscard]] std::string
esc(
char const text[])
const 586 return esc(std::string_view(text));
594 [[nodiscard]] std::string esc(std::string_view text)
const;
599 [[nodiscard, deprecated(
"Use std::byte for binary data.")]] std::string
600 esc_raw(
unsigned char const bin[], std::size_t len)
const;
604 [[nodiscard]] std::string esc_raw(std::basic_string_view<std::byte>)
const;
613 return unesc_raw(text.
c_str());
621 [[nodiscard]] std::string unesc_raw(
char const text[])
const;
626 [[nodiscard, deprecated(
"Use std::byte for binary data.")]] std::string
627 quote_raw(
unsigned char const bin[], std::size_t len)
const;
630 [[nodiscard]] std::string quote_raw(std::basic_string_view<std::byte>)
const;
634 [[nodiscard]] std::string quote_name(std::string_view identifier)
const;
641 [[nodiscard]] std::string quote_table(std::string_view name)
const;
653 [[nodiscard]] std::string quote_table(
table_path)
const;
665 template<
typename CONTAINER>
666 inline std::enable_if_t<
667 std::is_convertible_v<typename CONTAINER::value_type, std::string_view>,
669 quote_columns(CONTAINER
const &columns)
const;
677 [[nodiscard]]
inline std::string quote(T
const &t)
const;
680 [[nodiscard, deprecated(
"Use std::byte for binary data.")]] std::string
685 [[nodiscard]] std::string
686 quote(std::basic_string_view<std::byte> bytes)
const;
713 [[nodiscard]] std::string
714 esc_like(std::string_view text,
char escape_char =
'\\')
const;
749 [[nodiscard]] std::vector<errorhandler *> get_errorhandlers()
const;
758 [[nodiscard]] std::string connection_string()
const;
768 void init(
char const options[]);
770 void init(
char const *params[],
char const *values[]);
771 void complete_init();
774 void wait_read(std::time_t seconds,
long microseconds)
const;
777 internal::pq::PGresult *pgr, std::shared_ptr<std::string>
const &query,
778 std::string_view desc =
""sv);
780 void PQXX_PRIVATE set_up_state();
782 int PQXX_PRIVATE PQXX_PURE status()
const noexcept;
789 std::size_t esc_to_buf(std::string_view text,
char *buf)
const;
791 friend class internal::gate::const_connection_largeobject;
792 char const *PQXX_PURE err_msg() const noexcept;
794 void PQXX_PRIVATE process_notice_raw(
char const msg[]) noexcept;
796 result exec_prepared(
std::string_view statement, internal::params const &);
799 void check_movable() const;
801 void check_overwritable() const;
803 friend class internal::gate::connection_errorhandler;
804 void PQXX_PRIVATE register_errorhandler(
errorhandler *);
805 void PQXX_PRIVATE unregister_errorhandler(errorhandler *) noexcept;
807 friend class internal::gate::connection_transaction;
808 result PQXX_PRIVATE exec(
std::string_view,
std::string_view = ""sv);
810 PQXX_PRIVATE exec(
std::shared_ptr<
std::
string>,
std::string_view = ""sv);
812 void PQXX_PRIVATE unregister_transaction(transaction_base *) noexcept;
814 friend class internal::gate::connection_stream_from;
815 std::pair<
std::unique_ptr<
char,
std::function<
void(
char *)>>,
std::
size_t>
816 PQXX_PRIVATE read_copy_line();
818 friend class internal::gate::connection_stream_to;
819 void PQXX_PRIVATE write_copy_line(
std::string_view);
820 void PQXX_PRIVATE end_copy_write();
822 friend class internal::gate::connection_largeobject;
823 internal::pq::PGconn *raw_connection()
const {
return m_conn; }
825 friend class internal::gate::connection_notification_receiver;
829 friend class internal::gate::connection_pipeline;
830 void PQXX_PRIVATE start_exec(
char const query[]);
831 bool PQXX_PRIVATE consume_input() noexcept;
832 bool PQXX_PRIVATE is_busy() const noexcept;
833 internal::pq::PGresult *get_result();
835 friend class internal::gate::connection_dbtransaction;
836 friend class internal::gate::connection_sql_cursor;
838 result exec_params(
std::string_view query, internal::params const &args);
841 internal::pq::PGconn *m_conn =
nullptr;
855 using receiver_list =
858 receiver_list m_receivers;
869 template<typename T> inline
std::
string connection::quote(T const &t)
const 885 std::string buf{
'\''};
886 buf.resize(2 + 2 * std::size(text) + 1);
887 auto const content_bytes{esc_to_buf(text, buf.data() + 1)};
888 auto const closing_quote{1 + content_bytes};
889 buf[closing_quote] =
'\'';
890 auto const end{closing_quote + 1};
897 template<
typename CONTAINER>
898 inline std::enable_if_t<
899 std::is_convertible_v<typename CONTAINER::value_type, std::string_view>,
904 ","sv, std::cbegin(columns), std::cend(columns),
905 [
this](
auto col) {
return this->quote_name(*col); });
909 #if defined(PQXX_HAVE_CONCEPTS) 910 template<
internal::ZKey_ZValues MAPPING>
915 std::vector<char const *> keys, values;
916 if constexpr (std::ranges::sized_range<MAPPING>)
918 auto const size{std::ranges::size(params) + 1};
920 values.reserve(size);
922 for (
auto const &[key, value] : params)
927 keys.push_back(
nullptr);
928 values.push_back(
nullptr);
929 init(keys.data(), values.data());
931 #endif // PQXX_HAVE_CONCEPTS 937 PQXX_LIBEXPORT
void wait_read(internal::pq::PGconn
const *);
939 internal::pq::PGconn
const *, std::time_t seconds,
long microseconds);
940 PQXX_LIBEXPORT
void wait_write(internal::pq::PGconn
const *);
943 #include "pqxx/internal/compiler-internal-post.hxx"
void prepare(zview definition)
Definition: connection.hxx:553
constexpr char const * as_c_string(char const str[]) noexcept
Get a raw C string pointer.
Definition: zview.hxx:121
std::enable_if_t< std::is_convertible_v< typename CONTAINER::value_type, std::string_view >, std::string > quote_columns(CONTAINER const &columns) const
Quote and comma-separate a series of column names.
Definition: connection.hxx:901
void set_client_encoding(zview encoding)
Set client-side character encoding, by name.
Definition: connection.hxx:359
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:25
void wait_write(internal::pq::PGconn const *)
Definition: connection.cxx:1010
bool is_null(TYPE const &value) noexcept
Is value null?
Definition: strconv.hxx:353
void check_version()
Definition: util.hxx:171
error_verbosity
Error verbosity levels.
Definition: connection.hxx:142
std::string to_string(field const &value)
Convert a field to a string.
Definition: result.cxx:503
Binary data corresponding to PostgreSQL's "BYTEA" binary-string type.
Definition: binarystring.hxx:56
std::string encrypt_password(zview user, zview password, zview algorithm)
Encrypt a password for a given user.
Definition: connection.hxx:476
connection()
Definition: connection.hxx:185
void wait_read(internal::pq::PGconn const *)
Definition: connection.cxx:991
Base class for error-handler callbacks.
Definition: errorhandler.hxx:52
~connection()
Definition: connection.hxx:229
Connection to a database.
Definition: connection.hxx:182
std::string separated_list(std::string_view sep, ITER begin, ITER end, ACCESS access)
Represent sequence of values as a string, joined by a given separator.
Definition: separated_list.hxx:42
Traits describing a type's "null value," if any.
Definition: strconv.hxx:86
Definition: connection.hxx:96
std::string esc(char const text[]) const
Escape string for use as SQL string literal on this connection.
Definition: connection.hxx:584
std::string esc(char const text[], std::size_t maxlen) const
Escape string for use as SQL string literal on this connection.
Definition: connection.hxx:577
Result set containing data returned by a query or command.
Definition: result.hxx:70
Definition: notification.hxx:55
Interface definition (and common code) for "transaction" classes.
Definition: transaction_base.hxx:74
std::initializer_list< std::string_view > table_path
Representation of a PostgreSQL table path.
Definition: connection.hxx:121
void prepare(zview name, zview definition)
Define a prepared statement.
Definition: connection.hxx:533
std::string unesc_raw(zview text) const
Unescape binary data, e.g. from a table field or notification payload.
Definition: connection.hxx:611
Marker-type wrapper: zero-terminated std::string_view.
Definition: zview.hxx:37
connection(char const options[])
Connect to a database, using options string.
Definition: connection.hxx:188
std::string encrypt_password(char const user[], char const password[])
Encrypt a password.
Definition: connection.cxx:95
connection(zview options)
Connect to a database, using options string.
Definition: connection.hxx:195
Internal items for libpqxx' own use. Do not use these yourself.
Definition: composite.hxx:73
constexpr char const * c_str() const noexcept
Either a null pointer, or a zero-terminated text buffer.
Definition: zview.hxx:85