Struct pgx::spi::Spi

pub struct Spi;

Implementations

impl Spi

pub fn get_one<A: FromDatum + IntoDatum>(query: &str) -> Result<Option<A>>

pub fn get_two<A: FromDatum + IntoDatum, B: FromDatum + IntoDatum>( query: &str ) -> Result<(Option<A>, Option<B>)>

pub fn get_three<A: FromDatum + IntoDatum, B: FromDatum + IntoDatum, C: FromDatum + IntoDatum>( query: &str ) -> Result<(Option<A>, Option<B>, Option<C>)>

pub fn get_one_with_args<A: FromDatum + IntoDatum>( query: &str, args: Vec<(PgOid, Option<Datum>)> ) -> Result<Option<A>>

pub fn get_two_with_args<A: FromDatum + IntoDatum, B: FromDatum + IntoDatum>( query: &str, args: Vec<(PgOid, Option<Datum>)> ) -> Result<(Option<A>, Option<B>)>

pub fn get_three_with_args<A: FromDatum + IntoDatum, B: FromDatum + IntoDatum, C: FromDatum + IntoDatum>( query: &str, args: Vec<(PgOid, Option<Datum>)> ) -> Result<(Option<A>, Option<B>, Option<C>)>

pub fn run(query: &str) -> Result<(), Error>

just run an arbitrary SQL statement.

Safety

The statement runs in read/write mode

pub fn run_with_args( query: &str, args: Option<Vec<(PgOid, Option<Datum>)>> ) -> Result<(), Error>

run an arbitrary SQL statement with args.

Safety

The statement runs in read/write mode

pub fn explain(query: &str) -> Result<Json>

explain a query, returning its result in json form

pub fn explain_with_args( query: &str, args: Option<Vec<(PgOid, Option<Datum>)>> ) -> Result<Json>

explain a query with args, returning its result in json form

pub fn connect<R, F: FnOnce(SpiClient<'_>) -> R>(f: F) -> R

Execute SPI commands via the provided SpiClient.

While inside the provided closure, code executes under a short-lived “SPI Memory Context”, and Postgres will completely free that context when this function is finished.

pgx’ SPI API endeavors to return Datum values from functions like ::get_one() that are automatically copied into the into the CurrentMemoryContext at the time of this function call.

Examples

use pgx::prelude::*;
let name = Spi::connect(|client| {
    client.select("SELECT 'Bob'", None, None)?.first().get_one()
})?;
assert_eq!(name, Some("Bob"));

Note that SpiClient is scoped to the connection lifetime and cannot be returned. The following code will not compile:

use pgx::prelude::*;
let cant_return_client = Spi::connect(|client| client);

Panics

This function will panic if for some reason it’s unable to “connect” to Postgres’ SPI system. At the time of this writing, that’s actually impossible as the underlying function (pg_sys::SPI_connect()) always returns a successful response.

pub fn check_status(status_code: i32) -> Result<SpiOkCodes, Error>