Update version to 0.7.0-beta.0

[eeeebbbbrrrr]

This is pgx v0.7.0-beta.0. Other than pgx' initial release, this is our biggest release yet! It contains a number of safety improvements, segfault fixes, API changes, minor performance improvements, and an overhauled Spi interface now with prepared statements and cursors!

Quite a number of people have contributed to this release, so a big thank you is necessary right here at the top. Some notable names are @yrashk and @EdMcBane for their work on Spi. And a shout-out to the new contributors: @jaskij, @kianmeng, and @ChuckHend.

To use this beta release, install cargo-pgx by version: $ cargo install cargo-pgx --version 0.7.0-beta.0 --locked and make sure to update your extension crate dependencies to use 0.7.0-beta.0 too.

API Changes

v0.7.0 contains some backwards incompatible API changes and your extension code may need to be updated as a result. Leaning on the compiler should help you through the changes.

• pgbox::WhoAllocated<T> doesn't need to be generic over any T by @eeeebbbbrrrr in WhoAllocated<T> doesn't need to be generic over any T #901
• Lift UnwindSafe + RefUnwindSafe bounds in PgMemoryContexts by @eeeebbbbrrrr in Lift UnwindSafe + RefUnwindSafe bounds in PgMemoryContexts #986
• impl Clone for PgTupleDesc by @mhov in clone implementation for PgTupleDesc #962
• AnyElement::into() needs to be unsafe by @eeeebbbbrrrr in AnyElement::into() needs to be unsafe #928
• Lets make pg_guard_ffi_boundary public for everyone to enjoy! by @eeeebbbbrrrr in Lets make pg_guard_ffi_boundary public for everyone to enjoy! #942
• Mark many functions unsafe that should be by @eeeebbbbrrrr in Mark functions unsafe that should be #995
• allow #![forbid(unsafe_op_in_unsafe_fn)] to work with pgx-generated… by @eeeebbbbrrrr in allow #![forbid(unsafe_op_in_unsafe_fn)] to work with pgx-generated… #996
• pg_sys::Oid is now a newtype wrapper around a u32 by @workingjubilee in Update version to 0.7.0-beta.0 #1000 & impl Display for pg_sys::Oid #1004

Spi

Spi has received a major overhaul in v0.7.0. It now supports cursors, prepared statements, and runtime datum conversion error detection.

Much of the Spi API has been overhauled in a backwards-incompatible way, and is too much to document in release notes. However, the biggest change is that the various getter functions on Spi and SpiTupleTable and SpiHeapTupleData now return pgx::spi::Result<Option<T>>. The error type is pgx::spi::Error and can not only report Postgres-specific SPI_ERROR_XXX errors from Postgres but also represent runtime situations where the requested Rust type T isn't compatible with the backing Datum type.

Cursor Support Changes

• Add support for Spi cursors by @EdMcBane in Add support for Spi cursors #579
• ensure multiple open SpiTupTables can coexist by @EdMcBane in :fix: ensure multiple open SpiTupTables can coexist #938
• Cursor API should not require &self mut by @yrashk in Cursor API should not require &self mut #934
• Minor code improvement for open_cursor by @yrashk in Minor code improvement for open_cursor #935

Prepared Statement Support

• Prepared statements and Query trait by @yrashk in Prepared statements and Query trait #885

Spi Statement "readonly" Management

• Make non-updating queries use readonly until transaction end unless there was a prior mutation by @yrashk/@eeeebbbbrrrr in Make non-updating queries use readonly unless there was a mutation before #963 & Extend Spi's understanding of "readonly" to transaction #992
• fix issue SpiClient::select not seeing changes from Spi::run in same transaction #983 by @eeeebbbbrrrr in fix issue #983 #984 (was replaced by Extend Spi's understanding of "readonly" to transaction #992)

Spi Error Handling

Because most Spi-related functions now return spi::Result<T>, pgx now knows how to convert a Result<T: IntoDatum, E: Any + Display> into a Datum. This means #[pg_extern]-style functions (including #[pg_test] functions) can now return a Result. This makes working with Spi much more "rust-like" and fluent.

