release: 0.2.0-beta.0

[Hoverbear]

Features

• The pgx SQL generation system has been rewritten! It now uses the proc macro system and has several breaking changes. Please refer to the migration guide below. (Introduce a more robust SQL generator #165, Enable new SQL generator on Mac #197)
• The PostgreSQL uuid type is now supported! (Added support for uuid PostgreSQL type #172)
• cargo pgx test now accepts an optional testname. cargo pgx test specific::path works just like cargo test! (feat: support testname in cargo pgx test #186)
• pgx-pg-sys now suggests you install rustfmt if you don't have it. (Suggest rustfmt install #193)
• cargo pgx schema will now emit informational messages if extension Cargo.toml settings are not what is expected. (Verify cargo toml settings #209)
• cargo pgx test now has a --workspace argument matching the equivalent on cargo test. (Don't run all tests in cargo pgx test #169)

Other changes

• fix: Marked several functions as unsafe as they had undefined behavior when passed invalid pointers. (fix: mark item_pointer_is_valid unsafe #210, fix: Mark is_a unsafe #216, fix: Mark several functions as unsafe. #217, fix: mark called_as_trigger as unsafe #223, fix: Mark PgTupleDesk::from_pg_copy unsafe #224, fix: Mark get_getarg_type unsafe #226)
• Type oids don't need to be looked up in functions that don't use them. (Don't look up the type oid for types that never use it #168)
• Added an aggregate example. (feat: add aggregate example #187)
• Updated many of our dependencies. (Update deps #191)
• More documentation has been added to several macros and SQL generation related types. (Document pgx::info and related macros more #192, Expand documentation for pg_module_magic #158, chore: fix some docs links #219)
• An articles/ directory now exists in the repo and includes links to different articles written about pgx. (Articles #198)
• Document our MSRV (Document minimum stable Rust version (fixes #155) #157)

Migration Guide

1. Update your cargo-pgx: cargo install --force cargo-pgx --version 0.2.0-beta.0

2. In your Cargo.toml, set crate-type to include "rlib" and profile.dev.lto to be "thin":

   [lib]
   crate-type = ["cdylib", "rlib"]
   
   [profile.dev]
   lto = "thin"

3. Tell cargo-pgx to force update your .cargo/ and src/bin files it needs: cargo pgx schema -f

4. Remove any sql/*.generated.sql files, as well as the load-order.txt.

5. For each sql/*.sql remaining, insert extension_sql_file!("../sql/that_file.sql"); into your src/lib.rs

6. If the files depend on entities which already exist, you might need to set a requires attribute:

   extension_sql_file!("../sql/that_file.sql", requires = [ dogs::parts::Floof, some_fn, ]);

7. For any mod floof { fn boop() { todo!() } } style blocks you were using to infer schema name (making that function floof.boop), decorate the schema with #[pg_schema]:

   #[pg_schema]
   mod floof {
       fn boop() {
           todo!()
       }
   }

8. For any functions have a custom sql block for (like below), update that to use pgxsql now:

   /// ```sql <-- Change this to `pgxsql`
   /// CREATE OR REPLACE FUNCTION  ....
   /// ```
   #[pg_extern]
   fn dot_dot_dot() { todo!() }

9. Run cargo pgx schema again!

If you have any trouble, try running cargo pgx schema -v and investigating the output. We made sure to update the cargo doc output of pgx with updated usage for the various macros and derives, they might have some advice, too.

You can ask us questions via issues here or Discord if you get stuck.

Thanks!

Thanks to @JLockerman (from @timescale) & @kpumuk for contributions! Also thanks to our early testers @rustprooflabs and @comdiv.