Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 18eb5a4

Browse filesBrowse files
committed
docs: update documentation
1 parent da76187 commit 18eb5a4
Copy full SHA for 18eb5a4

File tree

Expand file treeCollapse file tree

3 files changed

+35
-1
lines changed
Filter options
Expand file treeCollapse file tree

3 files changed

+35
-1
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
+17Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,23 @@
1313
Install and run a PostgreSQL database locally on Linux, MacOS or Windows. PostgreSQL can be
1414
bundled with your application, or downloaded on demand.
1515

16+
This library provides an embedded-like experience for PostgreSQL similar to what you would have with
17+
SQLite. This is accomplished by downloading and installing PostgreSQL during runtime. There is
18+
also a "bundled" feature that when enabled, will download the PostgreSQL installation archive at
19+
compile time, include it in your binary and install from the binary version at runtime.
20+
In either case, PostgreSQL will run in a separate process space.
21+
22+
## Features
23+
24+
- installing and running PostgreSQL
25+
- running PostgreSQL on ephemeral ports
26+
- async and blocking API
27+
- bundling the PostgreSQL archive in an executable
28+
- dynamic version resolution
29+
- ability to configure PostgreSQL startup options
30+
- URL based configuration
31+
- choice of native-tls vs rustls
32+
1633
## Getting Started
1734

1835
### Example

‎postgresql_embedded/README.md

Copy file name to clipboardExpand all lines: postgresql_embedded/README.md
+17Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,23 @@
1111
Install and run a PostgreSQL database locally on Linux, MacOS or Windows. PostgreSQL can be
1212
bundled with your application, or downloaded on demand.
1313

14+
This library provides an embedded-like experience for PostgreSQL similar to what you would have with
15+
SQLite. This is accomplished by downloading and installing PostgreSQL during runtime. There is
16+
also a "bundled" feature that when enabled, will download the PostgreSQL installation archive at
17+
compile time, include it in your binary and install from the binary version at runtime.
18+
In either case, PostgreSQL will run in a separate process space.
19+
20+
## Features
21+
22+
- installing and running PostgreSQL
23+
- running PostgreSQL on ephemeral ports
24+
- async and blocking API
25+
- bundling the PostgreSQL archive in an executable
26+
- dynamic version resolution
27+
- ability to configure PostgreSQL startup options
28+
- URL based configuration
29+
- choice of native-tls vs rustls
30+
1431
## Examples
1532

1633
### Asynchronous API

‎postgresql_embedded/tests/environment_variables.rs

Copy file name to clipboardExpand all lines: postgresql_embedded/tests/environment_variables.rs
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use test_log::test;
44

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

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.