1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
//! Provides a safe interface to Postgres `HeapTuple` objects.
//!
//! [`PgHeapTuple`]s also describe composite types as defined by [`pgx::composite_type!()`][crate::composite_type].
use crate::datum::lookup_type_name;
use crate::pg_sys::{Datum, Oid};
use crate::{
heap_getattr_raw, pg_sys, trigger_fired_by_delete, trigger_fired_by_insert,
trigger_fired_by_update, trigger_fired_for_statement, AllocatedByPostgres, AllocatedByRust,
FromDatum, IntoDatum, PgBox, PgMemoryContexts, PgTupleDesc, TriggerTuple, TryFromDatumError,
WhoAllocated,
};
use pgx_sql_entity_graph::metadata::{
ArgumentError, Returns, ReturnsError, SqlMapping, SqlTranslatable,
};
use std::num::NonZeroUsize;
/// Describes errors that can occur when trying to create a new [PgHeapTuple].
#[derive(thiserror::Error, Debug, Clone, PartialEq, Eq)]
pub enum PgHeapTupleError {
#[error("Incorrect attribute count, found {0}, descriptor had {1}")]
IncorrectAttributeCount(usize, usize),
#[error("The specified composite type, {0}, does not exist")]
NoSuchType(String),
}
/// A [`PgHeapTuple`] is a lightweight wrapper around Postgres' [`pg_sys::HeapTuple`] object and a [`PgTupleDesc`].
///
/// In order to access the attributes within a [`pg_sys::HeapTuple`], the [`PgTupleDesc`] is required
/// to describe its structure.
///
/// [`PgHeapTuple`]s can be created from existing (Postgres-provided) [`pg_sys::HeapTuple`] pointers, from
/// [`pg_sys::TriggerData`] pointers, from a composite datum, or created from scratch using raw Datums.
///
/// A [`PgHeapTuple`] can either be considered to be allocated by Postgres or by the Rust runtime. If
/// allocated by Postgres, it is not mutable until [`PgHeapTuple::into_owned`] is called.
///
/// [`PgHeapTuple`]s also describe composite types as defined by [`pgx::composite_type!()`][crate::composite_type].
pub struct PgHeapTuple<'a, AllocatedBy: WhoAllocated> {
tuple: PgBox<pg_sys::HeapTupleData, AllocatedBy>,
tupdesc: PgTupleDesc<'a>,
}
impl<'a> FromDatum for PgHeapTuple<'a, AllocatedByRust> {
unsafe fn from_polymorphic_datum(
composite: pg_sys::Datum,
is_null: bool,
_oid: pg_sys::Oid,
) -> Option<Self> {
if is_null {
None
} else {
Some(PgHeapTuple::from_composite_datum(composite))
}
}
unsafe fn from_datum_in_memory_context(
mut memory_context: PgMemoryContexts,
composite: Datum,
is_null: bool,
_oid: pg_sys::Oid,
) -> Option<Self>
where
Self: Sized,
{
if is_null {
None
} else {
memory_context.switch_to(|_| {
// we're copying the composite datum into this memory context
let tuple = PgHeapTuple::from_composite_datum(composite);
let datum = tuple.into_composite_datum();
Some(PgHeapTuple::from_composite_datum(datum.unwrap()))
})
}
}
}
impl<'a> PgHeapTuple<'a, AllocatedByPostgres> {
/// Creates a new [PgHeapTuple] from a [PgTupleDesc] and a [pg_sys::HeapTuple] pointer. The
/// returned [PgHeapTuple] will be considered by have been allocated by Postgres and is not mutable
/// until [PgHeapTuple::into_owned] is called.
///
/// ## Safety
///
/// This function is unsafe as we cannot guarantee that the [pg_sys::HeapTuple] pointer is valid,
/// nor can we guaratee that the provided [PgTupleDesc] properly describes the structure of
/// the heap tuple.
pub unsafe fn from_heap_tuple(tupdesc: PgTupleDesc<'a>, heap_tuple: pg_sys::HeapTuple) -> Self {
Self { tuple: PgBox::from_pg(heap_tuple), tupdesc }
}
/// Creates a new [PgHeapTuple] identified by the `which_tuple` trigger tuple. The returned
/// [PgHeapTuple] will be considered by have been allocated by Postgres and is not mutable until
/// [PgHeapTuple::into_owned] is called.
///
/// pgx also invents the concept of a "current" ([`TriggerTuple::Current`]) tuple, which is either
/// the new row being inserted or the row being updated (not the new version) or deleted.
///
/// Asking for a [`TriggerTuple`] that isn't compatible with how the trigger was fired causes
/// this function to return `None`. Specifically this means `None` is always returned for
/// statement-level triggers.
///
/// ## Safety
///
/// This function is unsafe as we cannot guarantee that any pointers in the `trigger_data`
/// argument are valid or that it's being used in the context of a firing trigger, which necessitates
/// Postgres internal state be correct for executing a trigger.
pub unsafe fn from_trigger_data(
trigger_data: &'a pg_sys::TriggerData,
which_tuple: TriggerTuple,
) -> Option<PgHeapTuple<'a, AllocatedByPostgres>> {
if trigger_fired_for_statement(trigger_data.tg_event) {
// there is no HeapTuple for a statement-level trigger as such triggers aren't run
// per-row
return None;
}
let tuple = match which_tuple {
TriggerTuple::New => {
if trigger_fired_by_insert(trigger_data.tg_event) {
trigger_data.tg_trigtuple
} else if trigger_fired_by_update(trigger_data.tg_event) {
trigger_data.tg_newtuple
} else {
return None;
}
}
TriggerTuple::Old => {
if trigger_fired_by_update(trigger_data.tg_event)
|| trigger_fired_by_delete(trigger_data.tg_event)
{
trigger_data.tg_trigtuple
} else {
return None;
}
}
};
// at this point we should not be trying to return a NULL trigger tuple. We should have
// done that above as an early return.
//
// We assert that `tuple` is not null here because we want to ensure that our logic above
// is correct and somehow aren't about to dereference a null pointer which might have come
// from incorrect assignment from the `trigger_data.tg_trigtuple/tg_newtuple` fields above.
//
// IOW, we are double-checking that we're using those fields correctly
assert_eq!(tuple.is_null(), false, "encountered unexpected NULL trigger tuple");
unsafe {
// SAFETY: The caller has asserted that `trigger_data` is valid, and that means its
// `tg_relation` member must be too
let tupdesc = PgTupleDesc::from_pg_unchecked((*trigger_data.tg_relation).rd_att);
// SAFETY: We just created the `tupdesc` and determined which tuple to use and have asserted
// that that tuple is not NULL
let pg_heap_tuple = PgHeapTuple::from_heap_tuple(tupdesc, tuple);
Some(pg_heap_tuple)
}
}
/// Consumes a `[PgHeapTuple]` considered to be allocated by Postgres and transforms it into one
/// that is considered allocated by Rust. This is accomplished by copying the underlying [pg_sys::HeapTupleData].
pub fn into_owned(self) -> PgHeapTuple<'a, AllocatedByRust> {
let copy = unsafe { pg_sys::heap_copytuple(self.tuple.into_pg()) };
PgHeapTuple {
tuple: unsafe { PgBox::<pg_sys::HeapTupleData, AllocatedByRust>::from_rust(copy) },
tupdesc: self.tupdesc,
}
}
}
impl<'a> PgHeapTuple<'a, AllocatedByRust> {
/** Create a new heap tuple in the shape of a defined composite type
```rust,no_run
use pgx::prelude::*;
Spi::run("CREATE TYPE dog AS (name text, age int);");
let mut heap_tuple = PgHeapTuple::new_composite_type("dog").unwrap();
assert_eq!(heap_tuple.get_by_name::<String>("name").unwrap(), None);
assert_eq!(heap_tuple.get_by_name::<i32>("age").unwrap(), None);
heap_tuple
.set_by_name("name", "Brandy".to_string())
.unwrap();
heap_tuple.set_by_name("age", 42).unwrap();
assert_eq!(
heap_tuple.get_by_name("name").unwrap(),
Some("Brandy".to_string())
);
assert_eq!(heap_tuple.get_by_name("age").unwrap(), Some(42i32));
```
*/
pub fn new_composite_type(
type_name: &str,
) -> Result<PgHeapTuple<'a, AllocatedByRust>, PgHeapTupleError> {
let tuple_desc = PgTupleDesc::for_composite_type(type_name)
.ok_or_else(|| PgHeapTupleError::NoSuchType(type_name.to_string()))?;
let natts = tuple_desc.len();
unsafe {
let datums =
pg_sys::palloc0(natts * std::mem::size_of::<pg_sys::Datum>()) as *mut pg_sys::Datum;
let mut is_null = (0..natts).map(|_| true).collect::<Vec<_>>();
let heap_tuple =
pg_sys::heap_form_tuple(tuple_desc.as_ptr(), datums, is_null.as_mut_ptr());
Ok(PgHeapTuple {
tuple: PgBox::<pg_sys::HeapTupleData, AllocatedByRust>::from_rust(heap_tuple),
tupdesc: tuple_desc,
})
}
}
/// Create a new [PgHeapTuple] from a [PgTupleDesc] from an iterator of Datums.
///
/// ## Errors
/// - [PgHeapTupleError::IncorrectAttributeCount] if the number of items in the iterator
/// does not match the number of attributes in the [PgTupleDesc].
pub fn from_datums<I: IntoIterator<Item = Option<pg_sys::Datum>>>(
tupdesc: PgTupleDesc<'a>,
datums: I,
) -> Result<PgHeapTuple<'a, AllocatedByRust>, PgHeapTupleError> {
let iter = datums.into_iter();
let mut datums = Vec::<pg_sys::Datum>::with_capacity(iter.size_hint().1.unwrap_or(1));
let mut nulls = Vec::<bool>::with_capacity(iter.size_hint().1.unwrap_or(1));
iter.for_each(|datum| {
nulls.push(datum.is_none());
datums.push(datum.unwrap_or(0.into()));
});
if datums.len() != tupdesc.len() {
return Err(PgHeapTupleError::IncorrectAttributeCount(datums.len(), tupdesc.len()));
}
unsafe {
let formed_tuple =
pg_sys::heap_form_tuple(tupdesc.as_ptr(), datums.as_mut_ptr(), nulls.as_mut_ptr());
Ok(Self {
tuple: PgBox::<pg_sys::HeapTupleData, AllocatedByRust>::from_rust(formed_tuple),
tupdesc,
})
}
}
/// Creates a new [PgHeapTuple] from an opaque Datum that should be a "composite" type.
///
/// The Datum should be a pointer to a [pg_sys::HeapTupleHeader]. Typically, this will be used
/// in situations when working with SQL `ROW(...)` constructors, or a composite SQL type such as
///
/// ```sql
/// CREATE TYPE my_composite AS (name text, age i32);
/// ```
///
/// ## Safety
///
/// This function is unsafe as we cannot guarantee that the provided Datum is a valid [pg_sys::HeapTupleHeader]
/// pointer.
pub unsafe fn from_composite_datum(composite: pg_sys::Datum) -> Self {
let htup_header =
pg_sys::pg_detoast_datum(composite.cast_mut_ptr()) as pg_sys::HeapTupleHeader;
let tup_type = crate::heap_tuple_header_get_type_id(htup_header);
let tup_typmod = crate::heap_tuple_header_get_typmod(htup_header);
let tupdesc = pg_sys::lookup_rowtype_tupdesc(tup_type, tup_typmod);
let mut data = PgBox::<pg_sys::HeapTupleData>::alloc0();
data.t_len = crate::heap_tuple_header_get_datum_length(htup_header) as u32;
data.t_data = htup_header;
Self { tuple: data, tupdesc: PgTupleDesc::from_pg(tupdesc) }
}
/// Given the name for an attribute in this [PgHeapTuple], change its value.
///
/// Attribute names are case sensitive.
///
/// ## Errors
///
/// - return [TryFromDatumError::NoSuchAttributeName] if the attribute does not exist
/// - return [TryFromDatumError::IncompatibleTypes] if the Rust type of the `value` is not
/// compatible with the attribute's Postgres type
pub fn set_by_name<T: IntoDatum>(
&mut self,
attname: &str,
value: T,
) -> Result<(), TryFromDatumError> {
match self.get_attribute_by_name(attname) {
None => Err(TryFromDatumError::NoSuchAttributeName(attname.to_string())),
Some((attnum, _)) => self.set_by_index(attnum, value),
}
}
/// Given the index for an attribute in this [PgHeapTuple], change its value.
///
/// Attribute numbers start at 1, not 0.
///
/// ## Errors
/// - return [TryFromDatumError::NoSuchAttributeNumber] if the attribute does not exist
/// - return [TryFromDatumError::IncompatibleTypes] if the Rust type of the `value` is not
/// compatible with the attribute's Postgres type
pub fn set_by_index<T: IntoDatum>(
&mut self,
attno: NonZeroUsize,
value: T,
) -> Result<(), TryFromDatumError> {
unsafe {
match self.get_attribute_by_index(attno) {
None => return Err(TryFromDatumError::NoSuchAttributeNumber(attno)),
Some(att) => {
let type_oid = T::type_oid();
let composite_type_oid = value.composite_type_oid();
let is_compatible_composite_types =
type_oid == pg_sys::RECORDOID && composite_type_oid == Some(att.atttypid);
if !is_compatible_composite_types && !T::is_compatible_with(att.atttypid) {
return Err(TryFromDatumError::IncompatibleTypes {
rust_type: std::any::type_name::<T>(),
rust_oid: att.atttypid,
datum_type: lookup_type_name(type_oid),
datum_oid: type_oid,
});
}
}
}
let mut datums =
(0..self.tupdesc.len()).map(|i| pg_sys::Datum::from(i)).collect::<Vec<_>>();
let mut nulls = (0..self.tupdesc.len()).map(|_| false).collect::<Vec<_>>();
let mut do_replace = (0..self.tupdesc.len()).map(|_| false).collect::<Vec<_>>();
let datum = value.into_datum();
let attno = attno.get() - 1;
nulls[attno] = datum.is_none();
datums[attno] = datum.unwrap_or(0.into());
do_replace[attno] = true;
let new_tuple = PgBox::<pg_sys::HeapTupleData, AllocatedByRust>::from_rust(
pg_sys::heap_modify_tuple(
self.tuple.as_ptr(),
self.tupdesc.as_ptr(),
datums.as_mut_ptr(),
nulls.as_mut_ptr(),
do_replace.as_mut_ptr(),
),
);
let old_tuple = std::mem::replace(&mut self.tuple, new_tuple);
drop(old_tuple);
Ok(())
}
}
}
impl<'a, AllocatedBy: WhoAllocated> IntoDatum for PgHeapTuple<'a, AllocatedBy> {
// Delegate to `into_composite_datum()` as this will normally be used with composite types.
// See `into_trigger_datum()` if using as a trigger.
fn into_datum(self) -> Option<pg_sys::Datum> {
self.into_composite_datum()
}
fn type_oid() -> pg_sys::Oid {
crate::pg_sys::RECORDOID
}
fn composite_type_oid(&self) -> Option<Oid> {
Some(self.tupdesc.oid())
}
fn is_compatible_with(other: pg_sys::Oid) -> bool {
fn is_composite(oid: pg_sys::Oid) -> bool {
unsafe {
let entry = pg_sys::lookup_type_cache(oid, pg_sys::TYPECACHE_TUPDESC as _);
(*entry).typtype as i8 == pg_sys::RELKIND_COMPOSITE_TYPE as i8
}
}
Self::type_oid() == other || is_composite(other)
}
}
impl<'a, AllocatedBy: WhoAllocated> PgHeapTuple<'a, AllocatedBy> {
/// Consume this [`PgHeapTuple`] and return a composite Datum representation, containing the tuple
/// data and the corresponding tuple descriptor information.
pub fn into_composite_datum(self) -> Option<pg_sys::Datum> {
unsafe {
Some(pg_sys::heap_copy_tuple_as_datum(self.tuple.as_ptr(), self.tupdesc.as_ptr()))
}
}
/// Consume this [`PgHeapTuple`] and return a Datum representation appropriate for returning from
/// a trigger function
pub fn into_trigger_datum(self) -> Option<pg_sys::Datum> {
self.tuple.into_datum()
}
/// Consumes this [`PgHeapTuple`], returning a pointer to a [`pg_sys::HeapTupleData`] that can
/// be passed to a Postgres FFI function. It'll be freed whenever Postgres frees the `MemoryContext`
/// in which it was allocated.
#[inline]
pub fn into_pg(self) -> *mut pg_sys::HeapTupleData {
self.tuple.into_pg()
}
/// Returns the number of attributes in this [`PgHeapTuple`].
#[inline]
pub fn len(&self) -> usize {
self.tupdesc.len()
}
/// Returns an iterator over the attributes in this [`PgHeapTuple`].
///
/// The return value is `(attribute_number: NonZeroUsize, attribute_info: &pg_sys::FormData_pg_attribute)`.
pub fn attributes(
&'a self,
) -> impl std::iter::Iterator<Item = (NonZeroUsize, &'a pg_sys::FormData_pg_attribute)> {
self.tupdesc.iter().enumerate().map(|(i, att)| (NonZeroUsize::new(i + 1).unwrap(), att))
}
/// Get the attribute information for the specified attribute number.
///
/// Returns `None` if the attribute number is out of bounds.
#[inline]
pub fn get_attribute_by_index(
&'a self,
index: NonZeroUsize,
) -> Option<&'a pg_sys::FormData_pg_attribute> {
self.tupdesc.get(index.get() - 1)
}
/// Get the attribute information for the specified attribute, by name.
///
/// Returns `None` if the attribute name is not found.
pub fn get_attribute_by_name(
&'a self,
name: &str,
) -> Option<(NonZeroUsize, &'a pg_sys::FormData_pg_attribute)> {
for i in 0..self.len() {
let i = NonZeroUsize::new(i + 1).unwrap();
let att = self.get_attribute_by_index(i).unwrap();
if att.name() == name {
return Some((i, att));
}
}
None
}
/// Retrieve the value of the specified attribute, by name.
///
/// Attribute names are case-insensitive.
///
/// ## Errors
/// - return [`TryFromDatumError::NoSuchAttributeName`] if the attribute does not exist
/// - return [`TryFromDatumError::IncompatibleTypes`] if the Rust type of the `value` is not
/// compatible with the attribute's Postgres type
pub fn get_by_name<T: FromDatum + IntoDatum + 'static>(
&self,
attname: &str,
) -> Result<Option<T>, TryFromDatumError> {
// find the attribute number by name
for att in self.tupdesc.iter() {
if att.name() == attname {
// we found the named attribute, so go get it from the HeapTuple
return self.get_by_index(NonZeroUsize::new(att.attnum as usize).unwrap());
}
}
// no attribute with the specified name
Err(TryFromDatumError::NoSuchAttributeName(attname.to_owned()))
}
/// Retrieve the value of the specified attribute, by index.
///
/// Attribute numbers start at 1, not 0.
///
/// ## Errors
/// - return [`TryFromDatumError::NoSuchAttributeNumber`] if the attribute does not exist
/// - return [`TryFromDatumError::IncompatibleTypes`] if the Rust type of the `value` is not
/// compatible with the attribute's Postgres type
pub fn get_by_index<T: FromDatum + IntoDatum + 'static>(
&self,
attno: NonZeroUsize,
) -> Result<Option<T>, TryFromDatumError> {
unsafe {
// tuple descriptor attribute numbers are zero-based
match self.tupdesc.get(attno.get() - 1) {
// it's an attribute number outside the bounds of the tuple descriptor
None => Err(TryFromDatumError::NoSuchAttributeNumber(attno)),
// it's a valid attribute number
Some(att) => {
let datum = heap_getattr_raw(self.tuple.as_ptr(), attno, self.tupdesc.as_ptr());
if datum.is_none() {
return Ok(None);
}
match T::type_oid() {
record @ pg_sys::RECORDOID => {
T::try_from_datum(datum.unwrap(), false, record)
}
_ => T::try_from_datum(datum.unwrap(), false, att.type_oid().value()),
}
}
}
}
}
}
/** Composite type support
Support for working with types defined by SQL statements like:
```sql
CREATE TYPE Dog AS (
name TEXT,
scritches INT
);
```
To PostgreSQL, these types are a [`pgx::pg_sys::HeapTuple`][crate::pg_sys::HeapTuple], which is a
pointer to a [`pgx::pg_sys::HeapTupleData`][crate::pg_sys::HeapTupleData]. `pgx` provides more idiomatic
wrapping of this type with [`pgx::heap_tuple::PgHeapTuple`][crate::heap_tuple::PgHeapTuple].
This `composite_type!()` macro expands into a [`pgx::heap_tuple::PgHeapTuple`][crate::heap_tuple::PgHeapTuple].
```rust
assert_eq!(
core::any::TypeId::of::<pgx::composite_type!("Dog")>(),
core::any::TypeId::of::<pgx::heap_tuple::PgHeapTuple<'static, ::pgx::AllocatedByRust>>(),
);
assert_eq!(
core::any::TypeId::of::<pgx::composite_type!('static, "Dog")>(),
core::any::TypeId::of::<pgx::heap_tuple::PgHeapTuple<'static, ::pgx::AllocatedByRust>>(),
);
const DOG_COMPOSITE_TYPE_IDENT: &str = "Dog";
assert_eq!(
core::any::TypeId::of::<pgx::composite_type!('static, DOG_COMPOSITE_TYPE_IDENT)>(),
core::any::TypeId::of::<pgx::heap_tuple::PgHeapTuple<'static, ::pgx::AllocatedByRust>>(),
);
```
# Inside a `#[pg_extern]`
Used inside of a [`#[pg_extern]`][crate::pg_extern] definition, this macro alters the generated SQL to use the given
composite type name.
Meaning that this function:
```rust,no_run
use pgx::{prelude::*, AllocatedByRust};
#[pg_extern]
fn scritch(
maybe_dog: Option<::pgx::composite_type!("Dog")>,
) -> Option<pgx::composite_type!("Dog")> {
// Gets resolved to:
let maybe_dog: Option<PgHeapTuple<AllocatedByRust>> = maybe_dog;
let maybe_dog = if let Some(mut dog) = maybe_dog {
dog.set_by_name("scritches", dog.get_by_name::<i32>("scritches").unwrap())
.unwrap();
Some(dog)
} else {
None
};
maybe_dog
}
```
Would generate SQL similar to this:
```SQL
-- a_bunch_of_dog_functions/src/lib.rs:3
-- a_bunch_of_dog_functions::scritch
CREATE FUNCTION "scritch"(
"maybe_dog" Dog /* core::option::Option<pgx::heap_tuple::PgHeapTuple<pgx::pgbox::AllocatedByRust>> */
) RETURNS Dog /* core::option::Option<pgx::heap_tuple::PgHeapTuple<pgx::pgbox::AllocatedByRust>> */
LANGUAGE c /* Rust */
AS 'MODULE_PATHNAME', 'scritch_wrapper';
```
It's possibly to use `composite_type!()` inside a `default!()` macro:
```rust
use pgx::{prelude::*, AllocatedByRust};
#[pg_extern]
fn this_dog_name_or_your_favorite_dog_name(
dog: pgx::default!(pgx::composite_type!("Dog"), "ROW('Nami', 0)::Dog"),
) -> &str {
// Gets resolved to:
let dog: PgHeapTuple<AllocatedByRust> = dog;
dog.get_by_name("name").unwrap().unwrap()
}
```
Composite types are very **runtime failure** heavy, as opposed to using PostgreSQL types `pgx` has
a builtin compatible type for, or a [`#[derive(pgx::PostgresType)`][crate::PostgresType] type. Those options
can have their shape and API reasoned about at build time.
This runtime failure model is because the shape and layout, or even the name of the type could change during
the runtime of the extension.
For example, a user of the extension could do something like:
```sql
CREATE TYPE Dog AS (
name TEXT,
scritches INT
);
CREATE EXTENSION a_bunch_of_dog_functions;
SELECT scritch(ROW('Nami', 0)::Dog);
ALTER TYPE Dog ADD ATTRIBUTE tail_wags INT;
SELECT scritch(ROW('Nami', 0, 0)::Dog);
```
Because of this, all interaction with composite types requires runtime lookup and type checking.
# Creating composite types
It's possible to create composite types of a given identifier with [`pgx::heap_tuple::PgHeapTuple::new_composite_type`][crate::heap_tuple::PgHeapTuple::new_composite_type].
*/
#[macro_export]
macro_rules! composite_type {
($lt:lifetime, $composite_type:expr) => {
::pgx::heap_tuple::PgHeapTuple<$lt, ::pgx::AllocatedByRust>
};
($composite_type:expr) => {
::pgx::heap_tuple::PgHeapTuple<'static, ::pgx::AllocatedByRust>
};
}
unsafe impl SqlTranslatable for crate::heap_tuple::PgHeapTuple<'static, AllocatedByPostgres> {
fn argument_sql() -> Result<SqlMapping, ArgumentError> {
Ok(SqlMapping::Composite { array_brackets: false })
}
fn return_sql() -> Result<Returns, ReturnsError> {
Ok(Returns::One(SqlMapping::Composite { array_brackets: false }))
}
}
unsafe impl SqlTranslatable for crate::heap_tuple::PgHeapTuple<'static, AllocatedByRust> {
fn argument_sql() -> Result<SqlMapping, ArgumentError> {
Ok(SqlMapping::Composite { array_brackets: false })
}
fn return_sql() -> Result<Returns, ReturnsError> {
Ok(Returns::One(SqlMapping::Composite { array_brackets: false }))
}
}