deadpool-libsql 0.1.1

Dead simple async pool for libsql
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

# Deadpool for libsql [![Latest Version](https://img.shields.io/crates/v/deadpool-libsql.svg)](https://crates.io/crates/deadpool-libsql) [![Build Status](https://img.shields.io/github/actions/workflow/status/deadpool-rs/deadpool/deadpool-libsql.yml?branch=main)](https://github.com/deadpool-rs/deadpool/actions/workflows/deadpool-libsql.yml?query=branch%3Amain) ![Unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg "Unsafe forbidden") [![Rust 1.85+](https://img.shields.io/badge/rustc-1.85+-lightgray.svg "Rust 1.85+")](https://blog.rust-lang.org/2025/02/20/Rust-1.85.0/)

Deadpool is a dead simple async pool for connections and objects
of any type.

This crate implements a [`deadpool`](https://crates.io/crates/deadpool)
manager for [`libsql`](https://crates.io/crates/libsql).

## Features

| Feature          | Description                                                              | Extra dependencies               | Default |
| ---------------- | ------------------------------------------------------------------------ | -------------------------------- | ------- |
| `rt_tokio_1`     | Enable support for [tokio](https://crates.io/crates/tokio) crate         | `deadpool/rt_tokio_1`            | yes     |
| `rt_async-std_1` | Enable support for [async-std](https://crates.io/crates/async-std) crate | `deadpool/rt_async-std_1`        | no      |
| `serde`          | Enable support for [serde](https://crates.io/crates/serde) crate         | `deadpool/serde`, `serde/derive` | no      |

All of the features of [libsql](https://crates.io/crates/libsql) are also re-exported.
For example, the feature `core` does enable the feature `core` from the `libsql` crate.

## Example

```rust
use std::sync::Arc;

use deadpool_libsql::{Manager, Pool};
use deadpool_libsql::libsql::{Builder, params};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let db = deadpool_libsql::libsql::Builder::new_local("libsql.db")
        .build()
        .await?;

    let manager = Manager::from_libsql_database(db);
    let pool = Pool::builder(manager).build()?;

    let conn = pool.get().await?;
    let mut rows = conn.query("SELECT 1", params![]).await?;
    let row = rows.next().await?.unwrap();
    let result: i64 = row.get(0)?;

    Ok(())
}
```

## Example with `config` and `dotenvy` crate

```env
# .env
LIBSQL__DATABASE=Local
LIBSQL__PATH=deadpool.db
```

```rust,ignore
use deadpool_libsql::{libsql::params, Runtime};
use dotenvy::dotenv;

#[derive(Debug, serde::Deserialize)]
struct Config {
    libsql: deadpool_libsql::Config,
}

impl Config {
    pub fn from_env() -> Result<Self, config::ConfigError> {
        config::Config::builder()
            .add_source(config::Environment::default().separator("__"))
            .build()?
            .try_deserialize()
    }
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    dotenv().ok();
    let cfg = Config::from_env().expect("Invalid config");
    let pool = cfg.libsql.create_pool(Some(Runtime::Tokio1)).await?;
    for i in 1..10i64 {
        let conn = pool.get().await?;
        let mut rows = conn.query("SELECT 1 + $1", params![i]).await?;
        let row = rows.next().await?.unwrap();
        let value: i64 = row.get(0)?;
        assert_eq!(value, i + 1);
    }
    Ok(())
}
```

## License

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.