🦁 buffdb 🦁

buffdb 是实验性软件。加入 buffdb 的 Discord 寻求帮助，并查看 尚未正常工作的功能。许多基本功能尚未确定。

这是用 Rust 编写的，基于 DuckDB 的 gRPC 持久层的早期实现。目标是抽象出与使用 protobufs 和 flattbuffers 相关的许多复杂性，以便移动用户可以快速访问。

如何运行

要运行服务器，您需要安装 Rust。然后，将仓库克隆后，您可以运行

cargo run --all-features -- run

这将启动服务器在 [::1]:50051，将键值对存储在 kv_store.db 中，将 blob 数据存储在 blob_store.db 中。这三个都可以通过命令行标志进行配置：分别使用 --addr、--kv-store 和 --blob-store。

要启用优化进行构建，请运行 cargo build --all-features --release。生成的二进制文件将位于 target/release/buffdb。它是静态链接的，因此可以在文件系统中的任何位置移动而不会出现问题。

更愿意自己处理 gRPC 服务器？buffdb 也可以作为库使用！

Rust 中示例库的使用

运行 cargo add buffdb tonic tokio futures 以添加必要的依赖项。然后您可以执行以下代码，该代码位于 src/main.rs。

use buffdb::backend::DuckDb;
use buffdb::kv::{Key, KeyValue, Value};
use tonic::{Request, IntoRequest};
use futures::{stream, StreamExt as _};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut client = buffdb::transitive::kv_client::<_, DuckDb>("kv_store.db").await?;
    client
        .set(stream::iter([KeyValue {
            key: "key_set".to_owned(),
            value: "value_set".to_owned(),
        }]))
        .await?
        .into_inner();

    let mut stream = client
        .get(stream::iter([Key {
            key: "key_get".to_owned(),
        }]))
        .await?
        .into_inner();
    let Value { value } = stream.next().await.unwrap()?;
    assert_eq!(value, "value_get");

    Ok(())
}

本项目受悉尼大学计算机科学学院实践教授迈克尔·卡希尔（Michael Cahill）的讨论启发。

命令行界面

您可以使用 buffdb help 来查看允许的命令和标志。目前支持以下操作

• buffdb run [ADDR]，启动服务器。默认地址为 [::1]:50051。
• buffdb kv get <KEY>，将值打印到标准输出。
• buffdb kv set <KEY> <VALUE>，设置值。
• buffdb kv delete <KEY>，删除值。
• buffdb kv eq [KEYS]...，如果所有提供的键的值都相等，则成功退出。如果有任何两个值不相等，则退出时带有错误代码。
• buffdb kv not-eq [KEYS]...，如果所有提供的键的值都是唯一的，则成功退出。如果有任何两个值相等，则退出时带有错误代码。
• buffdb blob get <ID>，将数据打印到标准输出。注意，这是任意字节！
• buffdb blob store <FILE> [METADATA]，存储文件（使用 - 表示标准输入）并将 ID 打印到标准输出。元数据是可选的。
• buffdb blob update <ID> data <FILE>，更新 blob 的数据。使用 - 表示标准输入。元数据保持不变。
• buffdb blob update <ID> metadata [METADATA]，更新 blob 的元数据。数据保持不变。省略 [METADATA] 将元数据设置为 null。
• buffdb blob update <ID> all <FILE> [METADATA]，更新 blob 的数据和元数据。对于 <FILE>，使用 - 表示标准输入。省略 [METADATA] 将元数据设置为 null。
• buffdb blob delete <ID>，删除 blob。
• buffdb blob eq-data [IDS]...，如果所有提供的ID的blob都相等，则成功退出。如果有任何两个blob不相等，则退出时带有错误代码。
• buffdb blob not-eq-data [IDS]...，如果所有提供的ID的blob都是唯一的，则成功退出。如果有任何两个blob相等，则退出时带有错误代码。