git-vdb 0.4.0

An embedded vector database backed by immutable Git trees
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

# History and Git transport

Every named write creates a commit and advances
`refs/git-vdb/collections/<name>` atomically. Ordinary searches do not create
objects or move refs.

```rust,no_run
use git_vdb::{open, Point};

fn main() -> git_vdb::Result<()> {
    let docs = open("./vectors.git")?.collection("docs");
    docs.upsert([Point::new("v1", [1.0, 0.0])])?;
    docs.upsert([Point::new("v2", [0.0, 1.0])])?;
    let history = docs.advanced()?.history(10)?;
    assert_eq!(history.len(), 3); // create plus two writes
    Ok(())
}
```

Push or fetch the collection ref with stock Git:

```sh
git --git-dir vectors.git push origin \
  refs/git-vdb/collections/docs:refs/git-vdb/collections/docs
```

Or use the ref-aware CLI wrappers:

```sh
git-vdb --db vectors.git push docs origin
git-vdb --db vectors.git pull docs origin
git-vdb --db vectors.git restore docs <root-or-commit>
```

Use `Collection::at` for historical reads, `diff` to compare roots, and
`validate` before accepting data from an untrusted transport.