Skip to content

Made SPI query arguments type safe #1858

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 10 commits into from
Oct 28, 2024
Merged

Made SPI query arguments type safe #1858

merged 10 commits into from
Oct 28, 2024

Conversation

@YohDeadfall
Copy link
Contributor

@YohDeadfall YohDeadfall commented Sep 12, 2024

No description provided.

@YohDeadfall YohDeadfall mentioned this pull request Sep 12, 2024
Closed
@eeeebbbbrrrr
Copy link
Contributor

eeeebbbbrrrr commented Sep 12, 2024

&[][..] is not something you see every day. Why is it that &[] doesn't work?

@YohDeadfall
Copy link
Contributor Author

YohDeadfall commented Sep 12, 2024

I guess it's leftover from the time when I tried to play with generics and avoid a breaking change. That was required by the compiler for the type deduction, but can be reduced now.

@eeeebbbbrrrr
Copy link
Contributor

eeeebbbbrrrr commented Sep 12, 2024

I appreciate your efforts on this area of pgrx, btw.

Spi is incredibly hard to get right in C, and it’s not any easier in Rust.

eeeebbbbrrrr
eeeebbbbrrrr approved these changes Sep 16, 2024
View reviewed changes
Copy link
Contributor

@eeeebbbbrrrr eeeebbbbrrrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really nice, @YohDeadfall. Really nice.

Very clean.

Like @workingjubilee said somewhere, I think we'd want to hold this for v0.13, but I think this PR is a motivator for getting there quickly.

@workingjubilee
Copy link
Member

workingjubilee commented Oct 27, 2024

@YohDeadfall Can you resolve the conflicts?

@YohDeadfall
Copy link
Contributor Author

YohDeadfall commented Oct 27, 2024

