Crate pg_embed[−][src]
pg-embed
Run a Postgresql database locally on Linux, MacOS or Windows as part of another Rust application or test.
Usage
- Add pg-embed & zip to your Cargo.toml
[dependencies] pg-embed = "0.2" zip = "0.5.11"
A postgresql instance can be created using
PgEmbed::new(PgSettings, FetchSettings)
Examples
use pg_embed::postgres::{PgEmbed, PgSettings}; use pg_embed::fetch; use pg_embed::fetch::{OperationSystem, Architecture, FetchSettings, PG_V13}; use std::time::Duration; let pg_settings = PgSettings{ /// where to store the postgresql executables executables_dir: "data/postgres".to_string(), /// where to store the postgresql database database_dir: "data/db".to_string(), port: 5432, user: "postgres".to_string(), password: "password".to_string(), /// if persistent is false clean up files and directories on drop, otherwise keep them persistent: false, start_timeout: Duration::from_secs(15), }; let fetch_settings = FetchSettings{ host: "https://repo1.maven.org".to_string(), operating_system: OperationSystem::Darwin, architecture: Architecture::Amd64, version: PG_V13 }; let mut pg_emb = PgEmbed::new(pg_settings, fetch_settings); /// async block only to show that these methods need to be executed in an async context async { /// Download, unpack, create password file and database pg_emb.setup().await; /// start postgresql database pg_emb.start_db().await; }; /// stop postgresql database pg_emb.stop_db();
Notes
Reliant on the great work being done by zonkyio/embedded-postgres-binaries in order to fetch precompiled binaries from Maven.
License
pg-embed is licensed under the MIT license. Please read the LICENSE-MIT file in this repository for more information.
Recent Breaking Changes
pg-embed follows semantic versioning, so breaking changes should only happen upon major version bumps. The only exception to this rule is breaking changes that happen due to implementation that was deemed to be a bug, security concerns, or it can be reasonably proved to affect no code. For the full details, see CHANGELOG.md.
Modules
errors | |
fetch | |
postgres |