# mobc

**Repository Path**: rustpro/mobc

## Basic Information

- **Project Name**: mobc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-08
- **Last Updated**: 2024-06-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mobc

A generic connection pool with async/await support.

Inspired by r2d2 and Golang SQL package.

<div>
  <a href="https://travis-ci.com/github/importcjj/mobc">
    <img src="https://travis-ci.com/importcjj/mobc.svg?branch=master" alt="travis ci" />
  </a>
<!-- Crates version -->
  <a href="https://crates.io/crates/mobc">
    <img src="https://img.shields.io/crates/v/mobc.svg?style=flat-square"
    alt="Crates.io version" />
  </a>
<!-- Downloads -->
<a href="https://crates.io/crates/mobc">
<img src="https://img.shields.io/crates/d/mobc.svg?style=flat-square"
    alt="Download" />
</a>
</div>

[Documentation](https://docs.rs/mobc/latest/mobc/)

[Changelog](https://github.com/importcjj/mobc/blob/master/CHANGELOG.md)

**Note: mobc requires at least Rust 1.39.**

## Usage

```toml
[dependencies]
mobc = "0.7"

# For async-std runtime
# mobc = { version = "0.7", features = ["async-std"] }

# For actix-rt 1.0
# mobc = { version = "0.7", features = ["actix-rt"] }
```


## Features

* Support async/.await syntax
* Support both `tokio` and `async-std`
* High performance
* Easy to customize
* Dynamic configuration

## Adaptors


| Backend                                                     | Adaptor Crate                                               |
| ----------------------------------------------------------- | ----------------------------------------------------------- |
| [tokio-postgres](https://github.com/sfackler/rust-postgres) | [mobc-postgres](https://github.com/importcjj/mobc-postgres) |
| [redis](https://github.com/mitsuhiko/redis-rs)              | [mobc-redis](https://github.com/importcjj/mobc-redis)       |
| [arangodb](https://github.com/fMeow/arangors)               | [mobc-arangors](https://github.com/inzanez/mobc-arangors)   |
| [lapin](https://github.com/CleverCloud/lapin)               | [mobc-lapin](https://github.com/zupzup/mobc-lapin)          |
| [reql](https://github.com/rethinkdb/rethinkdb-rs)           | [mobc-reql](https://github.com/rethinkdb/rethinkdb-rs)      |
| [redis-cluster](https://docs.rs/redis_cluster_async/0.6.0/redis_cluster_async/index.html)                                           | [mobc-redis-cluster](https://github.com/rogeriob2br/mobc-redis-cluster)|

More DB adaptors are welcome.

## Examples

More [examples](https://github.com/importcjj/mobc/tree/master/mobc-foo/examples)

Using an imaginary "foodb" database.

```rust
use mobc::{async_trait, Manager};

#[derive(Debug)]
pub struct FooError;

pub struct FooConnection;

impl FooConnection {
    pub async fn query(&self) -> String {
        "PONG".to_string()
    }
}

pub struct FooManager;

#[async_trait]
impl Manager for FooManager {
    type Connection = FooConnection;
    type Error = FooError;

    async fn connect(&self) -> Result<Self::Connection, Self::Error> {
        Ok(FooConnection)
    }

    async fn check(&self, conn: Self::Connection) -> Result<Self::Connection, Self::Error> {
        Ok(conn)
    }
}
```

## Configures

#### max_open
Sets the maximum number of connections managed by the pool.
>0 means unlimited, defaults to 10.

#### min_idle
Sets the maximum idle connection count maintained by the pool. The pool will maintain at most this many idle connections at all times, while respecting the value of max_open.

#### max_lifetime
Sets the maximum lifetime of connections in the pool. Expired connections may be closed lazily before reuse.
>None meas reuse forever, defaults to None.

#### get_timeout
Sets the get timeout used by the pool. Calls to Pool::get will wait this long for a connection to become available before returning an error. 
>None meas never timeout, defaults to 30 seconds.


## Variable

Some of the connection pool configurations can be adjusted dynamically. Each connection pool instance has the following methods:

* set_max_open_conns
* set_max_idle_conns
* set_conn_max_lifetime

## Stats
* max_open - Maximum number of open connections to the database.
* connections - The number of established connections both in use and idle.
* in_use - The number of connections currently in use.
* idle - The number of idle connections.
* wait_count - The total number of connections waited for.
* wait_duration - The total time blocked waiting for a new connection.
* max_idle_closed - The total number of connections closed due to max_idle.
* max_lifetime_closed - The total number of connections closed due to max_lifetime.

## Compatibility
Because tokio is not compatible with other runtimes, such as async-std. So a database driver written with tokio cannot run in the async-std runtime. For example, you can't use redis-rs in tide because it uses tokio, so the connection pool which bases on redis-res can't be used in tide either.