Struct pgrx::bgworkers::BackgroundWorker

pub struct BackgroundWorker {}

Static interface into a running Background Worker

It also provides a few helper functions as wrappers around the global pgrx::pg_sys::MyBgworkerEntry

Implementations

impl BackgroundWorker

pub fn get_name() -> &'static str

What is our name?

pub fn get_extra() -> &'static str

Retrieve the extra data provided to the BackgroundWorkerBuilder

pub fn sighup_received() -> bool

Have we received a SIGHUP since previously calling this function? This resets the internal boolean that tracks if SIGHUP was received. So when calling this twice in in a row, the second time will always return false.

pub fn sigterm_received() -> bool

Have we received a SIGTERM since previously calling this function? This resets the internal boolean that tracks if SIGTERM was received. So when calling this twice in in a row, the second time will always return false.

pub fn sigint_received() -> bool

Have we received a SIGINT since previously calling this function? This resets the internal boolean that tracks if SIGINT was received. So when calling this twice in in a row, the second time will always return false.

pub fn sigchld_received() -> bool

Have we received a SIGCHLD since previously calling this function? This resets the internal boolean that tracks if SIGCHLD was received. So when calling this twice in in a row, the second time will always return false.

pub fn wait_latch(timeout: Option<Duration>) -> bool

Wait for the specified amount of time on the background worker’s latch

Returns true if we’re still supposed to be alive and haven’t received a SIGTERM

pub fn worker_continue() -> bool

Is this BackgroundWorker allowed to continue?

pub fn connect_worker_to_spi(dbname: Option<&str>, username: Option<&str>)

Intended to be called once to indicate the database and user to use to connect to via SPI

pub fn attach_signal_handlers(wake: SignalWakeFlags)

Indicate the set of signal handlers we want to receive.

You likely always want to do this:

use pgrx::prelude::*;
use pgrx::bgworkers::{BackgroundWorker, SignalWakeFlags};
BackgroundWorker::attach_signal_handlers(SignalWakeFlags::SIGHUP | SignalWakeFlags::SIGTERM);

pub fn transaction<F: FnOnce() -> R + UnwindSafe + RefUnwindSafe, R>( transaction_body: F ) -> R

Once connected to SPI via connect_worker_to_spi(), begin a transaction to use the pgrx::Spi interface. Returns the return value of the F function.