postgresql_archive 0.5.0

A library for downloading and extracting PostgreSQL archives
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

# PostgreSQL Archive

[![ci](https://github.com/theseus-rs/postgresql-embedded/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/theseus-rs/postgresql-embedded/actions/workflows/ci.yml)
[![Documentation](https://docs.rs/postgresql_archive/badge.svg)](https://docs.rs/postgresql_archive)
[![Code Coverage](https://codecov.io/gh/theseus-rs/postgresql-embedded/branch/main/graph/badge.svg)](https://codecov.io/gh/theseus-rs/postgresql-embedded)
[![Benchmarks](https://img.shields.io/badge/%F0%9F%90%B0_bencher-enabled-6ec241)](https://bencher.dev/perf/theseus-rs-postgresql-embedded)
[![Latest version](https://img.shields.io/crates/v/postgresql_archive.svg)](https://crates.io/crates/postgresql_archive)
[![License](https://img.shields.io/crates/l/postgresql_archive?)](https://github.com/theseus-rs/postgresql-embedded/tree/main/postgresql_archive#license)
[![Semantic Versioning](https://img.shields.io/badge/%E2%9A%99%EF%B8%8F_SemVer-2.0.0-blue)](https://semver.org/spec/v2.0.0.html)

A library for downloading and extracting PostgreSQL archives from
[theseus-rs/postgresql-binaries](https://github.com/theseus-rs/postgresql-binaries).

## Examples

### Asynchronous API

```rust
use postgresql_archive::{extract, get_archive, Result, LATEST};

#[tokio::main]
async fn main() -> Result<()> {
    let (archive_version, archive) = get_archive(&LATEST).await?;
    let out_dir = std::env::temp_dir();
    extract(&archive, &out_dir).await
}
```

### Synchronous API
```rust
use postgresql_archive::{Result, LATEST};
use postgresql_archive::blocking::{extract, get_archive};

fn main() -> Result<()> {
    let (archive_version, archive) = get_archive(&LATEST)?;
    let out_dir = std::env::temp_dir();
    extract(&archive, &out_dir)
}
```

## Feature flags

postgresql_archive uses [feature flags] to address compile time and binary size
uses.

The following features are available:

| Name         | Description              | Default? |
|--------------|--------------------------|----------|
| `blocking`   | Enables the blocking API | No       |

## Supported platforms

`postgresql_archive` supports all platforms provided by [theseus-rs/postgresql-binaries](https://github.com/theseus-rs/postgresql-binaries).

Currently supported platforms are:

| OS      | [Target](https://doc.rust-lang.org/nightly/rustc/platform-support.html) |
|---------|-------------------------------------------------------------------------|
| Linux   | aarch64-unknown-linux-gnu                                               |
| Linux   | aarch64-unknown-linux-musl                                              |
| Linux   | arm-unknown-linux-gnueabi                                               |
| Linux   | arm-unknown-linux-gnueabihf                                             |
| Linux   | arm-unknown-linux-musleabi                                              |
| Linux   | arm-unknown-linux-musleabihf                                            |
| Linux   | armv5te-unknown-linux-gnueabi                                           |
| Linux   | armv7-unknown-linux-gnueabihf                                           |
| Linux   | armv7-unknown-linux-musleabihf                                          |
| Linux   | i586-unknown-linux-gnu                                                  |
| Linux   | i586-unknown-linux-musl                                                 |
| Linux   | i686-unknown-linux-gnu                                                  |
| Linux   | i686-unknown-linux-musl                                                 |
| Linux   | mips64-unknown-linux-gnuabi64                                           |
| Linux   | powerpc64le-unknown-linux-gnu                                           |
| Linux   | powerpc64le-unknown-linux-musl                                          |
| Linux   | s390x-unknown-linux-gnu                                                 |
| Linux   | s390x-unknown-linux-musl                                                |
| Linux   | x86_64-unknown-linux-gnu                                                |
| Linux   | x86_64-unknown-linux-musl                                               |
| MacOS   | aarch64-apple-darwin                                                    |
| MacOS   | x86_64-apple-darwin                                                     |
| Windows | x86_64-pc-windows-msvc                                                  |

## Safety

This crate uses `#![forbid(unsafe_code)]` to ensure everything is implemented in 100% safe Rust.

## License

Licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)

at your option.

PostgreSQL is covered under [The PostgreSQL License](https://opensource.org/licenses/postgresql).

## Notes

Uses PostgreSQL binaries from [theseus-rs/postgresql-binaries](https://github.com/theseus-rs/postgresql-binaries).

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.