Struct PgliteServer 

pub struct PgliteServer { /* private fields */ }

A supervised local PostgreSQL socket backed by one embedded PGlite runtime.

This is the compatibility entry point for code that expects a PostgreSQL URL, such as tokio-postgres, SQLx, or tools that speak the wire protocol. The server owns one embedded backend, so downstream pools should use a single connection.

Implementations

impl PgliteServer

pub fn builder() -> PgliteServerBuilder

Build a local PGlite server. The default is a cached temporary database served on 127.0.0.1:0.

pub fn temporary_tcp() -> Result<Self>

Start a cached temporary database on a random local TCP port.

pub fn root(&self) -> &Path

Return the root directory used for runtime files and cluster data.

pub fn tcp_addr(&self) -> Option<SocketAddr>

Return the bound TCP address, if this server is using TCP.

pub fn socket_path(&self) -> Option<&Path>

Return the Unix-domain socket path, if this server is using UDS.

pub fn connection_uri(&self) -> String

Return a PostgreSQL connection URI for the local server.

pub fn shutdown(self) -> Result<()>

Request shutdown and wait for the listener thread to exit.

Close database clients before calling this method. The current proxy owns one blocking backend connection at a time, so an open client can keep the worker thread busy until it disconnects.

Trait Implementations

impl Debug for PgliteServer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for PgliteServer

fn drop(&mut self)

Executes the destructor for this type.