Struct Pglite 

pub struct Pglite { /* private fields */ }

Primary entry point for interacting with the embedded Postgres runtime.

Implementations

impl Pglite

pub fn builder() -> PgliteBuilder

Create a builder for opening persistent or temporary PGlite databases.

pub fn open(root: impl AsRef<Path>) -> Result<Self>

Open a persistent PGlite database rooted at root, installing and initializing it if needed.

pub fn open_app(app_id: (&str, &str, &str)) -> Result<Self>

Open a persistent PGlite database under the platform data directory for app_id.

pub fn temporary() -> Result<Self>

Create an ephemeral PGlite database whose files are removed when the instance is dropped.

pub fn query( &mut self, sql: &str, params: &[Value], options: Option<&QueryOptions>, ) -> Result<Results>

Execute a SQL query using the extended protocol.

pub fn is_ready(&self) -> bool

Return true if the instance is ready for new work.

pub fn is_closed(&self) -> bool

Return true if the instance has already been closed.

pub fn close(&mut self) -> Result<()>

Shut down the embedded Postgres runtime.

pub fn exec( &mut self, sql: &str, options: Option<&QueryOptions>, ) -> Result<Vec<Results>>

Execute a simple SQL statement that may contain multiple commands.

pub fn listen<F>( &mut self, channel: &str, callback: F, ) -> Result<ListenerHandle>

where F: Fn(&str) + Send + Sync + 'static,

Register a listener for LISTEN channel. Returns a handle that can be used to unlisten.

pub fn unlisten(&mut self, handle: ListenerHandle) -> Result<()>

Remove a listener corresponding to the provided handle.

pub fn unlisten_channel(&mut self, channel: &str) -> Result<()>

Remove all listeners for the specified channel.

pub fn on_notification<F>(&mut self, callback: F) -> GlobalListenerHandle

where F: Fn(&str, &str) + Send + Sync + 'static,

Register a global notification callback.

pub fn off_notification(&mut self, handle: GlobalListenerHandle)

Deregister a previously registered global notification callback.

pub fn describe_query( &mut self, sql: &str, options: Option<&QueryOptions>, ) -> Result<DescribeQueryResult>

Describe the parameter and result metadata for a SQL query.

pub fn transaction<F, T>(&mut self, callback: F) -> Result<T>

where F: FnMut(&mut Transaction<'_>) -> Result<T>,

Run a closure within an SQL transaction (BEGIN .. COMMIT/ROLLBACK).

pub fn sync_to_fs(&mut self) -> Result<()>

Flush runtime writes to the underlying filesystem. Currently a no-op on the host.

Trait Implementations

impl Drop for Pglite

fn drop(&mut self)

Executes the destructor for this type.