-
Notifications
You must be signed in to change notification settings - Fork 1
INDEX
GitHub Actions edited this page Jan 2, 2026
·
1 revision
Version: 1.3.0
Last Updated: December 20, 2025
Welcome to the ThemisDB documentation! This guide will help you find the information you need.
New to ThemisDB?
- Quick Start Guide - Get up and running in 5 minutes
- Installation Guide - Complete installation instructions
- Architecture Overview - Understand how ThemisDB works
- 🧠 LLM Complete Setup Guide - NEU Vollständiger Guide für LLM-Setup und Inferencing
Business & Strategy:
- Strategiepapier: Industrie 4.0 & IoT - ThemisDB für Smart Manufacturing & IoT-Anwendungen
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
| 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 |
| 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 |
| 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 |
| Document | Description |
|---|---|
| AQL Syntax | Complete AQL language reference |
| AQL Examples | Common query patterns |
| Query Optimization | EXPLAIN and PROFILE commands |
| Document | Description |
|---|---|
| REST API | HTTP API endpoints |
| GraphQL API | GraphQL interface |
| Client SDKs | SDKs for Python, JS, Rust, Go, Java, C#, Swift |
| 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 |
| Document | Description |
|---|---|
| CMS Strategy Paper | ThemisDB für Content Management (Government & Enterprise) |
| Enterprise Edition | Enterprise features and licensing |
| Governance Overview | Data governance and policies |
| 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 |
| 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 |
| 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. |
| 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 |
Building an Application:
Analytics & BI:
AI/ML Applications:
Graph Applications:
Production Deployment:
Docker/Kubernetes:
Cloud Platforms:
ARM/Raspberry Pi:
- GitHub Repository: github.com/makr-code/ThemisDB
- Issue Tracker: Report bugs
- Discussions: Community forum
- Contributing: How to contribute
- Security: Security policy
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)
- Check Documentation: Search this documentation first
- Search Issues: Check if someone else had the same problem
- Ask Community: Use GitHub Discussions
- Report Bug: Open an issue
Documentation Version: 1.2.0
Last Updated: December 15, 2025
Next Review: March 15, 2026
- Architecture-ACCESS-MODEL-IMPLEMENTATION-SUMMARY
- Architecture-ADR-003-pg-dump-sql-parser
- Architecture-BASEENTITY-PRINCIPLE
- Architecture-CACHE-STORAGE-INTEGRATION
- Architecture-CMAKE-ARCHITECTURE
- Architecture-CMAKE-FLAGS-REFERENCE
- Architecture-CMAKE-MODULAR-ARCHITECTURE
- Architecture-CONCERNS-ARCHITECTURE-DIAGRAM
- Architecture-CONCERNS-IMPLEMENTATION-SUMMARY
- Architecture-CONTENT-MODEL
- Architecture-COPILOT-THEMISDB-GRAPH-RAG-BACKEND-ARCHITECTURE
- Architecture-CRYPTO-AND-KEYS
- Architecture-FEATURE-FLAGS-REFERENCE
- Architecture-GPU-ARCHITECTURE-REVIEW-TEMPLATE
- Architecture-HTTP-SHUTDOWN-HARDENING
- Architecture-MIGRATION-GUIDE-CONCERNS
- Architecture-MIGRATION-GUIDE-v13-v14
- Architecture-MODULARIZATION-GUIDE
- Architecture-MODULAR-ARCHITECTURE-ROADMAP
- Architecture-MODULE-ARCHITECTURE-INDEX
- Architecture-P1D01-ISSMPLUGIN-DESIGN-REVIEW
- Architecture-P1-D01-ISSMPLUGIN-DESIGN-REVIEW
- Architecture-P1-D08-MAMBA-GOVERNANCE-CONTRACT
- Architecture-P1-P2-IMPLEMENTATION-COMPLETION-INDEX
- Architecture-PHASE0-COMPLETION-ASSESSMENT
- Architecture-PHASE3-QUERYENGINE-DI-ARCHITECTURE
- Architecture-PHASE4-INDEX-MANAGER-DI
- Architecture-POSTGRESQL-WIRE-PROTOCOL
- Architecture-QUERYENGINE-IMPLEMENTATION-GUIDE
- Architecture-QUERY-SCHEDULING
- Architecture-RAFT-CONSENSUS-DESIGN
- Architecture-README
- Architecture-README-SSM-HYBRID-IMPLEMENTATION
- Architecture-REFACTORING-SUMMARY
- Architecture-RESOURCE-POOLING
- Architecture-SOURCE-DIRECTORY-GUIDE
- Architecture-THEMIS-CORE-GUIDE
- Architecture-UNIFIED-ACCESS-MODEL
- Architecture-WAL-GRPC-MTLS-CONFIGURATION
- Architecture-WIRE-PROTOCOL-RETRY
- Architecture-boltzmann-observability-draft
- Architecture-experimental-logarithmic-vector-storage
- Architecture-llm-wiki-mvp-adr
- Architecture-rewrite-engine-architecture
- Architecture-rope-api-architecture
- Architecture-ssm-gguf-mamba-status
- Architecture-ssm-hybrid-analysis
- Architecture-ssm-hybrid-rollout-plan
- Architecture-ssm-plugin-interface-design-review
- Architecture-transaction-coordinators
- Architecture-wiki-secondary-index
- Architecture-wire-protocol
- Governance-DISABLED-STUB-POLICY
- Governance-DOCS-PR-POLICY
- Governance-GA-PROMOTION-SIGN-OFF
- Governance-GITHUB-MILESTONES-SETUP
- Governance-MATURITY-CLAIM-VERIFICATION-CHECKLIST
- Governance-MATURITY-EVIDENCE-REGISTRY
- Governance-MERGE-GATE-BOT-CONFIG
- Governance-MERGE-GATE-STATUS-LIVE
- Governance-PHASE3-ENFORCEMENT-RUNBOOK
- Governance-PHASE-1-CLOSURE-REPORT
- Governance-PHASE-CLOSURE-POLICY
- Governance-PHASE-DEPENDENCY-GRAPH
- Governance-PLUGIN-SUBMODULE-ROLLBACK
- Governance-PRODUCTION-READY-2026-DELIVERY-PLAN
- Governance-PR-VERSION-TARGETING
- Governance-PR-VERSION-TARGETING-BACKFILL
- Governance-QUERY-MODULE-STATUS
- Governance-README
- Governance-RELEASE-PROMOTION-GATE-POLICY
- Governance-RELEASE-VALIDATION-CHECKLIST
- Governance-SECURITY-MODULE-5671-EVIDENCE-SUMMARY
- Governance-SHARDING-P6-RESIDUAL-RISK-ACCEPTANCE
- Governance-SOURCECODE-COMPLIANCE-GOVERNANCE
- Governance-UPDATES-DEVELOPMENT-STATUS-SIGN-OFF
- Governance-WAVE-C-IMPLEMENTATION-COMPLETE
- Module-acceleration-Roadmap
- Module-access-model-Roadmap
- Module-ai-Roadmap
- Module-analytics-Roadmap
- Module-api-Roadmap
- Module-aql-Roadmap
- Module-auth-Roadmap
- Module-base-Roadmap
- Module-cache-Roadmap
- Module-cdc-Roadmap
- Module-chaos-Roadmap
- Module-chimera-Roadmap
- Module-config-Roadmap
- Module-content-Roadmap
- Module-core-Roadmap
- Module-distributed-knowledge-Roadmap
- Module-distributed-tensor-Roadmap
- Module-document-Roadmap
- Module-ethics-ai-Roadmap
- Module-evaluation-Roadmap
- Module-execution-Roadmap
- Module-exporters-Roadmap
- Module-failover-Roadmap
- Module-geo-Roadmap
- Module-governance-Roadmap
- Module-gpu-Roadmap
- Module-graph-Roadmap
- Module-image-analysis-Roadmap
- Module-importers-Roadmap
- Module-index-Roadmap
- Module-ingestion-Roadmap
- Module-llama-cpp-Roadmap
- Module-llm-Roadmap
- Module-llm-streaming-Roadmap
- Module-llm-wiki-Roadmap
- Module-maintenance-Roadmap
- Module-metadata-Roadmap
- Module-network-Roadmap
- Module-observability-Roadmap
- Module-onnx-clip-Roadmap
- Module-performance-Roadmap
- Module-plugins-Roadmap
- Module-process-Roadmap
- Module-projects-Roadmap
- Module-prompt-engineering-Roadmap
- Module-query-Roadmap
- Module-rag-Roadmap
- Module-replication-Roadmap
- Module-retrieval-Roadmap
- Module-rpc-grpc-Roadmap
- Module-scheduler-Roadmap
- Module-scraper-Roadmap
- Module-search-Roadmap
- Module-security-Roadmap
- Module-server-Roadmap
- Module-sharding-Roadmap
- Module-stable-diffusion-Roadmap
- Module-storage-Roadmap
- Module-temporal-Roadmap
- Module-tensor-Roadmap
- Module-themis-Roadmap
- Module-timeseries-Roadmap
- Module-toolbox-Roadmap
- Module-training-Roadmap
- Module-transaction-Roadmap
- Module-updates-Roadmap
- Module-user-storage-encrypted-Roadmap
- Module-utils-Roadmap
- Module-vector-search-Roadmap
- Module-voice-Roadmap
- Module-whisper-Roadmap