Skip to content

Commit

Permalink
fix doctest
Browse files Browse the repository at this point in the history 
Don't use sqlx_postgres as its API isn't stable.
Use sqlx itself as a dev-dependency instead.
  • Loading branch information
@grim7reaper
grim7reaper committed Mar 11, 2024
1 parent cdcfaec commit 0bdb8d9
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 32 deletions.
1 change: 1 addition & 0 deletions Cargo.lock
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions sqlx-postgres/Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,5 +72,9 @@ workspace = true
# We use JSON in the driver implementation itself so there's no reason not to enable it here.
features = ["json"]


[dev-dependencies]
sqlx = { workspace = true, features = ["postgres"] }

[target.'cfg(target_os = "windows")'.dependencies]
etcetera = "0.8.0"
1 change: 0 additions & 1 deletion sqlx-postgres/src/advisory_lock.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ impl PgAdvisoryLock {
/// [hkdf]: https://datatracker.ietf.org/doc/html/rfc5869
/// ### Example
/// ```rust
/// # extern crate sqlx_core as sqlx;
/// use sqlx::postgres::{PgAdvisoryLock, PgAdvisoryLockKey};
///
/// let lock = PgAdvisoryLock::new("my first Postgres advisory lock!");
Expand Down
2 changes: 1 addition & 1 deletion sqlx-postgres/src/copy.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ pub struct PgCopyBothReceiver(flume::r#async::RecvStream<'static, Result<Bytes>>
// # Example
//
// ```rust,no_run
// # use sqlx_postgres::{
// # use sqlx::postgres::{
// # pg_copy_both, PgConnectOptions, PgPoolOptions, PgReplicationMode,
// # };
// // Connection must be configured with a replication mode!
Expand Down
8 changes: 4 additions & 4 deletions sqlx-postgres/src/listener.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,8 @@ impl PgListener {
/// # Example
///
/// ```rust,no_run
/// # use sqlx_core::postgres::PgListener;
/// # use sqlx_core::error::Error;
/// # use sqlx::postgres::PgListener;
/// # use sqlx::error::Error;
/// #
/// # #[cfg(feature = "_rt")]
/// # sqlx::__rt::test_block_on(async move {
Expand Down Expand Up @@ -219,8 +219,8 @@ impl PgListener {
/// # Example
///
/// ```rust,no_run
/// # use sqlx_core::postgres::PgListener;
/// # use sqlx_core::error::Error;
/// # use sqlx::postgres::PgListener;
/// # use sqlx::error::Error;
/// #
/// # #[cfg(feature = "_rt")]
/// # sqlx::__rt::test_block_on(async move {
Expand Down
53 changes: 27 additions & 26 deletions sqlx-postgres/src/options/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@ mod ssl_mode;
/// // Information about SQL queries is logged at `DEBUG` level by default.
/// opts = opts.log_statements(log::LevelFilter::Trace);
///
/// let pool = PgPool::connect_with(&opts).await?;
/// let pool = PgPool::connect_with(opts).await?;
/// # Ok(())
/// # }
/// ```
#[derive(Debug, Clone)]
Expand Down Expand Up @@ -141,7 +142,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new();
/// ```
pub fn new() -> Self {
Expand Down Expand Up @@ -208,7 +209,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .host("localhost");
/// ```
Expand All @@ -224,7 +225,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .port(5432);
/// ```
Expand All @@ -250,7 +251,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .username("postgres");
/// ```
Expand All @@ -264,7 +265,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .username("root")
/// .password("safe-and-secure");
Expand All @@ -279,7 +280,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .database("postgres");
/// ```
Expand All @@ -299,7 +300,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::{PgSslMode, PgConnectOptions};
/// # use sqlx::postgres::{PgSslMode, PgConnectOptions};
/// let options = PgConnectOptions::new()
/// .ssl_mode(PgSslMode::Require);
/// ```
Expand All @@ -315,7 +316,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::{PgSslMode, PgConnectOptions};
/// # use sqlx::postgres::{PgSslMode, PgConnectOptions};
/// let options = PgConnectOptions::new()
/// // Providing a CA certificate with less than VerifyCa is pointless
/// .ssl_mode(PgSslMode::VerifyCa)
Expand All @@ -331,7 +332,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::{PgSslMode, PgConnectOptions};
/// # use sqlx::postgres::{PgSslMode, PgConnectOptions};
/// let options = PgConnectOptions::new()
/// // Providing a CA certificate with less than VerifyCa is pointless
/// .ssl_mode(PgSslMode::VerifyCa)
Expand All @@ -351,7 +352,7 @@ impl PgConnectOptions {
/// This is for illustration purposes only.
///
/// ```rust
/// # use sqlx_postgres::{PgSslMode, PgConnectOptions};
/// # use sqlx::postgres::{PgSslMode, PgConnectOptions};
///
/// const CERT: &[u8] = b"\
/// -----BEGIN CERTIFICATE-----
Expand All @@ -373,7 +374,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::{PgSslMode, PgConnectOptions};
/// # use sqlx::postgres::{PgSslMode, PgConnectOptions};
/// let options = PgConnectOptions::new()
/// // Providing a CA certificate with less than VerifyCa is pointless
/// .ssl_mode(PgSslMode::VerifyCa)
Expand All @@ -393,7 +394,7 @@ impl PgConnectOptions {
/// This is for illustration purposes only.
///
/// ```rust
/// # use sqlx_postgres::{PgSslMode, PgConnectOptions};
/// # use sqlx::postgres::{PgSslMode, PgConnectOptions};
///
/// const KEY: &[u8] = b"\
/// -----BEGIN PRIVATE KEY-----
Expand All @@ -415,7 +416,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::{PgSslMode, PgConnectOptions};
/// # use sqlx::postgres::{PgSslMode, PgConnectOptions};
/// let options = PgConnectOptions::new()
/// // Providing a CA certificate with less than VerifyCa is pointless
/// .ssl_mode(PgSslMode::VerifyCa)
Expand All @@ -442,7 +443,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .application_name("my-app");
/// ```
Expand Down Expand Up @@ -489,7 +490,7 @@ impl PgConnectOptions {
///
/// ### Examples
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
///
/// let mut options = PgConnectOptions::new()
/// // for Redshift and Postgres 10
Expand Down Expand Up @@ -517,7 +518,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::{PgConnectOptions, PgReplicationMode};
/// # use sqlx::postgres::{PgConnectOptions, PgReplicationMode};
/// let options = PgConnectOptions::new()
/// .replication_mode(PgReplicationMode::Logical);
/// ```
Expand All @@ -531,7 +532,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .options([("geqo", "off"), ("statement_timeout", "5min")]);
/// ```
Expand Down Expand Up @@ -576,7 +577,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .host("127.0.0.1");
/// assert_eq!(options.get_host(), "127.0.0.1");
Expand All @@ -590,7 +591,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .port(6543);
/// assert_eq!(options.get_port(), 6543);
Expand All @@ -604,7 +605,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .socket("/tmp");
/// assert!(options.get_socket().is_some());
Expand All @@ -618,7 +619,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .username("foo");
/// assert_eq!(options.get_username(), "foo");
Expand All @@ -632,7 +633,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .database("postgres");
/// assert!(options.get_database().is_some());
Expand All @@ -646,7 +647,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::{PgConnectOptions, PgSslMode};
/// # use sqlx::postgres::{PgConnectOptions, PgSslMode};
/// let options = PgConnectOptions::new();
/// assert!(matches!(options.get_ssl_mode(), PgSslMode::Prefer));
/// ```
Expand All @@ -659,7 +660,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .application_name("service");
/// assert!(options.get_application_name().is_some());
Expand All @@ -673,7 +674,7 @@ impl PgConnectOptions {
/// # Example
///
/// ```rust
/// # use sqlx_postgres::PgConnectOptions;
/// # use sqlx::postgres::PgConnectOptions;
/// let options = PgConnectOptions::new()
/// .options([("foo", "bar")]);
/// assert!(options.get_options().is_some());
Expand Down

0 comments on commit 0bdb8d9

Please sign in to comment.