⚡ Blazing Performance

# O(1) lookups - Always fast
doc = client.get(doc_id)
# Sub-millisecond response time

✨ In-memory operations
✨ Hash-based indexing
✨ Zero query overhead

🛡️ Enterprise Reliability

# Crash? No problem.
# WAL recovery restores everything

✨ Write-Ahead Logging (WAL)
✨ Automatic crash recovery
✨ SHA-256 integrity checks

🎯 Developer Experience

# One line to start
docker run -p 8000:8000 ashfromsky/yaradb

✨ RESTful API + OpenAPI docs
✨ Zero configuration
✨ Native Python client

🔧 Smart Flexibility

# Free mode or strict schemas
# Your choice, your rules

✨ Schema-free OR JSON Schema
✨ Optimistic locking (OCC)
✨ Soft deletes built-in

🐳 Docker

Linux / macOS:

docker pull ashfromsky/yaradb:latest
docker run -d \
  --name yaradb_server \
  -p 8000:8000 \
  -v $(pwd)/data:/data \
  ashfromsky/yaradb:latest

Windows (PowerShell):

docker pull ashfromsky/yaradb:latest
docker run -d `
  --name yaradb_server `
  -p 8000:8000 `
  -v ${PWD}/data:/data `
  ashfromsky/yaradb:latest

Windows (CMD):

docker pull ashfromsky/yaradb:latest
docker run -d ^
  --name yaradb_server ^
  -p 8000:8000 ^
  -v %cd%/data:/data ^
  ashfromsky/yaradb:latest

_{Recommended • Production-ready}

📦 Docker Compose

services:
  yaradb:
    image: ashfromsky/yaradb
    ports: ["8000:8000"]
    volumes: ["./data:/data"]

_{Easy • One command deploy}

🐍 From Source

git clone https://github.com/illusiOxd/yaradb
cd yaradb
pip install -r requirements.txt
python main.py

_{Development • Full control}

🌐 REST API

# Create a document
curl -X POST http://localhost:8000/document/create \
  -H "Content-Type: application/json" \
  -d '{
    "table_name": "users",
    "body": {
      "name": "Alice",
      "email": "[email protected]",
      "role": "admin"
    }
  }'

# Get by ID
curl http://localhost:8000/document/get/{doc_id}

# Update with version control
curl -X PUT http://localhost:8000/document/update/{doc_id} \
  -d '{"version": 1, "body": {"name": "Alice Smith"}}'

# Soft delete
curl -X PUT http://localhost:8000/document/archive/{doc_id}

🐍 Python Client

Install:

pip install yaradb-client

Use:

from yaradb_client import YaraClient

client = YaraClient("http://localhost:8000")

# Create
doc = client.create(
    table_name="users",
    body={
        "name": "Alice",
        "email": "[email protected]",
        "level": 5
    }
)

# Read
user = client.get(doc["_id"])

# Update (with optimistic locking)
updated = client.update(
    doc_id=doc["_id"],
    version=doc["version"],
    body={"name": "Alice", "level": 6}
)

# Search
results = client.find({"level": 6})

# Archive (soft delete)
client.archive(doc["_id"])

🎯 Write Path

1. Validate request
2. Append to WAL
3. Update memory
4. Return success

_{~2ms latency}

📖 Read Path

1. Hash lookup
2. Return from RAM
3. Done!

_{<1ms latency}

🔄 Crash Recovery

1. Load snapshot
2. Replay WAL
3. Rebuild index
4. Ready!

_{Automatic on startup}

💾 Checkpoints

1. Serialize state
2. Write snapshot
3. Truncate WAL
4. Continue

_{Background process}

Prototyping

Spin up a database in seconds. No complex setup, no configuration files.

Real-Time Apps

WebSockets, live dashboards, gaming leaderboards - anywhere speed matters.

Microservices

Lightweight data layer for containerized architectures.

Testing

Fast, ephemeral test databases. Create, test, destroy.

Edge Computing

Low footprint, works anywhere Docker runs.

📖 Complete Documentation

Full guides, tutorials, and best practices

🔌 API Reference

REST endpoints, schemas, and examples

🏗️ Architecture Deep Dive

WAL internals, OCC, and design decisions

🐛 Report Bugs

Found an issue?
Open an Issue →

💡 Request Features

Have an idea?
Share It →

📝 Improve Docs

Make it clearer
Edit on GitHub →

🔧 Submit Code

Fork • Code • PR
Guidelines →