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
use std::ffi::{CStr, CString};
use std::fmt::Debug;
use std::marker::PhantomData;
use std::ops::Index;
use std::ptr::NonNull;
use crate::memcxt::PgMemoryContexts;
use crate::pg_sys::panic::ErrorReportable;
use crate::pg_sys::{self, PgOid};
use crate::prelude::*;
use super::{SpiError, SpiErrorCodes, SpiOkCodes, SpiResult};
#[derive(Debug)]
pub struct SpiTupleTable<'conn> {
#[allow(dead_code)]
pub(super) status_code: SpiOkCodes,
pub(super) table: Option<&'conn mut pg_sys::SPITupleTable>,
pub(super) size: usize,
pub(super) current: isize,
}
impl<'conn> SpiTupleTable<'conn> {
/// `SpiTupleTable`s are positioned before the start, for iteration purposes.
///
/// This method moves the position to the first row. If there are no rows, this
/// method will silently return.
pub fn first(mut self) -> Self {
self.current = 0;
self
}
/// Restore the state of iteration back to before the start.
///
/// This is useful to iterate the table multiple times
pub fn rewind(mut self) -> Self {
self.current = -1;
self
}
/// How many rows were processed?
pub fn len(&self) -> usize {
self.size
}
pub fn is_empty(&self) -> bool {
self.len() == 0
}
pub fn get_one<A: FromDatum + IntoDatum>(&self) -> SpiResult<Option<A>> {
self.get(1)
}
pub fn get_two<A: FromDatum + IntoDatum, B: FromDatum + IntoDatum>(
&self,
) -> SpiResult<(Option<A>, Option<B>)> {
let a = self.get::<A>(1)?;
let b = self.get::<B>(2)?;
Ok((a, b))
}
pub fn get_three<
A: FromDatum + IntoDatum,
B: FromDatum + IntoDatum,
C: FromDatum + IntoDatum,
>(
&self,
) -> SpiResult<(Option<A>, Option<B>, Option<C>)> {
let a = self.get::<A>(1)?;
let b = self.get::<B>(2)?;
let c = self.get::<C>(3)?;
Ok((a, b, c))
}
#[inline(always)]
fn get_spi_tuptable(
&self,
) -> SpiResult<(*mut pg_sys::SPITupleTable, *mut pg_sys::TupleDescData)> {
let table = self.table.as_deref().ok_or(SpiError::NoTupleTable)?;
// SAFETY: we just assured that `table` is not null
Ok((table as *const _ as *mut _, table.tupdesc))
}
pub fn get_heap_tuple(&self) -> SpiResult<Option<SpiHeapTupleData<'conn>>> {
if self.size == 0 || self.table.is_none() {
// a query like "SELECT 1 LIMIT 0" is a valid "select"-style query that will not produce
// a SPI_tuptable. So are utility queries such as "CREATE INDEX" or "VACUUM". We might
// think that in the latter cases we'd want to produce an error here, but there's no
// way to distinguish from the former. As such, we take a gentle approach and
// processed with "no, we don't have one, but it's okay"
Ok(None)
} else if self.current < 0 || self.current as usize >= self.size {
Err(SpiError::InvalidPosition)
} else {
let (table, tupdesc) = self.get_spi_tuptable()?;
unsafe {
let heap_tuple =
std::slice::from_raw_parts((*table).vals, self.size)[self.current as usize];
// SAFETY: we know heap_tuple is valid because we just made it
SpiHeapTupleData::new(tupdesc, heap_tuple)
}
}
}
/// Get a typed value by its ordinal position.
///
/// The ordinal position is 1-based.
///
/// # Errors
///
/// If the specified ordinal is out of bounds a [`Error::SpiError(SpiError::NoAttribute)`] is returned
/// If we have no backing tuple table a [`Error::NoTupleTable`] is returned
///
/// # Panics
///
/// This function will panic there is no parent MemoryContext. This is an incredibly unlikely
/// situation.
pub fn get<T: IntoDatum + FromDatum>(&self, ordinal: usize) -> SpiResult<Option<T>> {
let (_, tupdesc) = self.get_spi_tuptable()?;
let datum = self.get_datum_by_ordinal(ordinal)?;
let is_null = datum.is_none();
let datum = datum.unwrap_or_else(|| pg_sys::Datum::from(0));
unsafe {
// SAFETY: we know the constraints around `datum` and `is_null` match because we
// just got them from the underlying heap tuple
Ok(T::try_from_datum_in_memory_context(
PgMemoryContexts::CurrentMemoryContext
.parent()
.expect("parent memory context is absent"),
datum,
is_null,
// SAFETY: we know `self.tupdesc.is_some()` because an Ok return from
// `self.get_datum_by_ordinal()` above already decided that for us
pg_sys::SPI_gettypeid(tupdesc, ordinal as _),
)?)
}
}
/// Get a typed value by its name.
///
/// # Errors
///
/// If the specified name is invalid a [`Error::SpiError(SpiError::NoAttribute)`] is returned
/// If we have no backing tuple table a [`Error::NoTupleTable`] is returned
pub fn get_by_name<T: IntoDatum + FromDatum, S: AsRef<str>>(
&self,
name: S,
) -> SpiResult<Option<T>> {
self.get(self.column_ordinal(name)?)
}
/// Get a raw Datum from this HeapTuple by its ordinal position.
///
/// The ordinal position is 1-based.
///
/// # Errors
///
/// If the specified ordinal is out of bounds a [`Error::SpiError(SpiError::NoAttribute)`] is returned
/// If we have no backing tuple table a [`Error::NoTupleTable`] is returned
pub fn get_datum_by_ordinal(&self, ordinal: usize) -> SpiResult<Option<pg_sys::Datum>> {
self.check_ordinal_bounds(ordinal)?;
let (table, tupdesc) = self.get_spi_tuptable()?;
if self.current < 0 || self.current as usize >= self.size {
return Err(SpiError::InvalidPosition);
}
unsafe {
let heap_tuple =
std::slice::from_raw_parts((*table).vals, self.size)[self.current as usize];
let mut is_null = false;
let datum = pg_sys::SPI_getbinval(heap_tuple, tupdesc, ordinal as _, &mut is_null);
if is_null {
Ok(None)
} else {
Ok(Some(datum))
}
}
}
/// Get a raw Datum from this HeapTuple by its column name.
///
/// # Errors
///
/// If the specified name is invalid a [`Error::SpiError(SpiError::NoAttribute)`] is returned
/// If we have no backing tuple table a [`Error::NoTupleTable`] is returned
pub fn get_datum_by_name<S: AsRef<str>>(&self, name: S) -> SpiResult<Option<pg_sys::Datum>> {
self.get_datum_by_ordinal(self.column_ordinal(name)?)
}
/// Returns the number of columns
pub fn columns(&self) -> SpiResult<usize> {
let (_, tupdesc) = self.get_spi_tuptable()?;
// SAFETY: we just got a valid tupdesc
Ok(unsafe { (*tupdesc).natts as _ })
}
/// is the specified ordinal valid for the underlying tuple descriptor?
#[inline]
fn check_ordinal_bounds(&self, ordinal: usize) -> SpiResult<()> {
if ordinal < 1 || ordinal > self.columns()? {
Err(SpiError::SpiError(SpiErrorCodes::NoAttribute))
} else {
Ok(())
}
}
/// Returns column type OID
///
/// The ordinal position is 1-based
pub fn column_type_oid(&self, ordinal: usize) -> SpiResult<PgOid> {
self.check_ordinal_bounds(ordinal)?;
let (_, tupdesc) = self.get_spi_tuptable()?;
unsafe {
// SAFETY: we just got a valid tupdesc
let oid = pg_sys::SPI_gettypeid(tupdesc, ordinal as i32);
Ok(PgOid::from(oid))
}
}
/// Returns column name of the 1-based `ordinal` position
///
/// # Errors
///
/// Returns [`Error::SpiError(SpiError::NoAttribute)`] if the specified ordinal value is out of bounds
/// If we have no backing tuple table a [`Error::NoTupleTable`] is returned
///
/// # Panics
///
/// This function will panic if the column name at the specified ordinal position is not also
/// a valid UTF8 string.
pub fn column_name(&self, ordinal: usize) -> SpiResult<String> {
self.check_ordinal_bounds(ordinal)?;
let (_, tupdesc) = self.get_spi_tuptable()?;
unsafe {
// SAFETY: we just got a valid tupdesc and we know ordinal is in bounds
let name = pg_sys::SPI_fname(tupdesc, ordinal as i32);
// SAFETY: SPI_fname will have given us a properly allocated char* since we know
// the specified ordinal is in bounds
let str =
CStr::from_ptr(name).to_str().expect("column name is not value UTF8").to_string();
// SAFETY: we just asked Postgres to allocate name for us
pg_sys::pfree(name as *mut _);
Ok(str)
}
}
/// Returns the ordinal (1-based position) of the specified column name
///
/// # Errors
///
/// Returns [`Error::SpiError(SpiError::NoAttribute)`] if the specified column name isn't found
/// If we have no backing tuple table a [`Error::NoTupleTable`] is returned
///
/// # Panics
///
/// This function will panic if somehow the specified name contains a null byte.
pub fn column_ordinal<S: AsRef<str>>(&self, name: S) -> SpiResult<usize> {
let (_, tupdesc) = self.get_spi_tuptable()?;
unsafe {
let name_cstr = CString::new(name.as_ref()).expect("name contained a null byte");
let fnumber = pg_sys::SPI_fnumber(tupdesc, name_cstr.as_ptr());
if fnumber == pg_sys::SPI_ERROR_NOATTRIBUTE {
Err(SpiError::SpiError(SpiErrorCodes::NoAttribute))
} else {
Ok(fnumber as usize)
}
}
}
}
impl<'conn> Iterator for SpiTupleTable<'conn> {
type Item = SpiHeapTupleData<'conn>;
/// # Panics
///
/// This method will panic if for some reason the underlying heap tuple cannot be retrieved
#[inline]
fn next(&mut self) -> Option<Self::Item> {
self.current += 1;
if self.current >= self.size as isize {
None
} else {
assert!(self.current >= 0);
self.get_heap_tuple().report()
}
}
#[inline]
fn size_hint(&self) -> (usize, Option<usize>) {
(0, Some(self.size))
}
}
/// Represents a single `pg_sys::Datum` inside a `SpiHeapTupleData`
pub struct SpiHeapTupleDataEntry<'conn> {
datum: Option<pg_sys::Datum>,
type_oid: pg_sys::Oid,
__marker: PhantomData<&'conn ()>,
}
/// Represents the set of `pg_sys::Datum`s in a `pg_sys::HeapTuple`
pub struct SpiHeapTupleData<'conn> {
tupdesc: NonNull<pg_sys::TupleDescData>,
// offset by 1!
entries: Vec<SpiHeapTupleDataEntry<'conn>>,
}
impl<'conn> SpiHeapTupleData<'conn> {
/// Create a new `SpiHeapTupleData` from its constituent parts
///
/// # Safety
///
/// This is unsafe as it cannot ensure that the provided `tupdesc` and `htup` arguments
/// are valid, palloc'd pointers.
pub unsafe fn new(
tupdesc: pg_sys::TupleDesc,
htup: *mut pg_sys::HeapTupleData,
) -> SpiResult<Option<Self>> {
let tupdesc = NonNull::new(tupdesc).ok_or(SpiError::NoTupleTable)?;
let mut data = SpiHeapTupleData { tupdesc, entries: Vec::new() };
let tupdesc = tupdesc.as_ptr();
unsafe {
// SAFETY: we know tupdesc is not null
let natts = (*tupdesc).natts;
data.entries.reserve(usize::try_from(natts as usize).unwrap_or_default());
for i in 1..=natts {
let mut is_null = false;
let datum = pg_sys::SPI_getbinval(htup, tupdesc as _, i, &mut is_null);
data.entries.push(SpiHeapTupleDataEntry {
datum: if is_null { None } else { Some(datum) },
type_oid: pg_sys::SPI_gettypeid(tupdesc as _, i),
__marker: PhantomData,
});
}
}
Ok(Some(data))
}
/// Get a typed value from this HeapTuple by its ordinal position.
///
/// The ordinal position is 1-based
///
/// # Errors
///
/// Returns a [`Error::DatumError`] if the desired Rust type is incompatible
/// with the underlying Datum
pub fn get<T: IntoDatum + FromDatum>(&self, ordinal: usize) -> SpiResult<Option<T>> {
self.get_datum_by_ordinal(ordinal).map(|entry| entry.value())?
}
/// Get a typed value from this HeapTuple by its name in the resultset.
///
/// # Errors
///
/// Returns a [`Error::DatumError`] if the desired Rust type is incompatible
/// with the underlying Datum
pub fn get_by_name<T: IntoDatum + FromDatum, S: AsRef<str>>(
&self,
name: S,
) -> SpiResult<Option<T>> {
self.get_datum_by_name(name.as_ref()).map(|entry| entry.value())?
}
/// Get a raw Datum from this HeapTuple by its ordinal position.
///
/// The ordinal position is 1-based.
///
/// # Errors
///
/// If the specified ordinal is out of bounds a [`Error::SpiError(SpiError::NoAttribute)`] is returned
pub fn get_datum_by_ordinal(&self, ordinal: usize) -> SpiResult<&SpiHeapTupleDataEntry<'conn>> {
// Wrapping because `self.entries.get(...)` will bounds check.
let index = ordinal.wrapping_sub(1);
self.entries.get(index).ok_or_else(|| SpiError::SpiError(SpiErrorCodes::NoAttribute))
}
/// Get a raw Datum from this HeapTuple by its field name.
///
/// # Errors
///
/// If the specified name isn't valid a [`Error::SpiError(SpiError::NoAttribute)`] is returned
///
/// # Panics
///
/// This function will panic if somehow the specified name contains a null byte.
pub fn get_datum_by_name<S: AsRef<str>>(
&self,
name: S,
) -> SpiResult<&SpiHeapTupleDataEntry<'conn>> {
unsafe {
let name_cstr = CString::new(name.as_ref()).expect("name contained a null byte");
let fnumber = pg_sys::SPI_fnumber(self.tupdesc.as_ptr(), name_cstr.as_ptr());
if fnumber == pg_sys::SPI_ERROR_NOATTRIBUTE {
Err(SpiError::SpiError(SpiErrorCodes::NoAttribute))
} else {
self.get_datum_by_ordinal(fnumber as usize)
}
}
}
/// Set a datum value for the specified ordinal position
///
/// # Errors
///
/// If the specified ordinal is out of bounds a [`SpiErrorCodes::NoAttribute`] is returned
pub fn set_by_ordinal<T: IntoDatum>(&mut self, ordinal: usize, datum: T) -> SpiResult<()> {
self.check_ordinal_bounds(ordinal)?;
self.entries[ordinal - 1] = SpiHeapTupleDataEntry {
datum: datum.into_datum(),
type_oid: T::type_oid(),
__marker: PhantomData,
};
Ok(())
}
/// Set a datum value for the specified field name
///
/// # Errors
///
/// If the specified name isn't valid a [`Error::SpiError(SpiError::NoAttribute)`] is returned
///
/// # Panics
///
/// This function will panic if somehow the specified name contains a null byte.
pub fn set_by_name<T: IntoDatum>(&mut self, name: &str, datum: T) -> SpiResult<()> {
unsafe {
let name_cstr = CString::new(name).expect("name contained a null byte");
let fnumber = pg_sys::SPI_fnumber(self.tupdesc.as_ptr(), name_cstr.as_ptr());
if fnumber == pg_sys::SPI_ERROR_NOATTRIBUTE {
Err(SpiError::SpiError(SpiErrorCodes::NoAttribute))
} else {
self.set_by_ordinal(fnumber as usize, datum)
}
}
}
#[inline]
pub fn columns(&self) -> usize {
unsafe {
// SAFETY: we know self.tupdesc is a valid, non-null pointer because we own it
(*self.tupdesc.as_ptr()).natts as usize
}
}
/// is the specified ordinal valid for the underlying tuple descriptor?
#[inline]
fn check_ordinal_bounds(&self, ordinal: usize) -> SpiResult<()> {
if ordinal < 1 || ordinal > self.columns() {
Err(SpiError::SpiError(SpiErrorCodes::NoAttribute))
} else {
Ok(())
}
}
}
impl<'conn> SpiHeapTupleDataEntry<'conn> {
pub fn value<T: IntoDatum + FromDatum>(&self) -> SpiResult<Option<T>> {
match self.datum.as_ref() {
Some(datum) => unsafe {
T::try_from_datum_in_memory_context(
PgMemoryContexts::CurrentMemoryContext
.parent()
.expect("parent memory context is absent"),
*datum,
false,
self.type_oid,
)
.map_err(|e| SpiError::DatumError(e))
},
None => Ok(None),
}
}
pub fn oid(&self) -> pg_sys::Oid {
self.type_oid
}
}
/// Provide ordinal indexing into a `SpiHeapTupleData`.
///
/// If the index is out of bounds, it will panic
impl<'conn> Index<usize> for SpiHeapTupleData<'conn> {
type Output = SpiHeapTupleDataEntry<'conn>;
fn index(&self, index: usize) -> &Self::Output {
self.get_datum_by_ordinal(index).expect("invalid ordinal value")
}
}
/// Provide named indexing into a `SpiHeapTupleData`.
///
/// If the field name doesn't exist, it will panic
impl<'conn> Index<&str> for SpiHeapTupleData<'conn> {
type Output = SpiHeapTupleDataEntry<'conn>;
fn index(&self, index: &str) -> &Self::Output {
self.get_datum_by_name(index).expect("invalid field name")
}
}