https://github.com/djc/bb8

Full-featured async (tokio-based) postgres connection pool (like r2d2)
https://github.com/djc/bb8

asynchronous database hacktoberfest pooling tokio

Last synced: 1 day ago
JSON representation

Full-featured async (tokio-based) postgres connection pool (like r2d2)

• Host: GitHub
• URL: https://github.com/djc/bb8
• Owner: djc
• License: mit
• Created: 2018-01-29T21:38:04.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-27T19:28:00.000Z (24 days ago)
• Last Synced: 2024-11-17T11:14:35.347Z (3 days ago)
• Topics: asynchronous, database, hacktoberfest, pooling, tokio
• Language: Rust
• Homepage:
• Size: 270 KB
• Stars: 766
• Watchers: 20
• Forks: 110
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# bb8

[![Documentation](https://docs.rs/bb8/badge.svg)](https://docs.rs/bb8/)

[![Crates.io](https://img.shields.io/crates/v/bb8.svg)](https://crates.io/crates/bb8)

[![Build status](https://github.com/djc/bb8/workflows/CI/badge.svg)](https://github.com/djc/bb8/actions?query=workflow%3ACI)

[![codecov](https://codecov.io/gh/djc/bb8/branch/main/graph/badge.svg)](https://codecov.io/gh/djc/bb8)

[![Chat](https://img.shields.io/discord/976380008299917365?logo=discord)](https://discord.gg/E4DuUP83V2)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)

A full-featured connection pool, designed for asynchronous connections (using

tokio). Originally based on [r2d2](https://github.com/sfackler/r2d2).

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](https://github.com/sfackler/rust-postgres) | [bb8-postgres](https://crates.io/crates/bb8-postgres) (in-tree)

[redis](https://github.com/mitsuhiko/redis-rs) | [bb8-redis](https://crates.io/crates/bb8-redis) (in-tree)

[redis_cluster_async](https://crates.io/crates/redis_cluster_async) | [bb8-redis-cluster](https://crates.io/crates/bb8-redis-cluster)

[rsmq](https://github.com/smrchy/rsmq) | [rsmq_async](https://crates.io/crates/rsmq_async)

[bolt-client](https://crates.io/crates/bolt-client) | [bb8-bolt](https://crates.io/crates/bb8-bolt)

[diesel](https://crates.io/crates/diesel) | [bb8-diesel](https://crates.io/crates/bb8-diesel)

[tiberius](https://crates.io/crates/tiberius) | [bb8-tiberius](https://crates.io/crates/bb8-tiberius)

[nebula-client](https://crates.io/crates/nebula-client) | [bb8-nebula](https://crates.io/crates/bb8-nebula)

[memcache-async](https://github.com/vavrusa/memcache-async) | [bb8-memcached](https://crates.io/crates/bb8-memcached)

[lapin](https://crates.io/crates/lapin) | [bb8-lapin](https://crates.io/crates/bb8-lapin)

[arangors](https://crates.io/crates/arangors) | [bb8-arangodb](https://crates.io/crates/bb8-arangodb)

## Example

Using an imaginary "foodb" database.

```rust

#[tokio::main]

async fn main() {

    let manager = bb8_foodb::FooConnectionManager::new("localhost:1234");

    let pool = bb8::Pool::builder()

        .max_size(15)

        .build(manager)

        .await

        .unwrap();

    for _ in 0..20 {

        let pool = pool.clone();

        tokio::spawn(async 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](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.