Guides
Install default features:
cargo add pglite-rs
Import as pglite:
use pglite::PGlite;
Features
| Feature | Enables |
|---|---|
socket |
Default feature. Adds PGlite::unix_uri() on
Unix.
|
multiple-process |
Adds PGlite::open_multi_process() and
MultiProcessOptions.
|
replica |
Adds logical replication types and
Replica::start().
|
pgvector |
Bundled pgvector extension. |
pgcrypto |
Bundled pgcrypto extension. |
icu |
ICU locale provider. |
full |
Enables all optional features. |
cargo add pglite-rs --features multiple-process,replica
Extension linker flag
When loading bundled extensions such as pgvector,
pgcrypto, or plpgsql, export symbols
from the host binary:
// build.rs
fn main() {
#[cfg(target_os = "macos")]
println!("cargo:rustc-link-arg=-Wl,-export_dynamic");
#[cfg(not(target_os = "macos"))]
println!("cargo:rustc-link-arg=-Wl,--export-dynamic");
}
Runtime
The crate is runtime-neutral. Examples use Tokio because SQLx
examples use Tokio, but the library API depends on
futures, not a specific executor.
