From 84eb59d5b4b80d54ec9f82186e5c751495c36817 Mon Sep 17 00:00:00 2001
From: stoically <stoically@protonmail.com>
Date: Mon, 14 Feb 2022 08:47:59 +0100
Subject: [PATCH] docs: Acquire examples and alternative

---
 Cargo.lock               |  1 +
 sqlx-core/Cargo.toml     |  3 ++
 sqlx-core/src/acquire.rs | 61 ++++++++++++++++++++++++++++++++++++++++
 3 files changed, 65 insertions(+)

diff --git a/Cargo.lock b/Cargo.lock
index 2f0ddab8d8..528ef46865 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2455,6 +2455,7 @@ dependencies = [
  "sha2",
  "smallvec",
  "sqlformat",
+ "sqlx",
  "sqlx-rt",
  "stringprep",
  "thiserror",
diff --git a/sqlx-core/Cargo.toml b/sqlx-core/Cargo.toml
index e8912206fa..cf60ca6566 100644
--- a/sqlx-core/Cargo.toml
+++ b/sqlx-core/Cargo.toml
@@ -164,3 +164,6 @@ bstr = { version = "0.2.17", default-features = false, features = ["std"], optio
 git2 = { version = "0.13.25", default-features = false, optional = true }
 hashlink = "0.7.0"
 indexmap = "1.7.0"
+
+[dev-dependencies]
+sqlx = { version = "0.5.10", path = "..", features = ["postgres"] }
\ No newline at end of file
diff --git a/sqlx-core/src/acquire.rs b/sqlx-core/src/acquire.rs
index 4a861d20b8..d03e708dbc 100644
--- a/sqlx-core/src/acquire.rs
+++ b/sqlx-core/src/acquire.rs
@@ -5,6 +5,67 @@ use crate::transaction::Transaction;
 use futures_core::future::BoxFuture;
 use std::ops::{Deref, DerefMut};
 
+/// Acquire connections or transactions from a database in a generic way.
+///
+/// If you want to accept generic database connections that implement
+/// [`Acquire`] which then allows you to [`acquire`][`Acquire::acquire`] a
+/// connection or [`begin`][`Acquire::begin`] a transaction, then you can do it
+/// like that:
+///
+/// ```rust
+/// # use sqlx::{Acquire, postgres::Postgres, error::BoxDynError};
+/// async fn run_query<'a, A>(conn: A) -> Result<(), BoxDynError>
+/// where
+///     A: Acquire<'a, Database = Postgres>,
+/// {
+///     let mut conn = conn.acquire().await?;
+///
+///     sqlx::query!("SELECT 1 as v").fetch_one(&mut *conn).await?;
+///     sqlx::query!("SELECT 2 as v").fetch_one(&mut *conn).await?;
+///
+///     Ok(())
+/// }
+/// ```
+///
+/// If you run into a lifetime error about "implementation of `sqlx::Acquire` is
+/// not general enough", the [workaround] looks like this:
+///
+/// ```rust
+/// # use std::future::Future;
+/// # use sqlx::{Acquire, postgres::Postgres, error::BoxDynError};
+/// fn run_query<'a, 'c, A>(conn: A) -> impl Future<Output = Result<(), BoxDynError>> + Send + 'a
+/// where
+///     A: Acquire<'c, Database = Postgres> + Send + 'a,
+/// {
+///     async move {
+///         let mut conn = conn.acquire().await?;
+///
+///         sqlx::query!("SELECT 1 as v").fetch_one(&mut *conn).await?;
+///         sqlx::query!("SELECT 2 as v").fetch_one(&mut *conn).await?;
+///
+///         Ok(())
+///     }
+/// }
+/// ```
+///
+/// However, if you really just want to accept both, a transaction or a
+/// connection as an argument to a function, then it's easier to just accept a
+/// mutable reference to a database connection like so:
+///
+/// ```rust
+/// # use sqlx::{postgres::PgConnection, error::BoxDynError};
+/// async fn run_query(conn: &mut PgConnection) -> Result<(), BoxDynError> {
+///     sqlx::query!("SELECT 1 as v").fetch_one(&mut *conn).await?;
+///     sqlx::query!("SELECT 2 as v").fetch_one(&mut *conn).await?;
+///
+///     Ok(())
+/// }
+/// ```
+///
+/// The downside of this approach is that you have to `acquire` a connection
+/// from a pool first and can't directly pass the pool as argument.
+///
+/// [workaround]: https://github.com/launchbadge/sqlx/issues/1015#issuecomment-767787777
 pub trait Acquire<'c> {
     type Database: Database;