Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 2.21 KB

README.md

File metadata and controls

60 lines (46 loc) · 2.21 KB

bb8

A full-featured connection pool, designed for asynchronous connections (using tokio). Originally based on r2d2.

Documentation

Opening a new database connection every time one is needed is both inefficient and can lead to resource exhaustion under high traffic conditions. A connection pool maintains a set of open connections to a database, handing them out for repeated use.

bb8 is agnostic to the connection type it is managing. Implementors of the ManageConnection trait provide the database-specific logic to create and check the health of connections.

A (possibly not exhaustive) list of adapters for different backends:

Backend Adapter Crate
tokio-postgres bb8-postgres
redis bb8-redis
rsmq rsmq_async
bolt-client bb8-bolt
diesel bb8-diesel
tiberius [bb8-tiberius](https://crates.io/crates/bb8-tiberius]
nebula-graph-client bb8-nebula-graph

Example

Using an imaginary "foodb" database.

fn main() {
    let manager = bb8_foodb::FooConnectionManager::new("localhost:1234");
    let pool = bb8::Pool::builder()
        .max_size(15)
        .build(manager)
        .unwrap();

    for _ in 0..20 {
        let pool = pool.clone();
        tokio::spawn(move || {
            let conn = pool.get().await.unwrap();
            // use the connection
            // it will be returned to the pool when it falls out of scope.
        })
    }
}

License

Licensed under the MIT license (LICENSE).

Contribution

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