13 #ifndef PQXX_H_CONNECTION
14 #define PQXX_H_CONNECTION
16 #include "pqxx/compiler-public.hxx"
17 #include "pqxx/internal/compiler-internal-pre.hxx"
23 #include <string_view>
25 #include "pqxx/errorhandler.hxx"
26 #include "pqxx/except.hxx"
27 #include "pqxx/prepared_statement.hxx"
28 #include "pqxx/strconv.hxx"
29 #include "pqxx/util.hxx"
30 #include "pqxx/zview.hxx"
68 class connection_dbtransaction;
69 class connection_errorhandler;
70 class connection_largeobject;
71 class connection_notification_receiver;
72 class connection_pipeline;
73 class connection_sql_cursor;
74 class connection_stream_from;
75 class connection_stream_to;
76 class connection_transaction;
77 class const_connection_largeobject;
84 [[nodiscard]] std::string PQXX_LIBEXPORT
88 [[nodiscard]]
inline std::string
158 connection(connection &&rhs);
166 catch (std::exception
const &)
184 [[nodiscard]]
bool PQXX_PURE is_open() const noexcept;
187 void process_notice(
char const[]) noexcept;
189 void process_notice(std::
string const &msg) noexcept
191 process_notice(
zview{msg});
197 void process_notice(
zview) noexcept;
200 void trace(std::FILE *) noexcept;
212 [[nodiscard]]
char const *dbname()
const;
216 [[nodiscard]]
char const *username()
const;
219 [[nodiscard]]
char const *hostname()
const;
222 [[nodiscard]]
char const *port()
const;
225 [[nodiscard]]
int PQXX_PURE backendpid() const noexcept;
243 [[nodiscard]]
int PQXX_PURE sock() const noexcept;
249 [[nodiscard]]
int PQXX_PURE protocol_version() const noexcept;
264 [[nodiscard]]
int PQXX_PURE server_version() const noexcept;
288 [[nodiscard]] std::
string get_client_encoding() const;
295 void set_client_encoding(std::
string const &encoding)
297 set_client_encoding(encoding.c_str());
304 void set_client_encoding(
char const encoding[]);
307 [[nodiscard]]
int PQXX_PRIVATE encoding_id()
const;
327 void set_variable(std::string_view var, std::string_view value);
333 std::string get_variable(std::string_view);
366 int await_notification();
378 int await_notification(
long seconds,
long microseconds);
409 char const user[],
char const password[],
char const *algorithm =
nullptr);
410 [[nodiscard]] std::string
466 void prepare(
char const name[],
char const definition[]);
468 void prepare(std::string
const &name, std::string
const &definition)
470 prepare(name.c_str(), definition.c_str());
486 void prepare(
char const definition[]);
490 void unprepare(std::string_view name);
500 [[nodiscard]] std::string adorn_name(std::string_view);
512 [[nodiscard]] std::string
esc(
char const text[], std::size_t maxlen)
const
514 return esc(std::string_view(text, maxlen));
518 [[nodiscard]] std::string
esc(
char const text[])
const
520 return esc(std::string_view(text));
527 [[nodiscard]] std::string esc(std::string_view text)
const;
530 [[nodiscard]] std::string
531 esc_raw(
unsigned char const bin[], std::size_t len)
const;
537 [[nodiscard]] std::string
unesc_raw(std::string
const &text)
const
539 return unesc_raw(text.c_str());
548 return unesc_raw(text.
c_str());
555 [[nodiscard]] std::string unesc_raw(
char const text[])
const;
558 [[nodiscard]] std::string
559 quote_raw(
unsigned char const bin[], std::size_t len)
const;
562 [[nodiscard]] std::string quote_name(std::string_view identifier)
const;
568 template<
typename T>[[nodiscard]]
inline std::string quote(T
const &t)
const;
570 [[nodiscard]] std::string quote(
binarystring const &)
const;
596 [[nodiscard]] std::string
597 esc_like(std::string_view text,
char escape_char =
'\\')
const;
632 [[nodiscard]] std::vector<errorhandler *> get_errorhandlers()
const;
641 [[nodiscard]] std::string connection_string()
const;
650 void init(
char const options[]);
652 void wait_read()
const;
654 void wait_read(
long seconds,
long microseconds)
const;
657 internal::pq::PGresult *pgr, std::shared_ptr<std::string>
const &query);
659 void PQXX_PRIVATE set_up_state();
661 int PQXX_PRIVATE PQXX_PURE status() const noexcept;
668 std::
size_t esc_to_buf(std::string_view text,
char *buf) const;
670 friend class internal::gate::const_connection_largeobject;
671 char const *PQXX_PURE err_msg() const noexcept;
673 void PQXX_PRIVATE process_notice_raw(
char const msg[]) noexcept;
675 result exec_prepared(std::string_view statement, internal::params const &);
678 void check_movable() const;
680 void check_overwritable() const;
682 friend class internal::gate::connection_errorhandler;
683 void PQXX_PRIVATE register_errorhandler(
errorhandler *);
684 void PQXX_PRIVATE unregister_errorhandler(
errorhandler *) noexcept;
686 friend class internal::gate::connection_transaction;
687 result PQXX_PRIVATE exec(std::string_view);
688 result PQXX_PRIVATE exec(std::shared_ptr<std::
string>);
692 friend class internal::gate::connection_stream_from;
693 std::pair<std::unique_ptr<
char, std::function<
void(
char *)>>, std::
size_t>
694 PQXX_PRIVATE read_copy_line();
696 friend class internal::gate::connection_stream_to;
697 void PQXX_PRIVATE write_copy_line(std::string_view);
698 void PQXX_PRIVATE end_copy_write();
700 friend class internal::gate::connection_largeobject;
701 internal::pq::PGconn *raw_connection()
const {
return m_conn; }
703 friend class internal::gate::connection_notification_receiver;
707 friend class internal::gate::connection_pipeline;
708 void PQXX_PRIVATE start_exec(
char const query[]);
709 bool PQXX_PRIVATE consume_input() noexcept;
710 bool PQXX_PRIVATE is_busy() const noexcept;
711 internal::pq::PGresult *get_result();
713 friend class internal::gate::connection_dbtransaction;
714 friend class internal::gate::connection_sql_cursor;
716 result exec_params(std::string_view query, internal::params const &args);
719 internal::pq::PGconn *m_conn =
nullptr;
726 using receiver_list =
729 receiver_list m_receivers;
740 template<typename T> inline std::
string connection::quote(T const &t)
const
750 std::string buf{
'\''};
751 buf.resize(2 + 2 * text.size() + 1);
752 auto const content_bytes{esc_to_buf(text, buf.data() + 1)};
753 auto const closing_quote{1 + content_bytes};
754 buf[closing_quote] =
'\'';
755 auto const end{closing_quote + 1};
764 PQXX_LIBEXPORT
void wait_read(internal::pq::PGconn
const *);
766 wait_read(internal::pq::PGconn
const *,
long seconds,
long microseconds);
767 PQXX_LIBEXPORT
void wait_write(internal::pq::PGconn
const *);
770 #include "pqxx/internal/compiler-internal-post.hxx"
connection(char const options[])
Definition: connection.hxx:144
int PQXX_PURE sock() const noexcept
Socket currently used for connection, or -1 for none. Use with care!
Definition: connection.cxx:205
std::string encrypt_password(char const user[], char const password[], char const *algorithm=nullptr)
Encrypt a password for a given user.
Definition: connection.cxx:575
char const * dbname() const
Name of database we're connected to, if any.
Definition: connection.cxx:496
std::string encrypt_password(char const user[], char const password[])
Encrypt a password.
Definition: connection.cxx:93
int PQXX_PURE server_version() const noexcept
What version of the PostgreSQL server are we connected to?
Definition: connection.cxx:217
The home of all libpqxx classes, functions, templates, etc.
Definition: array.hxx:26
int await_notification()
Wait for a notification to come in.
Definition: connection.cxx:949
void wait_write(internal::pq::PGconn const *)
Definition: connection.cxx:931
bool is_null(TYPE const &value) noexcept
Is value null?
Definition: strconv.hxx:307
int encoding_id() const
Get the connection's encoding, as a PostgreSQL-defined code.
Definition: connection.cxx:1017
error_verbosity
Error verbosity levels.
Definition: connection.hxx:97
char const * port() const
Server port number we're connected to.
Definition: connection.cxx:514
value_type const * data() const noexcept
Unescaped field contents.
Definition: binarystring.hxx:109
Definition: connection.hxx:67
std::string to_string(field const &value)
Convert a field to a string.
Definition: result.cxx:498
encoding_group enc_group(int libpq_enc_id)
Definition: encodings.cxx:585
void prepare(char const name[], char const definition[])
Define a prepared statement.
Definition: connection.cxx:599
void set_client_encoding(std::string const &encoding)
Set client-side character encoding, by name.
Definition: connection.hxx:295
Run-time failure encountered by libpqxx, similar to std::runtime_error.
Definition: except.hxx:44
char const * username() const
Database user ID we're connected under, if any.
Definition: connection.cxx:502
connection & operator=(connection const &)=delete
connection & operator=(connection &&rhs)
Move assignment.
Definition: connection.cxx:157
Private namespace for libpqxx's internal use; do not access.
Definition: connection.hxx:61
void check_version()
Definition: util.hxx:143
std::string adorn_name(std::string_view)
Suffix unique number to name to make it unique within session context.
Definition: connection.cxx:973
connection()
Definition: connection.hxx:139
void cancel_query()
Attempt to cancel the ongoing query, if any.
Definition: connection.cxx:411
constexpr char const * c_str() const noexcept
Either a null pointer, or a zero-terminated text buffer.
Definition: zview.hxx:53
int PQXX_PURE protocol_version() const noexcept
What version of the PostgreSQL protocol is this connection using?
Definition: connection.cxx:211
char const * hostname() const
Address of server, or nullptr if none specified (i.e. default or local)
Definition: connection.cxx:508
std::string quote_name(std::string_view identifier) const
Escape and quote an SQL identifier for use in a query.
Definition: connection.cxx:829
Exception class for failed queries.
Definition: except.hxx:80
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
void set_verbosity(error_verbosity verbosity) noexcept
Set session verbosity.
Definition: connection.cxx:427
Definition: notification.hxx:56
std::string quote_raw(unsigned char const bin[], std::size_t len) const
Escape and quote a string of binary data.
Definition: connection.cxx:817
int PQXX_PURE backendpid() const noexcept
Process ID for backend process, or 0 if inactive.
Definition: connection.cxx:190
connection(zview options)
Definition: connection.hxx:150
void prepare(zview name, zview definition)
Definition: connection.hxx:473
Exception class for lost or failed backend connection.
Definition: except.hxx:69
bool PQXX_PURE is_open() const noexcept
Is this connection open at the moment?
Definition: connection.cxx:273
Internal error in libpqxx library.
Definition: except.hxx:159
~connection()
Definition: connection.hxx:160
std::string quote(T const &t) const
Represent object as SQL string, including quoting & escaping.
Definition: connection.hxx:740
void prepare(zview definition)
Definition: connection.hxx:487
size_type size() const noexcept
Size of converted string in bytes.
Definition: binarystring.hxx:81
void close()
Explicitly close the connection.
Definition: connection.cxx:635
int get_notifs()
Check for pending notifications and take appropriate action.
Definition: connection.cxx:447
Database feature not supported in current setup.
Definition: except.hxx:208
std::string encrypt_password(zview user, zview password, zview algorithm)
Definition: connection.hxx:411
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:512
std::string const & channel() const
The channel that this receiver listens on.
Definition: notification.hxx:69
void set_variable(std::string_view var, std::string_view value)
Set session variable, using SQL's SET command.
Definition: connection.cxx:223
void wait_read(internal::pq::PGconn const *)
Definition: connection.cxx:911
std::vector< errorhandler * > get_errorhandlers() const
Return pointers to the active errorhandlers.
Definition: connection.cxx:554
Invalid argument passed to libpqxx, similar to std::invalid_argument.
Definition: except.hxx:173
Connection to a database.
Definition: connection.hxx:137
std::string connection_string() const
Return a connection string encapsulating this connection's options.
Definition: connection.cxx:1078
std::string esc_like(std::string_view text, char escape_char='\\') const
Escape string for literal LIKE match.
Definition: connection.cxx:841
std::string esc(char const text[]) const
Escape string for use as SQL string literal on this connection.
Definition: connection.hxx:518
connection(std::string const &options)
Definition: connection.hxx:141
std::string esc_raw(unsigned char const bin[], std::size_t len) const
Escape binary string for use as SQL string literal on this connection.
Definition: connection.cxx:792
Interface definition (and common code) for "transaction" classes.
Definition: transaction_base.hxx:69
std::string get_variable(std::string_view)
Read session variable, using SQL's SHOW command.
Definition: connection.cxx:235
void process_notice(char const[]) noexcept
Invoke notice processor function. The message should end in newline.
Definition: connection.cxx:290
std::string unesc_raw(std::string const &text) const
Unescape binary data, e.g. from a table field or notification payload.
Definition: connection.hxx:537
Error in usage of libpqxx library, similar to std::logic_error.
Definition: except.hxx:166
std::string get_client_encoding() const
Get client-side character encoding, by name.
Definition: connection.cxx:992
std::string unesc_raw(zview text) const
Unescape binary data, e.g. from a table field or notification payload.
Definition: connection.hxx:546
Binary data corresponding to PostgreSQL's "BYTEA" binary-string type.
Definition: binarystring.hxx:54
void prepare(std::string const &name, std::string const &definition)
Definition: connection.hxx:468
connection(connection const &)=delete
void trace(std::FILE *) noexcept
Enable tracing to a given output stream, or nullptr to disable.
Definition: connection.cxx:329
char const * name_encoding(int encoding_id)
Definition: encodings.cxx:579
Base class for error-handler callbacks.
Definition: errorhandler.hxx:53
void unprepare(std::string_view name)
Drop prepared statement.
Definition: connection.cxx:615