wiki:WikiStart

Version 38 (modified by jtv, 13 years ago) (diff)

--

libpqxx is the official C++ API for writing client programs that talk to the PostgreSQL database management system. (If that's too verbose, call it by its shorter name, postgres).

For those who arrived at this page through http://pqxx.tk/: that domain name may disappear at some point in the future. Please use http://pqxx.org/ instead, or bookmark this page.

2006-05-27: New string-escaping API

Important note to existing users: a bug has been discovered in the string-escaping functions of libpq, the C-level library underlying libpqxx, that can cause trouble with non-ASCII characters. This can cause applications to fail on some non-ASCII inputs (and depending on their locale settings). This is also a security hole.

To deal with the problem, the sqlesc() functions have been replaced with a set of similar new functions, called simply "esc()," in the transaction classes. So please, where previously you wrote

X = T.exec("SELECT title FROM books WHERE author='" + sqlesc(writer) + "'");

...to prevent accidents, you should now write:

X = T.exec("SELECT title FROM books WHERE author='" + T.esc(writer) + "'");

A similar change will soon be made with the escape_binary() functions. Please update your libpq as soon as possible, and rebuild libpqxx if necessary!

Finding Everything

Where What
Sales Pitch Why this library should interest you
Using This Site The various services offered by this development site
Download Page Source tarballs (no binaries; those depend on your individual platform)
FAQ Frequently Asked Questions, and their answers
Online Documentation Wiki and copies of packaged documentation
Bug Tracker Known bugs and requests (as in View Tickets option in top button bar)
Bugs by Milestone Bugs and feature requests, but ordered by milestone
Reporting Bugs How to report a problem or request a new feature
Mailing Lists (Still hosted on the old libpqxx site)
Other Projects Other open-source development projects hosted on thaiopensource.org
Old Site Old home page for libpqxx development
Author and Contributors Who made all this?

For issues not suitable for the mailing list or bug tickets, contact the author at jtv@xs4all.nl.

Also, you may want to have a look at the other open source projects hosted on this site.

Technical Overview

This library works on top of the C-level API library, libpq. You will need libpq in order to use libpqxx.

The first thing you're likely to notice in programming with libpqxx is that unlike other libraries, it revolves entirely around transactions. Transactions are a central concept in database management systems, but they are widely underappreciated among application developers. Another well-known open source database system, MySQL, never even got around to implementing them at all in their own engine, relying on a third-party replacement engine (now owned by Oracle) to provide this functionality instead.

It may sometimes be possible to build limited applications reliably without serious use of transactions. More usually, however, transactions are designed without transactions simply because the developers aren't aware of the risks they are taking, and any data loss is rare or small enough not to be noticed. That kind of design was not considered acceptable for libpqxx.

With conventional database APIs, you issue commands and queries to a database session or connection, and optionally create the occasional transaction. In libpqxx you start a transaction inside the connection first, do your SQL work using that transaction, then commit the transaction when it's complete. There are several types of transactions with various "quality of service" properties; if you don't really want to use transactions at all, one of the available transaction types is called nontransaction. This transaction type provides classic, nontransactional behaviour.

Every command or query issues a result object, which is really a smart pointer so it can be copied around without incurring much cost in terms of performance. No need to write special code to check these for success; error conditions are converted to regular C++ exceptions. Result objects can be kept around for as long as they are needed, completely separate from the connections and transactions that originated them.


GTF Contributor