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 96 97 98 99 100 101 102 103 104 105 106 107 108 109
//! A library for communicating with a libSQL database over HTTP.
//!
//! libsql-client is a lightweight HTTP-based driver for sqld,
//! which is a server mode for libSQL, which is an open-contribution fork of SQLite.
//!
//! libsql-client compiles to wasm32-unknown-unknown target, which makes it a great
//! driver for environments that run on WebAssembly.
//!
//! It is expected to become a general-purpose driver for communicating with sqld/libSQL,
//! but the only backend implemented at the moment is for Cloudflare Workers environment.
pub mod statement;
pub use statement::Statement;
pub mod proto;
pub use proto::{BatchResult, Col, Value};
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct Row {
pub values: Vec<Value>,
#[cfg(feature = "mapping_names_to_values_in_rows")]
pub value_map: std::collections::HashMap<String, Value>,
}
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
pub struct ResultSet {
pub columns: Vec<String>,
pub rows: Vec<Row>,
pub rows_affected: u64,
pub last_insert_rowid: Option<i64>,
}
impl std::convert::From<proto::StmtResult> for ResultSet {
fn from(value: proto::StmtResult) -> Self {
let columns: Vec<String> = value
.cols
.into_iter()
.map(|c| c.name.unwrap_or_default())
.collect();
let rows = value
.rows
.into_iter()
.map(|values| {
#[cfg(feature = "mapping_names_to_values_in_rows")]
let value_map = columns
.iter()
.enumerate()
.map(|(i, c)| (c.to_string(), values[i].clone()))
.collect();
Row {
values,
#[cfg(feature = "mapping_names_to_values_in_rows")]
value_map,
}
})
.collect();
ResultSet {
columns,
rows,
rows_affected: value.affected_row_count,
last_insert_rowid: value.last_insert_rowid,
}
}
}
pub mod client;
pub use client::{new_client, new_client_from_config, Client, Config};
pub mod transaction;
pub use transaction::Transaction;
#[cfg(feature = "workers_backend")]
pub mod workers;
#[cfg(feature = "reqwest_backend")]
pub mod reqwest;
#[cfg(feature = "local_backend")]
pub mod local;
#[cfg(feature = "spin_backend")]
pub mod spin;
#[cfg(feature = "hrana_backend")]
pub mod hrana;
/// A macro for passing parameters to statements without having to manually
/// define their types.
///
/// # Example
///
/// ```rust,no_run
/// # async fn f() -> anyhow::Result<()> {
/// # use crate::libsql_client::{Statement, args};
/// let db = libsql_client::new_client().await?;
/// db.execute(
/// Statement::with_args("INSERT INTO cart(product_id, product_name, quantity, price) VALUES (?, ?, ?, ?)",
/// args!(64, "socks", 2, 4.5)),
/// ).await?;
/// # Ok(())
/// # }
/// ```
#[macro_export]
macro_rules! args {
() => { &[] };
($($param:expr),+ $(,)?) => {
&[$($param.into()),+] as &[libsql_client::Value]
};
}