Skip to content
Vaylix logo Vaylix logo Vaylix Docs

Overview

Vaylix is a Rust key/value database built around a strict transport boundary:

client -> transport -> TCP/TLS -> transport -> server -> engine

The current system is intentionally narrow and explicit:

  • single-region primary/replica deployment model with automatic leader election
  • UTF-8 string keys with opaque byte values and persisted value versions
  • VTP2 framed binary transport shared by client and server
  • authenticated access enabled by default
  • optional TLS and mTLS transport
  • default-on outbound zstd frame compression
  • segmented WAL plus snapshot durability
  • WAL-based replication with quorum-backed write acknowledgement by default
  • encrypted-at-rest persistence and audit logging
  • logical backup/restore and offline PITR-oriented storage tooling
  • version-based compare-and-set through SET ... IF VERSION

What the Docs Cover

Section titled “What the Docs Cover”

The documentation is split by responsibility so operational and architectural questions stay easy to locate.

  • Getting Started covers release downloads, the published server image, the client binary, and an isolated source-build path.
  • Guides cover client behavior, server operations, and current transaction semantics.
  • Reference documents the CLI, command set, wire protocol, persistence lifecycle, security model, and runtime guards.
  • Developer documents the official application SDKs and programmatic integration surfaces.
  • Architecture explains the transport-first layering and the current runtime boundaries.

What Vaylix Is Not Yet

Section titled “What Vaylix Is Not Yet”

The project is being designed with future growth in mind, but those capabilities are not shipped today.

  • no sharding
  • no distributed ACID semantics
  • no MVCC

Those are roadmap constraints, not current features.

Suggested Reading Order

Section titled “Suggested Reading Order”
  1. Follow Install and Build and Run Server and Client to get a working local setup.
  2. Use Command Reference and CLI Reference for day-to-day operation.
  3. Use Wire Protocol and Persistence and Recovery for implementation-level detail.
  4. Use Project Context as the maintained engineering summary of the current system.