Releases: jtv/libpqxx
libpqxx 7.9.2: sundry fixes.
Here's what's new in this release:
- Fix CMake documentation install. (#848)
- Bump gcc/clang/postgres minimum version requirements.
- Another fix to the readthedocs documentation build. (#845)
- Remove obsolete CMake workaround kludges. (#851, #866, #867, #869)
- Remove obscure deprecated
stream_to
constructor that never worked. (#853) - Support reading a field as an SQL array using
as_sql_array()
. (#841) - Make row iterator a proper
random_access_iterator
. (#846) - Downgrade result iterator to "bidirectional"; was never really RA. (#846)
You may wonder why result iterators are no longer random access iterators. Turns out they never were! That's because if you have a result iterator i
, referring to a row, then i[n]
in libpqxx refers to field n
in that row. The definition for random access iterators expects it to mean *(i+n)
instead.
libpqxx 7.9.1: Re-do documentation
Documentation on ReadTheDocs was broken as of 7.9.0 (see #802). I rebuilt the whole thing from scratch β both local documentation builds and the ones on readthedocs. I think the new build is actually simpler than it was, which I hope will make it less sensitive to changes on ReadTheDocs or in dependencies.
What else changed?
- Fix bad conversion of array of empty strings to string. (#816)
- Move
[[likely]]
feature check back to compile time, to speed up configure. - Support
[[assume(...)]]
. - Fix
throw_null_conversion
compile error when converting enums. (#807) - Fix memory leak when failing to connect.
- Improve introductory docs for connections and transactions.
- No more autodetection of doxygen etc. Run it, or don't.
- Docs build now disabled by default; use
--enable-documentation
to change.
libpqxx 7.9.0: important fixes and new features
This is a pretty big release. As things stand, this looks to be the last release which supports C++17. The plan is to move on to libpqxx 8.0 next, which will require C++20 as a baseline.
Here's what's changed.
Assertion failure while streaming data
There was a bug that triggered an assertion failure when a row in a streaming query result ended in a null string.
The assertions in the code were just a little too strict. It amazes me that this took to long to surface. It has now been fixed.
New type aliases for binary data
We've been using std::basic_string<std::byte>
and std::basic_string_view<std::byte>
to represent binary data. But @tambry noted that compilers aren't actually required to support this! Worse, libc++18 had already marked it as deprecated.
The authors seem to have changed their minds about that, but Raul contributed a fix anyway. After all the problem may well pop up again.
And so, from libpqxx 7.9.0 onwards, to represent binary data coming from or going into the database, use the new type aliases pqxx::bytes
(for a std::string
of std::byte
) and pqxx::bytes_view
(for a std::string_view
of std::byte
).
If your environment supports the old types, these are just aliases for those, and nothing changes. But if it doesn't, then the aliases will refer to slightly different types that work around the problem. (The alternative definitions use a custom char_traits
. The fine print in the C++ standard said that you need this, and that the library is not obligated to offer a generic definition of these traits for std::byte
.)
Consistent library naming in CMake
Building CMake projects using libpqxx became a little easier. Thanks to @alexv-ds, you can now just use shared_link_libraries([...] libpqxx::pqxx)
.
The library name used to vary depending on whether you use find_package()
or add_subdirectory()
to add libpqxx to your project. Now it's just always libpqxx::pqxx
.
Exception-related link errors
If you had a libpqxx built in C++17, and linked it into a project built using C++20, or vice versa, you'd get a lot of link errors about missing classes. They were related to exceptions, such as std::runtime_error
.
Linking code built in one C++ version to code built in another is categorically dangerous. Please don't do it. There is no guarantee that it will work. Sadly though all package managers deal with this issue by sticking their heads in the sand.
It turns out that in practice the linking often worked, and various pre-built packaged versions of libpqxx shipped just one binary for all C++ versions. If you built your project in a different C++ version than was used to build libpqxx, two recent changes conspired to break your build:
- For C++20 and up, I added
source_location
information to exceptions. If your compiler didn't support that, you just didn't get it β but it affected how an exception object was laid out in memory. - Instead of generating a header listing which C++ features were available when you built libpqxx, I just detected features at compile time. But that breaks down when the language changes between inbetween the libpqxx build and your own project's build!
The new release works around this using all-new code to generate a configuration header at build configuration time. The enw code is much more regular, and easier for me to extend and maintain. This should make it easier to add support for most new C++ features in the future. I also believe the build became just slightly faster.
Conversion from std::string_view
to SQL string
Converting a std::string_view
to an SQL string never actually worked. It wasn't a priority in part because pqxx::zview
is likely to be much faster.
Still, this was an annoying irregularity and it has been fixed. You can now pass a std::vector<std::string_view>
to a prepared statement, for example.
Expect future libpqxx versions to be a bit more liberal in allowing conversions of various view types. Which does mean that...
- sometimes the conversion may do a bit of extra work under the bonnet and it will be up to you to avoid this when performance is critical; and
- it will be your responsibility to ensure that the data underlying a view or span is still valid whenever you make use of its SQL conversion.
Parameterised versions of query()
etc.
It has long bothered me that libpqxx has separate functions for executing a query, and for executing a query with parameters.
There are good reasons why you can't just pass any additional arguments to these functions and have them all converted into SQL parameters. It makes it easier to write code that doesn't mean what you might expect. It also complicates overloading, especially in a future where every query execution function also takes an implicit std::source_location
to improve error reporting.
As of libpqxx 7.9.0 however you can now pass a pqxx::params
when executing a query, and it will be unambiguously clear that it should be interpreted as a bundle of SQL parameters.
Streaming queries and C++20 pipelines
A streaming query can now act as a std::input_iterator
. This removes an obstacle to building C++20 statement pipelines using streaming queries.
Clearer documentation for defining your own data types
The updated documentation makes it a bit easier to see how to go about defining SQL conversions for your own data types, so you can convert them between their SQL and C++ representations.
These conversions are particularly important when you want to pass them to parameterised or prepared statements.
Support for std::span
as SQL arrays
This is still somewhat experimental, but libpqxx 8.0 will rely a lot more on std::span
.
Thanks to @alexolog and @fallenworld1 you should now be able to pass any std::span
(over a supported type of course) as a parameter to a prepared or parameterised statement, and it will automatically convert into an SQL array.
Support for PQfsize()
and PQfmod()
You can now query a column's storage size and type modifier. This code was contributed by @TeamPlatform1.
These are only useful for low-level coders. Touch only if you know what you're doing.
Thanks
As you can see, various code changes have been contributed directly by libpqxx users. Others were requested in bug tickets. It would be a bit redundant for me to name them all here, but I am grateful: after all a good bug report is not so much a "customer complaint" as it is real-world feedback on what can be improved.
Further thanks go out to everyone who contributed, and not to forget β the tireless @tt4g and @KayEss who have stepped in to help time and again when people ran into problems.
libpqxx 7.8.1: platform-specific build fixes
Fixes two platform-specific build problems in 7.8.0:
Microsoft Visual Studio had been complaining loudly in C++20 mode when we included the deprecated header <ciso646>
. But without that header, it turns out that Microsoft Visual Studio in C++17 mode can't compile libpqxx. So now we include the header only when compiling in C++17 mode.
The configure
script built using autoconf did not support Apple's M1 and M2 ARM CPUs. Regenerating the script with a newer autoconf fixed that.
libpqxx 7.8.0: massive feature release
Welcome to libpqxx 7.8.0. Lots of goodies for you. Probably enough that I could have called it 8.0 β except libpqxx 8.0 is going to require C++20. For now you're still fine with C++17.
In 7.8 you get, among other things:
- Streaming large data sets now benchmarks faster than similar C/libpq code!
- New
array
class for easier parsing of SQL arrays. - Deprecating
stream_from
. Usetransaction_base::stream()
. - Use
array_parser
only on comma-separated types, i.e. most of them. (#590) - Bumping requirements versions: need postgres 10.
- Fix
array_parser
bug when parsing semicolon in an unquoted string. - Make some
zview
constructorsnoexcept
ifstring_view
does it. - Handle result status code for starting streaming replication. (#631)
- Faster text decoding and escaping in data streaming. (#601)
- Deprecate
basic_fieldstream
andfieldstream
. - Deprecate
<<
operator inserting a field into anostream
. - New string conversion fields:
converts_to_string
&converts_from_string
. - Support
std::optional<std::string_view>
etc. instream_to
. (#596) - Remove support for single-quoted array/composite elements. No such thing!
- Work around build warning in MinGW: include
winsock2.h
beforewindows.h
. - If CMake can't find libpq, fall back to pkg-config. (#664)
- Work around spurious compile error on g++ pre-gcc-10. (#665)
- Include
<pqxx/range>
and<pqxx/time>
headers in<pqxx/pqxx>
. (#667) - Don't use
std::function
as deleter for smart pointers. - Work around gcc compile error with regex + address sanitizer + analyzers.
- Fix "double free" on exit when built as shared library on Debian. (#681)
- Stop including
<ciso646>
; should be built into compilers. (#680) - New
broken_connection
exception subclass:protocol_violation
. (#686) - Retired unused
blob_already_exists
exception class. (#686) - Support for
PQinitOpenSSL()
. (#678) - Slightly more helpful error for unsupported conversions. (#695)
- Replace some C++ feature tests with C++20 feature macros.
- Support moving of
stream_to
. (#706) - Incorporate
source_location
in exceptions.
There were some other small tweaks as well. If you implement the text conversions for your own types, there are two new fields that your string_traits
specialisation: converts_to_string
and converts_from_string
. These are booleans that should say whether the string_traits
class implements conversion, respectively, from the type to a string; and from a string to the type.
Enjoy this one! I'm sure somebody will find a problem, with so many changes, in which case we'll to a 7.8.1 soon.
7.7.5
= libpqxx 7.7.5: build fixes =
This patch update fixes the configure
-based libpqxx install, and some of applications:
make install
after aconfigure
-based build forgot to install some headers.- The
<pqxx/pqxx>
header now also includes<pqxx/range>
and<pqxx/time>
.
libpqxx 7.7.4: making querying sensible again
This comes as a patch update, but it's a pretty big thing: libpqxx 7.7.4 comes with new, more convenient ways to query data.
In many cases you can simply forget about the pqxx::result
class. Instead, use a transaction's "query" functions (query()
, query1()
, query01()
, query_n()
, query_value()
) to execute an SQL query and go straight to the result data, converted into the C++ types of your choice. Or use for_query()
to execute a query and on each row, invoke a callback you provide.
As a high-performance alternative, you can stream()
your query. This works much like query()
, except it starts iterating rows as soon as they come in (where query()
waits for the full result first) and the rows come faster. Initial startup is a bit slower than with query()
, but when you're expecting a lot of rows, it's likely to be faster and use less memory.
And then there's the classic "exec" functions (exec()
, exec0()
, exec1()
, exec_n()
). These return pqxx::result
objects, apart from exec1()
which returns a pqxx::row
for convenience. Use these only when you expect no data rows, or when you need the result's metadata, such as the number of rows affected by an UPDATE statement.
I'd be interested to hear about your experiences! Do you still need pqxx::result
at all in your application? Feel free to file a bug giving me some feedback.
libpqxx 7.7.3: Few features, still lots of goodness
This is mostly a bug-fix release. But also, it continues reorganising how libpqxx headers include each other. It's clearer and simpler now, it's easier to get right, and also, it seems to compile faster. Oh, and there's a new way to iterate over rows in a result or a streamed query.
Here's what else has changed:
- Fix up more damage done by auto-formatting.
- New
result::for_each()
: simple iteration and conversion of rows. (#528) - Similarly,
transaction_base::for_each()
β stream a query and run a callback on each row. - Add some missing headers in
<pqxx/pqxx>
. (#551) - More strictness in
header-pre.hxx
/header-post.hxx
checking. - Disallow nesting of
ignore-deprecated
blocks. - Deprecate
exec
functions'desc
parameter. - Fix
placeholders
documentation. (#557) - Strip
const
and references fromvalue_type
. (#558) - Get tests running on appveyor. (#560)
- Fix broken nonblocking connection on Windows. (#560)
This release may break some things for you:
- If you included the wrong libpqxx headers directly into your own code, you will get an error message about it. Include only the
<pqxx/something>
headers yourself, not any of the.hxx
ones. - The
exec()
query execution functions no longer accept adesc
(description) argument. In C++20, we'll replace that withstd::source_location
so that we can automatically show the location in the source code where the failing query was issued. Or optionally, some different location that you pass explicitly.
libpqxx 7.7.2: re-do of 7.7.1.
Sorry, the 7.7.1 release was a dud. Rushed it, after bedtime, somebody talking at me. Try 7.7.2 instead.
Here's the 7.7.1 changes again:
The configure
script no longer tries to tell your compiler what C++ language version it should compile. If you want a specific C++ version, you need to pass the right options to the compiler. Otherwise, you get your compiler's default C++ version.
Also:
- Fix digit_to_number not being found on some compilers. (#518, #519)
- In audit mode, define
_FORTIFY_SOURCE
to enable some extra checks. - Make more functions
constexpr
. Nothing particularly useful though. - Make more functions
noexcept
. - Move constructor & move assignment for
result
. - Deprecate
set_variable
/get_variable
ontransaction_base
. (Design had unearthed warts in SQL variables, which were later fixed.) - Set/get session variables on connection:
set_session_var
/get_var
. - Set/get local variables: execute SQL statements.
- When using
select()
, include<winsock2.h>
if available. (#548) - Fix those pointless MSVC warnings at last.
- Fix when cross-compiling using MinGW and CMake. (#548, #550)
I also reorganised the way libpqxx #includes its own headers. You may find that builds are a bit faster.
libpqxx 7.7.1: Choose C++ version yourself. Plus various fixes.
The main change in libpqxx 7.7.1 is that the configure
script no longer tries to tell your compiler what C++ language version it should compile. If you want a specific C++ version, you need to pass the right options to the compiler. Otherwise, you get your compiler's default C++ version.
There are many other changes:
- Finally fix a long-standing silly warning in autogen.
- Fix
digit_to_number
not being found on some compilers. (#518, #519) - In audit mode, define
_FORTIFY_SOURCE
to enable some extra checks. - Make more functions
constexpr
. Nothing particularly useful though. - Make more functions
noexcept
. - Move constructor & move assignment for
result
. - Support LGTM.com and Facebook "infer" static analysis.
- Deprecate
set_variable
/get_variable
ontransaction_base
. (Design had unearthed warts in SQL variables, which were later fixed.) - Set/get session variables on
connection
:set_session_var
/get_var
. - Set/get local variables: execute SQL statements.
- When using
select()
, include<winsock2.h>
if available. (#548) - Library includes its own headers differently. Simpler, compiles faster.
- Fix those pointless MSVC warnings at last.
- Extract waiting functions into separate module.
- Fix when cross-compiling using MinGW and CMake. (#548, #550)
I also reorganised the way libpqxx #include
s its own headers. You may find that builds are a bit faster.