Sure! Actually, I just wanted to write you about this pull request too (:

workingjubilee
workingjubilee approved these changes Oct 28, 2024
View reviewed changes
Copy link
Member

@workingjubilee workingjubilee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@workingjubilee workingjubilee merged commit ae0335b into pgcentralfoundation:develop Oct 28, 2024
4 checks passed
@YohDeadfall YohDeadfall deleted the type-safe-query branch October 28, 2024 09:00
@YohDeadfall YohDeadfall mentioned this pull request Oct 29, 2024
Merged
eeeebbbbrrrr pushed a commit that referenced this pull request Nov 20, 2024
@YohDeadfall
Changed args of prepare methods to be slices (#1933)
c1e5dd9 
Since there's an opportunity to break more things for `0.13` I decided
to improve the `prepare` and `prepare_mut` methods as well. The
motivation for that is the same as for #1858, `&[]` requires no heap
allocations on the heap if there's a fixed set of arguments.
@danielgerlag danielgerlag mentioned this pull request Feb 6, 2025
Closed
@eeeebbbbrrrr eeeebbbbrrrr mentioned this pull request Feb 24, 2025
Merged
eeeebbbbrrrr added a commit that referenced this pull request Feb 24, 2025
@eeeebbbbrrrr
Update version to 0.13.0 (#1984)
5a3b3b4 
Welcome to pgrx v0.13.0. The first update in a little bit, which makes
pgrx current with upstream dependencies, rust 1.85.0 (but not 2024
Edition, yet), and a slew of fixes and cleanups and community
contributions.

# Upgrading

You'll need to `cargo install cargo-pgrx --version 0.13.0 --locked` to
get the latest `cargo-pgrx` tool, and then you can run `cargo pgrx
upgrade` in your extension crates to update their dependencies.

# Breaking Changes

Generally, the only breaking changes in v0.13.0 are related to the
user-facing SPI APIs. In general, SPI functions that previously took a
Vec of Arguments now take a `&[DatumWithOid]`, with proper lifetime
bounds. This is a fairly straightforward, boilerplate to update to.

@YohDeadfall has done a lot of work on improving SPI's safety and it's
greatly appreciated!

# What's Changed

## `cargo-pgrx`

* fix a deadlock in `cargo pgrx install` during `get_git_hash()` by
@eeeebbbbrrrr in #1935
* `cargo pgrx test --runas` envar passing by @eeeebbbbrrrr in
#1674
* Search for sql upgrade scripts relative to the package manifest by
@tristan957 in #1979

## Build System

* use `allowlist_file` for bindgen by @usamoi in
#1922
* add `pg_config --libdir` to linker search path by @usamoi in
#1932
* lock patch version of pgrx-bindgen by @usamoi in
#1939
* Introduce a blocklist of "yanked" Postgres versions by @eeeebbbbrrrr
in #1950
* Make sure bindgen gets the cppflags even if we aren't using macOS by
@thomcc in #1336

## SPI

* Made SPI query arguments type safe by @YohDeadfall in
#1858
* Changed args of prepare methods to be slices by @YohDeadfall in
#1933
* Added connect_mut for data changing SPI operations by @YohDeadfall in
#1913

## General `pgrx-pg-sys` Interfaces

* Allow creating Oid from a u32 in a const context by @syvb in
#1943
* Add utils/acl.h by @daamien in
#1945
* Add catalog/catalog.h by @daamien in
#1946
* Added `oids_of!` macro by @YohDeadfall in
#1879
* Port `bufpage.h` functions by @rebasedming in
#1982

## Bug Fixes

* Check wakeup_flags from `wait_latch` function to exit on
`WL_POSTMASTER_DEATH` by @var77 in
#1938


## Overall Code Cleanup

* refactor: remove redundant references (`&`) by @hamirmahal in
#1941
* fix warnings by @usamoi in
#1948
* Updating readme.md by @ChronicallyJD in
#1949
* style: simplify some statements for readability by @hamirmahal in
#1962
* docs: fix pgx info in cargo-pgrx README by @mrdrivingduck in
#1953
* Updated expected UI test outputs by @YohDeadfall in
#1981
* Fix "about" info for cross subcommand by @mjgarton in
#1974
* update dependencies and fix compilation issues by @eeeebbbbrrrr in
#1983

# Thanks!

Thanks to the community, past, present, and future. Especially to our
new contributors...

# New Contributors
* @var77 made their first contribution in
#1938
* @ChronicallyJD made their first contribution in
#1949
* @mrdrivingduck made their first contribution in
#1953
* @tristan957 made their first contribution in
#1979
* @mjgarton made their first contribution in
#1974

**Full Changelog**:
v0.12.7...v0.13.0
@chenrui333 chenrui333 mentioned this pull request Feb 25, 2025
Merged
usamoi pushed a commit to tensorchord/pgrx that referenced this pull request Mar 6, 2025
@YohDeadfall
Made SPI query arguments type safe (pgcentralfoundation#1858)
eae7de3
usamoi pushed a commit to tensorchord/pgrx that referenced this pull request Mar 6, 2025
@YohDeadfall
Changed args of prepare methods to be slices (pgcentralfoundation#1933)
48bc8ac 
Since there's an opportunity to break more things for `0.13` I decided
to improve the `prepare` and `prepare_mut` methods as well. The
motivation for that is the same as for pgcentralfoundation#1858, `&[]` requires no heap
allocations on the heap if there's a fixed set of arguments.
usamoi pushed a commit to tensorchord/pgrx that referenced this pull request Mar 6, 2025
@eeeebbbbrrrr
Update version to 0.13.0 (pgcentralfoundation#1984)
c08f480 
Welcome to pgrx v0.13.0. The first update in a little bit, which makes
pgrx current with upstream dependencies, rust 1.85.0 (but not 2024
Edition, yet), and a slew of fixes and cleanups and community
contributions.

# Upgrading

You'll need to `cargo install cargo-pgrx --version 0.13.0 --locked` to
get the latest `cargo-pgrx` tool, and then you can run `cargo pgrx
upgrade` in your extension crates to update their dependencies.

# Breaking Changes

Generally, the only breaking changes in v0.13.0 are related to the
user-facing SPI APIs. In general, SPI functions that previously took a
Vec of Arguments now take a `&[DatumWithOid]`, with proper lifetime
bounds. This is a fairly straightforward, boilerplate to update to.

@YohDeadfall has done a lot of work on improving SPI's safety and it's
greatly appreciated!

# What's Changed

## `cargo-pgrx`

* fix a deadlock in `cargo pgrx install` during `get_git_hash()` by
@eeeebbbbrrrr in pgcentralfoundation#1935
* `cargo pgrx test --runas` envar passing by @eeeebbbbrrrr in
pgcentralfoundation#1674
* Search for sql upgrade scripts relative to the package manifest by
@tristan957 in pgcentralfoundation#1979

## Build System

* use `allowlist_file` for bindgen by @usamoi in
pgcentralfoundation#1922
* add `pg_config --libdir` to linker search path by @usamoi in
pgcentralfoundation#1932
* lock patch version of pgrx-bindgen by @usamoi in
pgcentralfoundation#1939
* Introduce a blocklist of "yanked" Postgres versions by @eeeebbbbrrrr
in pgcentralfoundation#1950
* Make sure bindgen gets the cppflags even if we aren't using macOS by
@thomcc in pgcentralfoundation#1336

## SPI

* Made SPI query arguments type safe by @YohDeadfall in
pgcentralfoundation#1858
* Changed args of prepare methods to be slices by @YohDeadfall in
pgcentralfoundation#1933
* Added connect_mut for data changing SPI operations by @YohDeadfall in
pgcentralfoundation#1913

## General `pgrx-pg-sys` Interfaces

* Allow creating Oid from a u32 in a const context by @syvb in
pgcentralfoundation#1943
* Add utils/acl.h by @daamien in
pgcentralfoundation#1945
* Add catalog/catalog.h by @daamien in
pgcentralfoundation#1946
* Added `oids_of!` macro by @YohDeadfall in
pgcentralfoundation#1879
* Port `bufpage.h` functions by @rebasedming in
pgcentralfoundation#1982

## Bug Fixes

* Check wakeup_flags from `wait_latch` function to exit on
`WL_POSTMASTER_DEATH` by @var77 in
pgcentralfoundation#1938


## Overall Code Cleanup

* refactor: remove redundant references (`&`) by @hamirmahal in
pgcentralfoundation#1941
* fix warnings by @usamoi in
pgcentralfoundation#1948
* Updating readme.md by @ChronicallyJD in
pgcentralfoundation#1949
* style: simplify some statements for readability by @hamirmahal in
pgcentralfoundation#1962
* docs: fix pgx info in cargo-pgrx README by @mrdrivingduck in
pgcentralfoundation#1953
* Updated expected UI test outputs by @YohDeadfall in
pgcentralfoundation#1981
* Fix "about" info for cross subcommand by @mjgarton in
pgcentralfoundation#1974
* update dependencies and fix compilation issues by @eeeebbbbrrrr in
pgcentralfoundation#1983

# Thanks!

Thanks to the community, past, present, and future. Especially to our
new contributors...

# New Contributors
* @var77 made their first contribution in
pgcentralfoundation#1938
* @ChronicallyJD made their first contribution in
pgcentralfoundation#1949
* @mrdrivingduck made their first contribution in
pgcentralfoundation#1953
* @tristan957 made their first contribution in
pgcentralfoundation#1979
* @mjgarton made their first contribution in
pgcentralfoundation#1974

**Full Changelog**:
pgcentralfoundation/pgrx@v0.12.7...v0.13.0
KenjiBrown pushed a commit to SoftwareLibreMx/pgrx that referenced this pull request May 27, 2025
@YohDeadfall @KenjiBrown
Made SPI query arguments type safe (pgcentralfoundation#1858)
cfd8059
KenjiBrown pushed a commit to SoftwareLibreMx/pgrx that referenced this pull request May 27, 2025
@YohDeadfall @KenjiBrown
Changed args of prepare methods to be slices (pgcentralfoundation#1933)
b368c34 
Since there's an opportunity to break more things for `0.13` I decided
to improve the `prepare` and `prepare_mut` methods as well. The
motivation for that is the same as for pgcentralfoundation#1858, `&[]` requires no heap
allocations on the heap if there's a fixed set of arguments.
KenjiBrown pushed a commit to SoftwareLibreMx/pgrx that referenced this pull request May 27, 2025
@eeeebbbbrrrr @KenjiBrown
Update version to 0.13.0 (pgcentralfoundation#1984)
cbe7bca 
Welcome to pgrx v0.13.0. The first update in a little bit, which makes
pgrx current with upstream dependencies, rust 1.85.0 (but not 2024
Edition, yet), and a slew of fixes and cleanups and community
contributions.

# Upgrading

You'll need to `cargo install cargo-pgrx --version 0.13.0 --locked` to
get the latest `cargo-pgrx` tool, and then you can run `cargo pgrx
upgrade` in your extension crates to update their dependencies.

# Breaking Changes

Generally, the only breaking changes in v0.13.0 are related to the
user-facing SPI APIs. In general, SPI functions that previously took a
Vec of Arguments now take a `&[DatumWithOid]`, with proper lifetime
bounds. This is a fairly straightforward, boilerplate to update to.

@YohDeadfall has done a lot of work on improving SPI's safety and it's
greatly appreciated!

# What's Changed

## `cargo-pgrx`

* fix a deadlock in `cargo pgrx install` during `get_git_hash()` by
@eeeebbbbrrrr in pgcentralfoundation#1935
* `cargo pgrx test --runas` envar passing by @eeeebbbbrrrr in
pgcentralfoundation#1674
* Search for sql upgrade scripts relative to the package manifest by
@tristan957 in pgcentralfoundation#1979

## Build System

* use `allowlist_file` for bindgen by @usamoi in
pgcentralfoundation#1922
* add `pg_config --libdir` to linker search path by @usamoi in
pgcentralfoundation#1932
* lock patch version of pgrx-bindgen by @usamoi in
pgcentralfoundation#1939
* Introduce a blocklist of "yanked" Postgres versions by @eeeebbbbrrrr
in pgcentralfoundation#1950
* Make sure bindgen gets the cppflags even if we aren't using macOS by
@thomcc in pgcentralfoundation#1336

## SPI

* Made SPI query arguments type safe by @YohDeadfall in
pgcentralfoundation#1858
* Changed args of prepare methods to be slices by @YohDeadfall in
pgcentralfoundation#1933
* Added connect_mut for data changing SPI operations by @YohDeadfall in
pgcentralfoundation#1913

## General `pgrx-pg-sys` Interfaces

* Allow creating Oid from a u32 in a const context by @syvb in
pgcentralfoundation#1943
* Add utils/acl.h by @daamien in
pgcentralfoundation#1945
* Add catalog/catalog.h by @daamien in
pgcentralfoundation#1946
* Added `oids_of!` macro by @YohDeadfall in
pgcentralfoundation#1879
* Port `bufpage.h` functions by @rebasedming in
pgcentralfoundation#1982

## Bug Fixes

* Check wakeup_flags from `wait_latch` function to exit on
`WL_POSTMASTER_DEATH` by @var77 in
pgcentralfoundation#1938


## Overall Code Cleanup

* refactor: remove redundant references (`&`) by @hamirmahal in
pgcentralfoundation#1941
* fix warnings by @usamoi in
pgcentralfoundation#1948
* Updating readme.md by @ChronicallyJD in
pgcentralfoundation#1949
* style: simplify some statements for readability by @hamirmahal in
pgcentralfoundation#1962
* docs: fix pgx info in cargo-pgrx README by @mrdrivingduck in
pgcentralfoundation#1953
* Updated expected UI test outputs by @YohDeadfall in
pgcentralfoundation#1981
* Fix "about" info for cross subcommand by @mjgarton in
pgcentralfoundation#1974
* update dependencies and fix compilation issues by @eeeebbbbrrrr in
pgcentralfoundation#1983

# Thanks!

Thanks to the community, past, present, and future. Especially to our
new contributors...

# New Contributors
* @var77 made their first contribution in
pgcentralfoundation#1938
* @ChronicallyJD made their first contribution in
pgcentralfoundation#1949
* @mrdrivingduck made their first contribution in
pgcentralfoundation#1953
* @tristan957 made their first contribution in
pgcentralfoundation#1979
* @mjgarton made their first contribution in
pgcentralfoundation#1974

**Full Changelog**:
pgcentralfoundation/pgrx@v0.12.7...v0.13.0
zhjwpku added a commit to zhjwpku/wrappers that referenced this pull request May 27, 2025
@zhjwpku
chore: bump pgrx to v0.14.3
2848d8f 
PostgreSQL 12 has been unsupported for over half a year,
and pgrx v0.14.0 officially dropped support for it.

The other reason I propose this version bumping is that
pgrx v0.12.9 failed to install pg 12 on my mac.

This patch removes PG12 support from the wrappers by
upgrading pgrx to v0.14.3. Some code adjustments were required
due to changes introduced in the newer pgrx versions.

For reference, see the following updates in pgrx:

- [force using extern "C-unwind" for functions marked with `#[pg_guard]`][1]
- [Made SPI query arguments type safe][2]
- [Added connect_mut for data changing SPI operations][3]
- [Renamed Oid::as_u32 to to_u32][4]

[1] pgcentralfoundation/pgrx#2014
[2] pgcentralfoundation/pgrx#1858
[3] pgcentralfoundation/pgrx#1913
[4] pgcentralfoundation/pgrx#2011

Signed-off-by: Junwang Zhao <[email protected]>
zhjwpku added a commit to zhjwpku/wrappers that referenced this pull request May 27, 2025
@zhjwpku
chore: bump pgrx to v0.14.3
2e8b17a 
PostgreSQL 12 has been unsupported for over half a year,
and pgrx v0.14.0 officially dropped support for it.

The other reason I propose this version bumping is that
pgrx v0.12.9 failed to install pg 12 on my mac.

This patch removes PG12 support from the wrappers by
upgrading pgrx to v0.14.3. Some code adjustments were required
due to changes introduced in the newer pgrx versions.

For reference, see the following updates in pgrx:

- [force using extern "C-unwind" for functions marked with `#[pg_guard]`][1]
- [Made SPI query arguments type safe][2]
- [Added connect_mut for data changing SPI operations][3]
- [Renamed Oid::as_u32 to to_u32][4]

[1] pgcentralfoundation/pgrx#2014
[2] pgcentralfoundation/pgrx#1858
[3] pgcentralfoundation/pgrx#1913
[4] pgcentralfoundation/pgrx#2011

Signed-off-by: Junwang Zhao <[email protected]>
@zhjwpku zhjwpku mentioned this pull request May 27, 2025
Merged
burmecia pushed a commit to supabase/wrappers that referenced this pull request May 28, 2025
@zhjwpku
chore: bump pgrx to v0.14.3 (#471)
0da8b71 
* chore: bump pgrx to v0.14.3

PostgreSQL 12 has been unsupported for over half a year,
and pgrx v0.14.0 officially dropped support for it.

The other reason I propose this version bumping is that
pgrx v0.12.9 failed to install pg 12 on my mac.

This patch removes PG12 support from the wrappers by
upgrading pgrx to v0.14.3. Some code adjustments were required
due to changes introduced in the newer pgrx versions.

For reference, see the following updates in pgrx:

- [force using extern "C-unwind" for functions marked with `#[pg_guard]`][1]
- [Made SPI query arguments type safe][2]
- [Added connect_mut for data changing SPI operations][3]
- [Renamed Oid::as_u32 to to_u32][4]

[1] pgcentralfoundation/pgrx#2014
[2] pgcentralfoundation/pgrx#1858
[3] pgcentralfoundation/pgrx#1913
[4] pgcentralfoundation/pgrx#2011

Signed-off-by: Junwang Zhao <[email protected]>

* run cargo fmt

Signed-off-by: Junwang Zhao <[email protected]>

* bump ci cargp-pgrx version

Signed-off-by: Junwang Zhao <[email protected]>

---------

Signed-off-by: Junwang Zhao <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@eeeebbbbrrrr eeeebbbbrrrr eeeebbbbrrrr approved these changes

@workingjubilee workingjubilee workingjubilee approved these changes

Assignees

No one assigned

Labels

pgrx-spi sql-safety

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@YohDeadfall @eeeebbbbrrrr @workingjubilee