If result is Ok then its payload is converted into a Datum. If the result is Err, then pgx will automatically raise a Postgres ERROR. Furthermore, if the Err variant's payload is a pgx ErrorReport, then that'll be raised, which can include a specific SQL error code, detail, hint, and context message.

The general work on Spi error handling happened in these PRs, with much help from @yrashk and @EdMcBane:

• Build upon Explicit error handling in SPI #902 by @yrashk: Spi Error Handling by @eeeebbbbrrrr in Build upon #902: Spi Error Handling #969
• Proper error handling for SPI by @eeeebbbbrrrr in Proper error handling for SPI #977
• Add type/oid details to Datum conversion errors by @EdMcBane in Add type/oid details to Datum conversion errors #985

And the generalized support for handling Results-as-Datums came in through:

• impl IntoDatum for Result<T: IntoDatum, E: Display> by @eeeebbbbrrrr in impl IntoDatum for Result<T: IntoDatum, E: Display> #972
• Change bounds on IntoDatum for Result<T, E> such that E: Any + Display by @eeeebbbbrrrr in Change bounds on IntoDatum for Result<T, E> such that E: Any + Display #973
• Support returning Result<TableIterator/SetOfIterator, E> by @eeeebbbbrrrr in Support returning Result<TableIterator/SetOfIterator, E> #975
• Fix a bug trying to return Result<pg_sys::Oid> by @eeeebbbbrrrr in Fix a bug trying to return Result<pg_sys::Oid> #976

General Cleanups

• Improve the safety documentation for pg_guard_ffi_boundary by @thomcc in Improve the safety documentation for pg_guard_ffi_boundary #957
• Fix typos by @kianmeng in Fix typos #959
• cargo-pgx: deny clippy::perf by @workingjubilee in cargo-pgx: deny clippy::perf #933
• Silence clippy in pgx-version-updater by @workingjubilee in Silence clippy in pgx-version-updater #930
• sql-entity-graph: fix clippy::if_same_then_else by @workingjubilee in sql-entity-graph: fix clippy::if_same_then_else #931
• Fix pgx-sql-entity-graph impls of derivable traits. by @thomcc in Fix pgx-sql-entity-graph impls of derivable traits. #929
• pgx-utils crate renamed to pgx-sql-entity-graph by @eeeebbbbrrrr in pgx-utils goes away! #911
• pgx-pg-sys: cshim: Makefile: user AR variable by @jaskij in pgx-pg-sys: cshim: Makefile: user AR variable #937
• Fully qualify all pgx symbol references during code generation by @eeeebbbbrrrr in Fully qualify all pgx symbol references during code generation #925
• fully qualify the path to #[pg_guard] during code generation by @eeeebbbbrrrr in fully qualify the path to #[pg_guard] #943
• Document and simplify cargo-pgx version matching requirement by @yrashk in Document and simplify cargo-pgx version matching requirement #964
• Remove specific versions from getting started section by @rustprooflabs in Remove specific versions from getting started section #991
• Revert "Revert "Replace rayon"" by @workingjubilee in Revert "Revert "Replace rayon"" #945
• localize some use statements by @eeeebbbbrrrr in localize some use statements  #944
• add doc to pg_test module in template by @ChuckHend in add doc to pg_test module in template #970
• fix compilation on arm by @eeeebbbbrrrr in fix compilation on arm #993
• Preliminary support for cross-compilation on Linux<-->Linux for x86_64 to aarch64 by @thomcc in Initial support and documentation for cross-compilation #1003

This one is particularly interesting as it now allows cargo test --all --features "pgXX ... ..." to work from a top-level workspace crate:

• Teach pgx-tests/src/framework.rs to detect cargo test feature arguments by @eeeebbbbrrrr in Teach pgx-tests/src/framework.rs to detect cargo test feature arguments #967

Stability, Correctness, and Performance

• Problem: can't use pg_guard on parameterized functions by @yrashk in Problem: can't use pg_guard on parameterized functions #918
• Handle panics in PgMemoryContexts::switch_to by @yrashk in Handle panics in PgMemoryContexts::switch_to #920
• Ensure setting owned memory context as current twice won't lead to problems (bugfix) by @yrashk in Ensure setting owned memory context as current twice won't lead to problems (bugfix) #956
• Improve error handling during code generation by converting some panics into syn::Errors by @thomcc in Improve error handling a bit, by converting some panics into syn::Errors #919
• Set returning #[pg_extern] functions can cause segfault by @eeeebbbbrrrr in Set returning #[pg_extern] functions can cause segfault #982
  • Move generated SRF code into managed code by @eeeebbbbrrrr in Move generated SRF code into managed code #987
