Skip to content

docs: update documentation #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,23 @@
Install and run a PostgreSQL database locally on Linux, MacOS or Windows. PostgreSQL can be
bundled with your application, or downloaded on demand.

This library provides an embedded-like experience for PostgreSQL similar to what you would have with
SQLite. This is accomplished by downloading and installing PostgreSQL during runtime. There is
also a "bundled" feature that when enabled, will download the PostgreSQL installation archive at
compile time, include it in your binary and install from the binary version at runtime.
In either case, PostgreSQL will run in a separate process space.

## Features

- installing and running PostgreSQL
- running PostgreSQL on ephemeral ports
- async and blocking API
- bundling the PostgreSQL archive in an executable
- dynamic version resolution
- ability to configure PostgreSQL startup options
- URL based configuration
- choice of native-tls vs rustls

## Getting Started

### Example
Expand Down
17 changes: 17 additions & 0 deletions postgresql_embedded/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,23 @@
Install and run a PostgreSQL database locally on Linux, MacOS or Windows. PostgreSQL can be
bundled with your application, or downloaded on demand.

This library provides an embedded-like experience for PostgreSQL similar to what you would have with
SQLite. This is accomplished by downloading and installing PostgreSQL during runtime. There is
also a "bundled" feature that when enabled, will download the PostgreSQL installation archive at
compile time, include it in your binary and install from the binary version at runtime.
In either case, PostgreSQL will run in a separate process space.

## Features

- installing and running PostgreSQL
- running PostgreSQL on ephemeral ports
- async and blocking API
- bundling the PostgreSQL archive in an executable
- dynamic version resolution
- ability to configure PostgreSQL startup options
- URL based configuration
- choice of native-tls vs rustls

## Examples

### Asynchronous API
Expand Down
2 changes: 1 addition & 1 deletion postgresql_embedded/tests/environment_variables.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use test_log::test;

#[test(tokio::test)]
async fn lifecycle() -> anyhow::Result<()> {
// Explicitly set PGDATABASE environment variables to verify that the library behavior
// Explicitly set PGDATABASE environment variable to verify that the library behavior
// is not affected by the environment
env::set_var("PGDATABASE", "foodb");

Expand Down
Loading