Home

ThemisDB Documentation

Version: 1.3.0
Last Updated: December 20, 2025

Welcome to the ThemisDB documentation! This guide will help you find the information you need.

---

📚 Quick Navigation

New to ThemisDB?

• Quick Start Guide - Get up and running in 5 minutes
• Installation Guide - Complete installation instructions
• Architecture Overview - Understand how ThemisDB works

Using ThemisDB:

• AQL Query Language - Learn the query language
• REST API Reference - HTTP API documentation
• Client SDKs - SDK documentation for 7 languages

Operating ThemisDB:

• Configuration - Configure your database
• Monitoring - Monitor performance and health
• Backup & Recovery - Protect your data

---

📖 Documentation Structure

Getting Started

Document	Description
Quick Start	5-minute tutorial to get started
Installation	Installation on Linux, Windows, macOS, Docker
Configuration	Configure ThemisDB for your needs
First Query	Write your first AQL query

Core Concepts

Document	Description
Architecture Overview	High-level system architecture
Multi-Model Design	How ThemisDB handles multiple data models
Transaction Model	ACID transactions with MVCC
Storage Layer	RocksDB LSM-Tree storage

Features

Document	Description
Feature Overview	Complete feature catalog
Vector Search	Similarity search with HNSW/FAISS
Graph Operations	Graph traversal and pathfinding
Time-Series	Time-series data and compression
Hypertables	TimescaleDB-compatible time-series (v1.2+)
Hybrid Search	RAG-optimized BM25+Vector search (v1.2+)
Analytics	CEP and OLAP analytics

Query Language (AQL)

Document	Description
AQL Syntax	Complete AQL language reference
AQL Examples	Common query patterns
Query Optimization	EXPLAIN and PROFILE commands

API Reference

Document	Description
REST API	HTTP API endpoints
GraphQL API	GraphQL interface
Client SDKs	SDKs for Python, JS, Rust, Go, Java, C#, Swift

Security & Compliance

Document	Description
Security Overview	Enterprise security features
TLS Setup	Configure TLS 1.3 and mTLS
RBAC Configuration	Role-based access control
Encryption	Data encryption at rest and in transit
Audit Logging	Security event logging
Compliance	GDPR, SOC 2, HIPAA compliance

Operations

Document	Description
Deployment Guide	Production deployment strategies
Docker Deployment	Docker and Kubernetes deployment
Configuration	Configuration reference
Monitoring	Prometheus metrics and alerting
Backup & Recovery	Backup strategies and disaster recovery
Troubleshooting	Common issues and solutions
Performance Tuning	Optimize for your workload

Development

Document	Description
Contributing	How to contribute to ThemisDB
Build Guide	Build from source
Development Setup	Setup development environment
Testing Guide	Run and write tests
Code Style	Coding standards
Architecture	Deep-dive into internals

Advanced Topics

Document	Description
Sharding	Horizontal sharding and routing
Replication	Leader-follower and multi-master
GPU Acceleration	CUDA, Vulkan, HIP backends
vLLM Co-Location	AI/ML workload optimization
Content Processing	Process PDFs, images, videos, etc.

Release Notes

Document	Description
Changelog	Version history and changes
Roadmap	Future plans and features
v1.3.0 Release	Latest release notes
v1.2.0 Release	Previous release
v1.1.0 Release	Previous release
Migration Guides	Upgrade between versions

---

🔍 Search by Topic

By Use Case

Building an Application:

• Quick Start → REST API → Client SDKs

Analytics & BI:

• OLAP Features → Parquet Export → Time-Series

AI/ML Applications:

• Vector Search → Hybrid Search → Embedding Cache

Graph Applications:

• Graph Operations → AQL Graph Queries → Path Algorithms

Production Deployment:

• Deployment Guide → Monitoring → Backup → Security

By Technology

Docker/Kubernetes:

• Docker Deployment
• Kubernetes Guide
• Helm Charts

Cloud Platforms:

• AWS Deployment
• Azure Deployment
• GCP Deployment

ARM/Raspberry Pi:

• ARM Build Guide
• ARM Packages
• Raspberry Pi Optimization

---

📊 Performance & Benchmarks

• Performance Overview
• Benchmarking Guide
• Memory Tuning
• GPU Performance
• Query Optimization

---

🤝 Community Resources

• GitHub Repository: github.com/makr-code/ThemisDB
• Issue Tracker: Report bugs
• Discussions: Community forum
• Contributing: How to contribute
• Security: Security policy

---

📝 Documentation Conventions

Version Indicators:

• No marker: Available in all versions
• (v1.1+): Available from version 1.1.0 onwards
• (v1.2+): Available from version 1.2.0 onwards
• (v1.3+): Available from version 1.3.0 onwards
• 🚧 Experimental: Not production-ready
• 📋 Planned: Future feature

Code Examples:

• Examples use generic placeholders like localhost:8765
• Adjust for your environment
• Most examples work with default configuration

Conventions:

• File paths use forward slashes (works on Windows too)
• Command examples assume bash shell (Windows users: use PowerShell equivalent)

---

🆘 Getting Help

1. Check Documentation: Search this documentation first
2. Search Issues: Check if someone else had the same problem
3. Ask Community: Use GitHub Discussions
4. Report Bug: Open an issue

---

Documentation Version: 1.2.0
Last Updated: December 15, 2025
Next Review: March 15, 2026