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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

//!
//! # pg-embed
//!
//! [![Crates.io](https://img.shields.io/crates/v/pg-embed)](http://crates.io/crates/pg-embed)
//! [![Docs.rs](https://docs.rs/pg-embed/badge.svg)](https://docs.rs/pg-embed)
//! [![Crates.io](https://img.shields.io/crates/d/pg-embed)](http://crates.io/crates/pg-embed)
//! [![Crates.io](https://img.shields.io/crates/l/pg-embed)](https://github.com/faokunega/pg-embed/blob/master/LICENSE)
//!
//! Run a Postgresql database locally on Linux, MacOS or Windows as part of another Rust application or test.
//!
//! The currently supported async runtime for **pg-embed** is [tokio](https://crates.io/crates/tokio).
//!
//! Support for [async-std](https://crates.io/crates/async-std) and [actix](https://crates.io/crates/actix) is planned
//! and will be available soon.
//!
//! # Usage
//!
//! - Add pg-embed to your Cargo.toml
//!
//!      *Library without sqlx migration support*
//!
//!      ```toml
//!      # Cargo.toml
//!      [dependencies]
//!      pg-embed = { version = "0.4", default-features = false, features = ["rt_tokio"] }
//!      ```
//!
//!      *Library with sqlx migration support*
//!
//!      ```toml
//!      # Cargo.toml
//!      [dependencies]
//!      pg-embed = "0.4"
//!      ```
//!
//! A postgresql instance can be created using<br/>
//! **[PgEmbed]( postgres::PgEmbed )::new([PgSettings]( postgres::PgSettings ), [FetchSettings]( fetch::FetchSettings ))**
//!
//! # Examples
//!
//! ```
//! use pg_embed::postgres::{PgEmbed, PgSettings, PgAuthMethod};
//! use pg_embed::fetch;
//! use pg_embed::fetch::{OperationSystem, Architecture, FetchSettings, PG_V13};
//! use std::time::Duration;
//!
//! /// Postgresql settings
//! let pg_settings = PgSettings{
//!     /// Where to store the postgresql executables
//!     executables_dir: PathBuf::from("data/postgres"),
//!     /// Where to store the postgresql database
//!     database_dir: PathBuf::from("data/db"),
//!     port: 5432,
//!     user: "postgres".to_string(),
//!     password: "password".to_string(),
//!     /// authentication method
//!     auth_method: PgAuthMethod::Plain,
//!     /// If persistent is false clean up files and directories on drop, otherwise keep them
//!     persistent: false,
//!     start_timeout: Duration::from_secs(15),
//!     /// If migration sql scripts need to be run, the directory containing those scripts can be
//!     /// specified here with `Some(path_to_dir), otherwise `None` to run no migrations.
//!     /// To enable migrations view the **Usage** section for details
//!     migration_dir: None,
//! };
//!
//! /// Postgresql binaries download settings
//! let fetch_settings = FetchSettings{
//!     host: "https://repo1.maven.org".to_string(),
//!     operating_system: OperationSystem::Darwin,
//!     architecture: Architecture::Amd64,
//!     version: PG_V13
//! };
//!
//! /// Create a new instance
//! let mut pg = 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 cluster
//!     pg.setup().await;
//!
//!     /// start postgresql database
//!     pg.start_db().await;
//!
//!     /// create a new database
//!     /// to enable migrations view the **Usage** section for details
//!     pg.create_database("database_name").await;
//!
//!     /// drop a new database
//!     /// to enable migrations view [Usage] for details
//!     /// to enable migrations view the **Usage** section for details
//!     pg.drop_database("database_name").await;
//!
//!     /// check database existence
//!     /// to enable migrations view [Usage] for details
//!     /// to enable migrations view the **Usage** section for details
//!     pg.database_exists("database_name").await;
//!
//!     /// run migration sql scripts
//!     /// to enable migrations view [Usage] for details
//!     /// to enable migrations view the **Usage** section for details
//!     pg.migrate("database_name").await;
//! };
//!     /// get the base postgresql uri
//!     /// `postgres://{username}:{password}@localhost:{port}`
//!     let pg_uri: &str = &pg.db_uri;
//!
//!     /// get a postgresql database uri
//!     /// `postgres://{username}:{password}@localhost:{port}/{specified_database_name}`
//!     let pg_db_uri: String = pg.full_db_uri("database_name");
//!
//!     /// stop postgresql database
//!     pg.stop_db();
//!
//!
//! ```
//!
//! ## 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](https://github.com/faokunega/pg-embed/blob/master/CHANGELOG.md).
//!
//!
//!
//! ## License
//!
//! pg-embed is licensed under the MIT license. Please read the [LICENSE-MIT](https://github.com/faokunega/pg-embed/blob/master/LICENSE) file in this repository for more information.
//!
//! # Notes
//!
//! Reliant on the great work being done by [zonkyio/embedded-postgres-binaries](https://github.com/zonkyio/embedded-postgres-binaries) in order to fetch precompiled binaries from [Maven](https://mvnrepository.com/artifact/io.zonky.test.postgres/embedded-postgres-binaries-bom).
//!

#[cfg(not(any(
feature = "rt_tokio_migrate",
feature = "rt_tokio",
feature = "rt_actix_migrate",
feature = "rt_actix",
feature = "rt_async_std_migrate",
feature = "rt_async_std",
)))]
compile_error!(
    "one of the features ['rt_tokio_migrate', 'rt_tokio', \
     'rt_actix_migrate', 'rt_actix', 'rt_async_std_migrate', \
     'rt_async_std'] must be enabled"
);

#[cfg(any(
all(feature = "rt_tokio", feature = "rt_async_std"),
all(feature = "rt_tokio", feature = "rt_async_std_migrate"),
all(feature = "rt_tokio_migrate", feature = "rt_async_std"),
all(feature = "rt_tokio_migrate", feature = "rt_async_std_migrate"),
))]
compile_error!(
    "only one of ['rt_tokio', 'rt_tokio_migrate', \
     'rt_async_std', 'rt_async_std_migrate'] can be enabled"
);

pub mod fetch;
pub mod postgres;
pub mod errors;