• PgLwLock: skip releasing the lock when unwinding from an elog call in postgres code by @EdMcBane in PgLwLock: skip releasing the lock when unwinding from an elog call in postgres code #989
• :enh: bail out early in do_ereport if errstart returns false by @EdMcBane in :enh: bail out early in do_ereport if errstart returns false #980
• Rewrite StringInfo by @eeeebbbbrrrr in Rewrite string info #903
• Optimize our String/&str/Vec/&[u8] IntoDatum conversions by @eeeebbbbrrrr in Optimize our String/&str/Vec<u8>/&[u8] IntoDatum conversions #952

Feature Flags

• A pgx/no-schema-generation feature flag by @eeeebbbbrrrr in A no-schema-generation feature flag #915

When enabled, pgx will not generate any code related to the "sql entity graph", thereby causing cargo-pgx to generate an empty schema.

• Add a default pgx/cshim feature flag by @eeeebbbbrrrr in Add a default cshim feature flag #958
• The cshim feature should not be a default in pgx-pg-sys. by @eeeebbbbrrrr in The cshim feature should not be a default in pgx-pg-sys. #990

When enabled (which is the default), pgx (specifically, pgx-pg-sys) will compile its "cshim" code and have it statically linked into the extension. Disabling this feature flag might make pgx compilation easier for platforms where the necessary Postgres C extension build requirements aren't available, however you'll lose access to a few pgx modules: hooks, list, namespace and spinlock.

Our ultimate goal is to not have a "cshim" at all, and to that end much of the old "cshim" has been ported to Rust:

• Port c-shim.c heap_getattr, HeapTupleHeaderGetXmin, and HeapTupleHeaderGetRawCommandId to Rust by @eeeebbbbrrrr in Port c-shim.c heap_getattr, HeapTupleHeaderGetXmin, and HeapTupleHeaderGetRawCommandId to Rust #953
• Port c-shim.c pgx_GETSTRUCT and pgx_HeapTupleHeaderGetOid to Rust by @eeeebbbbrrrr in Port c-shim.c pgx_GETSTRUCT and pgx_HeapTupleHeaderGetOid to Rust #950
• Port various c-shim.c SET_VARSIZE* functions to Rust by @eeeebbbbrrrr in Port various c-shim.c SET_VARSIZE* functions to Rust #949
• PgMemoryContexts::get_context_for_pointer() is wildly unsafe. by @eeeebbbbrrrr in PgMemoryContexts::get_context_for_pointer() is wildly unsafe. #947
• Port c-shim.c's pgx_ereport() function to rust by @eeeebbbbrrrr in Port c-shim.c's pgx_ereport() function to rust #946
• Port various c-shim.c ARR_* functions to Rust by @eeeebbbbrrrr in Port various c-shim.c ARR_* functions to Rust #948

More Postgres Headers

• Add pg_tablespace catalog header by @jteplitz in Add pg_tablespace catalog header #974

CI Updates

• Fixes will-it-blend nightly by @BradyBonnette in Fixes will-it-blend nightly #916
• Adds unlocked cargo runs to Will It Blend CI by @BradyBonnette in Adds unlocked cargo runs to Will It Blend CI #966

New Contributors

• @jaskij made their first contribution in pgx-pg-sys: cshim: Makefile: user AR variable #937
• @kianmeng made their first contribution in Fix typos #959
• @ChuckHend made their first contribution in add doc to pg_test module in template #970

Full Changelog: v0.6.1...v0.7.0-beta.0

[workingjubilee]

Excellent!

May want to re-regenerate bindings?

[eeeebbbbrrrr]

Excellent!

May want to re-regenerate bindings?

Yeah, I need to re-create this branch since you just merged the Oid PR.

Which I'm doing now

[mhov]

congrats on 1000th PR