LiquidCache 项目使用教程

1. 项目目录结构及介绍

LiquidCache 是一个为 DataFusion 系统设计的 S3 缓存项目。以下是项目的目录结构及其功能的简要介绍：

liquid-cache/
├── .github/              # GitHub 工作流和配置文件
├── benchmark/            # 性能测试相关文件
├── dev/                  # 开发文档和示例
├── examples/             # 使用示例和配置文件
├── src/                  # 源代码目录
├── .gitignore            # Git 忽略文件列表
├── Cargo.lock            # Rust 依赖锁文件
├── Cargo.toml            # Rust 项目配置文件
├── LICENSE              # 项目许可证信息
├── README.md             # 项目说明文件
├── rust-toolchain.toml   # Rust 工具链配置文件

2. 项目的启动文件介绍

项目的启动文件位于 src/main.rs。以下是启动文件的主要组成部分：

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let liquid_cache = LiquidCacheService::new(
        SessionContext::new(),
        Some(1024 * 1024 * 1024), // 最大内存缓存大小 1GB
        Some(tempfile::tempdir()?.into_path()), // 磁盘缓存目录
    );

    let flight = FlightServiceServer::new(liquid_cache);
    Server::builder()
        .add_service(flight)
        .serve("0.0.0.0:50051".parse()?)
        .await?;
    Ok(())
}

这段代码首先创建一个 LiquidCacheService 实例，然后启动一个 TCP 服务监听 50051 端口。

3. 项目的配置文件介绍

项目的配置文件主要是 Cargo.toml，这是 Rust 项目的配置文件，其中包含了项目的元数据和依赖信息。以下是配置文件的一些关键部分：

[package]
name = "liquid-cache"
version = "0.1.0"
edition = "2021"

[dependencies]
liquid-cache-client = "0.1.0"

在 [package] 部分，定义了项目的名称、版本和 Rust 版本。在 [dependencies] 部分，列出了项目依赖的其他库。

此外，项目中可能还包括 .github/workflows/ci.yml 文件，用于定义持续集成和持续部署的工作流程。这个文件包含了用于自动化测试和部署的步骤。

以上就是 LiquidCache 项目的使用教程，包括了项目目录结构、启动文件和配置文件的介绍。希望对您有所帮助！