Rust quickstart

This guide creates an in-memory Lix repository, writes a file, reads its history, and undoes the latest change.

Install

cargo add lix
cargo add tokio --features macros,rt-multi-thread

Write and update a file

#[tokio::main]
async fn main() -> Result<(), lix::LixError> {
    let lix = lix::open_lix().await?;

    lix.execute(
        "INSERT INTO lix_file (path, content) VALUES ($1, $2)",
        &[
            lix::Value::Text("/hello.txt".to_owned()),
            lix::Value::Blob(b"Hello".as_slice().into()),
        ],
    )
    .await?;
    lix.execute(
        "UPDATE lix_file SET content = $1 WHERE path = $2",
        &[
            lix::Value::Blob(b"Hello from Lix".as_slice().into()),
            lix::Value::Text("/hello.txt".to_owned()),
        ],
    )
    .await?;

    let history = lix
        .execute(
            "SELECT path, lixcol_depth \
             FROM lix_history('lix_file') \
             WHERE path = $1 \
             ORDER BY lixcol_depth",
            &[lix::Value::Text("/hello.txt".to_owned())],
        )
        .await?;

    println!("{} versions", history.rows().len());

    lix.undo().await?;
    lix.close().await?;
    Ok(())
}

Lix records both writes automatically. You do not need to create commits. Depth 0 is the state at the head. Higher numbers walk back through history.

execute() runs one statement. To run several statements atomically, pass an array of statements to lix.execute_batch. Do not concatenate SQL into one script string.

The repository is in memory and disappears when the process ends. For native persistence, use lix-storage-rocksdb or lix-storage-filesystem. See Persistence and Storage.

Rust quickstart

Install

Write and update a file

Next