Tachyon DB

A lightweight and local time-series database

Requirements

• x86_64 - Linux (x86_64-v3), macOS
• aarch64 - Linux, macOS
• riscv64 - Linux (rv64gc)

Cloning

Cloning with submodules is required:

git clone --recurse-submodules https://github.com/tachyontsdb/tachyon.git

Building

cargo build --locked --release

Note: Generated C/C++ headers will be placed in the output (./target/include) directory.

Running

CLI

cargo run --locked --release --bin tachyon_cli -- <commands>

The documentation for the CLI is available at tachyon_cli/README.md.

Web Backend

cargo run --locked --release --bin tachyon_web_backend

The documentation for the web backend is available at tachyon_web_backend/README.md.

Lints

Format

cargo fmt --all --check

Clippy

cargo clippy --all-targets --all-features --locked --release -- -D warnings

Tests and Benchmarks

First, unzip the ./data.zip file. This should create a ./data directory.

unzip data.zip

Tests

cargo test --locked --release

Benchmarks

cargo bench --locked --bench <bench-name>

Flamegraphs

cargo bench --locked --bench <bench-name> -- --profile-time=20

Timescale DB

Run the following before running the timescaledb or db_benchmark_framework benchmarks:

docker run -d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password timescale/timescaledb-ha:pg16