Struct Oliphaunt 

pub struct Oliphaunt { /* private fields */ }

Primary entry point for interacting with the embedded Postgres runtime.

Implementations

impl Oliphaunt

pub fn builder() -> OliphauntBuilder

Create a builder for opening persistent or temporary Oliphaunt databases.

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

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

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

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

pub fn temporary() -> Result<Self>

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

pub fn preload() -> Result<()>

Warm the runtime module and bundled AOT artifact cache without opening a database.

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

Refresh direct API array parser and serializer registrations.

This mirrors upstream Oliphaunt’s refreshArrayTypes() escape hatch. Most applications should not need it because built-in arrays are registered statically and runtime custom arrays are discovered lazily when possible.

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 engine_capabilities(&self) -> EngineCapabilities

Return the capabilities of the active embedded engine.

pub fn dump_data_dir(&mut self) -> Result<Vec<u8>>

Dump the physical PGDATA directory to a gzipped tar archive.

The archive is intended to be loaded back into oliphaunt-wasix/Oliphaunt with the same PostgreSQL/Oliphaunt version. Use dump_sql for logical backups across versions.

pub fn dump_data_dir_with_format( &mut self, format: DataDirArchiveFormat, ) -> Result<Vec<u8>>

Dump the physical PGDATA directory with the selected archive format.

pub fn try_clone(&mut self) -> Result<Self>

Clone this database into a new temporary Oliphaunt instance.

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.

The WASIX backend uses host-mounted files and PostgreSQL’s own fsync/WAL behavior for durability. Adding an unconditional host directory sync_all after every direct query is both expensive and weaker than the database’s file-level fsyncs, so the Rust-level hook remains a no-op.

pub fn exec_protocol( &mut self, message: &[u8], options: ExecProtocolOptions, ) -> Result<ExecProtocolResult>

Execute raw PostgreSQL frontend protocol bytes and parse backend protocol messages.

pub fn exec_protocol_raw( &mut self, message: &[u8], options: ExecProtocolOptions, ) -> Result<Vec<u8>>

Execute raw PostgreSQL frontend protocol bytes and return raw backend protocol bytes.

pub fn exec_protocol_raw_stream<F>( &mut self, message: &[u8], options: ExecProtocolOptions, on_data: F, ) -> Result<()>

where F: FnMut(&[u8]) -> Result<()>,

Execute raw protocol bytes and pass the returned backend bytes to on_data.

Trait Implementations

impl Drop for Oliphaunt

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.