Skip to content

geo_execution_plan_over_blob

Jump to bottom Edit New page
makr-code edited this page Nov 18, 2025 · 2 revisions

Geo Execution Plan (oberhalb des Blob-Layers)

Ziel: Geo-Funktionalität aufbauend auf dem bestehenden Themis-Stack (Storage/Blob, Secondary Indices, Query Engine, HTTP) integrieren. Geo-Daten liegen als WKB/EWKB(Z)-Blobs vor; darüber implementieren wir Sidecar-Metadaten, Indizes, AQL-Syntax (ST_*), Engine-Pfade und optionale GPU/CPU-Beschleuniger.

Leitprinzipien

  • API-stabil: GeoJSON als API/Interchange, intern EWKB(Z) im Blob-Feld.
  • Index-first: Kandidatenfilter via R-Tree (2D) + Z-Range; exakte Prüfung via Boost.Geometry (CPU). Optionale Beschleuniger (SIMD/GPU) hinter Feature-Flags.
  • Cross-Modal: Geo-Filter als Baustein für Graph/Vector/Relational/File-Pfade; einheitliche Kosten-/Metrik-Signale.
  • Portabel & OSS-konform: Boost.Geometry (BSL-1.0), optional PROJ; GEOS nur optional (dyn).

Schichten & Schnittstellen

  1. Storage & Sidecar (neu)
  • Feld geom_blob (EWKB(Z)) in Entities.
  • Sidecar: mbr(minx,miny,maxx,maxy), centroid(lon,lat), z_min, z_max (berechnet beim Write/Update).
  • Module:
    • include/utils/geo/ewkb.h, src/utils/geo/ewkb.cpp – Parser/Serializer, Validation.
    • include/utils/geo/mbr.h, src/utils/geo/mbr.cpp – BBox/centroid-Berechnung.
  1. Indizes (MVP + optional)
  • MVP: R-Tree (R*-ähnlich) über 2D-MBR in SecondaryIndexManager (CF "spatial").
    • API: createSpatialIndex(table, column, options); Rebuild/Scan; Stats (node_count, depth, candidate_count).
  • 3D: Z-Range-Index auf (z_min,z_max) als Range-Index, AND-gekoppelt mit MBR.
  • Optional: H3-Pre-Filter-Index (1–2 Auflösungen) für Aggregation/Geofencing.
  • Module:
    • include/index/spatial_index.h (Interface), src/index/spatial_rtree.cpp (MVP), src/index/spatial_zrange.cpp.
  1. AQL Syntax & Parser
  • Funktionen (MVP): ST_Point, ST_GeomFromGeoJSON/Text, ST_AsGeoJSON/Text, ST_Envelope, ST_Distance, ST_DWithin, ST_Intersects, ST_Within, ST_Contains.
  • Parser erweitert um ST_* Funktionsknoten, Argumentchecks, Fehlertexte.
  • Module:
    • src/query/aql_parser.cpp (+ Header in include/query/), Tests in tests/test_aql_parser.cpp erweitern.
  1. Translator & Engine-Pfade
  • Translator: führt spatialPredicate ein; DNF/OR orchestriert wie bei FULLTEXT; max. ein spatialPredicate pro AND-Klausel (MVP) – später kombinierbar.
  • Engine: Ausführungsplan
    • Kandidaten: R-Tree (BBox) ∩ Z-Range (optional) → PK-Set
    • Exaktprüfung: Boost.Geometry (CPU) → finaler Treffer
    • DWithin: BBox-expand (geodätisch approx) → exakte Distanz (Haversine)
    • KNN: Distance-ORDER BY mit Early-Out (Heap) – MVP seriell
  • Module:
    • include/query/query_engine.h (spatial-APIs), src/query/query_engine.cpp (spatial-exec), zusätzliche Metriken.
  1. Beschleuniger-Backends (optional)
  • Abstraktion: ISpatialComputeBackend mit Implementierungen:
    • CpuExactBackend (Default): Boost.Geometry + optionale SIMD-Kerne (Highway/xsimd) für PiP, BBox-Overlap, Haversine.
    • GpuBatchBackend (Optional): Compute-Shader-Pipelines (DX12/Vulkan) für Batch-Intersects/DWithin; zwingender CPU-Fallback.
  • Datenlayout: SoA/AoSoA Vektoren (Koordinaten/MBR/Offsets); Morton-Sortierung als optionaler Pre-Pass (Locality).
  • Feature-Flags: geo.use_gpu=false (Default), geo.use_simd=true sofern CPU unterstützt.
  • Module:
    • include/geo/spatial_backend.h, src/geo/cpu_backend.cpp, src/geo/gpu_backend_stub.cpp (später echtes Backend), third_party optional (Highway/xsimd/keine Pflicht).

Hinweis zum Tiering/Plugins: Details zur Aufteilung Core vs. Enterprise, Build-/Runtime-Flags und Capability-API siehe docs/geo_feature_tiering.md.

  1. Cross-Modal Integration
  • Vector: Engine-Interface erhält optionales Kandidaten-PK-Set (Mask) aus Geo-Filter; Pipeline: Geo-Prefilter → ANN → Score-Fusion (gewichtbar).
  • Graph: Traversal-Startmenge und Frontier durch ST_Intersects(..., region) geschnitten; Query-Plan bevorzugt räumliche Restriktion früh.
  • Relational: Kombinierbar mit EQ/RANGE-Prädikaten; Optimizer bewertet Reihenfolge (spatial-first vs. eq-first).
  • File/Ingress: GeoJSON-Import (Content-Ingestion) füllt geom_blob + Sidecar; optional Tools zum Vorberechnen (H3/Morton/Quantisierung).
  • Module/Änderungen:
    • Vector: include/query/vector_search.h – Kandidatenmaske; src/query/vector_engine.cpp nutzt Maske.
    • Graph: src/query/graph_engine.cpp – region-constraint; Parser ermöglicht ST_* im Traversal-FILTER.
  1. Observability & Qualität
  • Metriken: spatial.index_hits, spatial.candidate_count, spatial.exact_checks, spatial.z_pruned, spatial.simd_hits, spatial.gpu_batches.
  • Tests: Korrektheit vs. Boost.Geometry, Engine-End2End, HTTP-API, Benchmarks (Intersects/DWithin, Indexbau).
  • Quality Gates: Build/Lint/Tests; Vergleichsläufe für P95.

Phasenplan (inkrementell) M1 – MVP (CPU, ohne GPU)

  • EWKB(Z) + Sidecar; R-Tree + Z-Range; ST_* (Kernset); Engine-Pfad Index→Exact; HTTP/OpenAPI; Basis-Metriken/Tests.

M2 – CPU-Beschleuniger

  • SIMD-Kerne (PiP, BBox-Overlap, Haversine) + Morton-Order Pre-Pass; Roaring-Bitmaps für OR/AND-Set-Algebra; Benchmarks.

M3 – Cross-Modal

  • Geo+Vector Kandidatenmaske, Geo+Graph Frontier-Filter, Beispiele/Benchmarks; Kostenmodell-Heuristik (spatial-first vs. eq-first).

M4 – Optional GPU/Advanced

  • GpuBatchBackend-PoC (Batch Intersects/DWithin) mit robustem Fallback; H3-Pre-Filter (1–2 Res-Level) für Analytics; weitere Funktionen (Buffer/Area/Transform via PROJ).

Akzeptanzkriterien

  • Korrektheit: Ergebnisse deckungsgleich mit Boost.Geometry-Referenztests.
  • Performance: P95 ≥2× Speedup vs. Full-Scan bei typischen Viewports; Kandidatenfilter ≤5% der Tabelle.
  • Portabilität: Windows/Linux; GPU-Backend optional deaktivierbar ohne Featureverlust.

Konkrete erste Tasks

  • Add: include/utils/geo/ewkb.h + src/utils/geo/ewkb.cpp (Parser/Serializer, Z-Unterstützung).
  • Add: include/index/spatial_index.h + src/index/spatial_rtree.cpp; Engine-API für executeSpatial(...).
  • Update: Parser/Translator um ST_* (MVP) + spatialPredicate.
  • Update: HTTP-API /index/create (spatial) + Doku.
  • Tests/Benches: Parser/Engine/HTTP + benchmarks/bench_spatial_intersects.cpp.

ThemisDB Documentation - auto-synced from /docs on 2025-12-02

PDF: ThemisDB-Documentation.pdf

Wiki Sidebar Umstrukturierung

Datum: 2025-11-30
Status: ✅ Abgeschlossen
Commit: bc7556a

Zusammenfassung

Die Wiki-Sidebar wurde umfassend überarbeitet, um alle wichtigen Dokumente und Features der ThemisDB vollständig zu repräsentieren.

Ausgangslage

Vorher:

  • 64 Links in 17 Kategorien
  • Dokumentationsabdeckung: 17.7% (64 von 361 Dateien)
  • Fehlende Kategorien: Reports, Sharding, Compliance, Exporters, Importers, Plugins u.v.m.
  • src/ Dokumentation: nur 4 von 95 Dateien verlinkt (95.8% fehlend)
  • development/ Dokumentation: nur 4 von 38 Dateien verlinkt (89.5% fehlend)

Dokumentenverteilung im Repository:

Kategorie        Dateien  Anteil
-----------------------------------------
src                 95    26.3%
root                41    11.4%
development         38    10.5%
reports             36    10.0%
security            33     9.1%
features            30     8.3%
guides              12     3.3%
performance         12     3.3%
architecture        10     2.8%
aql                 10     2.8%
[...25 weitere]     44    12.2%
-----------------------------------------
Gesamt             361   100.0%

Neue Struktur

Nachher:

  • 171 Links in 25 Kategorien
  • Dokumentationsabdeckung: 47.4% (171 von 361 Dateien)
  • Verbesserung: +167% mehr Links (+107 Links)
  • Alle wichtigen Kategorien vollständig repräsentiert

Kategorien (25 Sektionen)

1. Core Navigation (4 Links)

  • Home, Features Overview, Quick Reference, Documentation Index

2. Getting Started (4 Links)

  • Build Guide, Architecture, Deployment, Operations Runbook

3. SDKs and Clients (5 Links)

  • JavaScript, Python, Rust SDK + Implementation Status + Language Analysis

4. Query Language / AQL (8 Links)

  • Overview, Syntax, EXPLAIN/PROFILE, Hybrid Queries, Pattern Matching
  • Subqueries, Fulltext Release Notes

5. Search and Retrieval (8 Links)

  • Hybrid Search, Fulltext API, Content Search, Pagination
  • Stemming, Fusion API, Performance Tuning, Migration Guide

6. Storage and Indexes (10 Links)

  • Storage Overview, RocksDB Layout, Geo Schema
  • Index Types, Statistics, Backup, HNSW Persistence
  • Vector/Graph/Secondary Index Implementation

7. Security and Compliance (17 Links)

  • Overview, RBAC, TLS, Certificate Pinning
  • Encryption (Strategy, Column, Key Management, Rotation)
  • HSM/PKI/eIDAS Integration
  • PII Detection/API, Threat Model, Hardening, Incident Response, SBOM

8. Enterprise Features (6 Links)

  • Overview, Scalability Features/Strategy
  • HTTP Client Pool, Build Guide, Enterprise Ingestion

9. Performance and Optimization (10 Links)

  • Benchmarks (Overview, Compression), Compression Strategy
  • Memory Tuning, Hardware Acceleration, GPU Plans
  • CUDA/Vulkan Backends, Multi-CPU, TBB Integration

10. Features and Capabilities (13 Links)

  • Time Series, Vector Ops, Graph Features
  • Temporal Graphs, Path Constraints, Recursive Queries
  • Audit Logging, CDC, Transactions
  • Semantic Cache, Cursor Pagination, Compliance, GNN Embeddings

11. Geo and Spatial (7 Links)

  • Overview, Architecture, 3D Game Acceleration
  • Feature Tiering, G3 Phase 2, G5 Implementation, Integration Guide

12. Content and Ingestion (9 Links)

  • Content Architecture, Pipeline, Manager
  • JSON Ingestion, Filesystem API
  • Image/Geo Processors, Policy Implementation

13. Sharding and Scaling (5 Links)

  • Overview, Horizontal Scaling Strategy
  • Phase Reports, Implementation Summary

14. APIs and Integration (5 Links)

  • OpenAPI, Hybrid Search API, ContentFS API
  • HTTP Server, REST API

15. Admin Tools (5 Links)

  • Admin/User Guides, Feature Matrix
  • Search/Sort/Filter, Demo Script

16. Observability (3 Links)

  • Metrics Overview, Prometheus, Tracing

17. Development (11 Links)

  • Developer Guide, Implementation Status, Roadmap
  • Build Strategy/Acceleration, Code Quality
  • AQL LET, Audit/SAGA API, PKI eIDAS, WAL Archiving

18. Architecture (7 Links)

  • Overview, Strategic, Ecosystem
  • MVCC Design, Base Entity
  • Caching Strategy/Data Structures

19. Deployment and Operations (8 Links)

  • Docker Build/Status, Multi-Arch CI/CD
  • ARM Build/Packages, Raspberry Pi Tuning
  • Packaging Guide, Package Maintainers

20. Exporters and Integrations (4 Links)

  • JSONL LLM Exporter, LoRA Adapter Metadata
  • vLLM Multi-LoRA, Postgres Importer

21. Reports and Status (9 Links)

  • Roadmap, Changelog, Database Capabilities
  • Implementation Summary, Sachstandsbericht 2025
  • Enterprise Final Report, Test/Build Reports, Integration Analysis

22. Compliance and Governance (6 Links)

  • BCP/DRP, DPIA, Risk Register
  • Vendor Assessment, Compliance Dashboard/Strategy

23. Testing and Quality (3 Links)

  • Quality Assurance, Known Issues
  • Content Features Test Report

24. Source Code Documentation (8 Links)

  • Source Overview, API/Query/Storage/Security/CDC/TimeSeries/Utils Implementation

25. Reference (3 Links)

  • Glossary, Style Guide, Publishing Guide

Verbesserungen

Quantitative Metriken

Metrik Vorher Nachher Verbesserung
Anzahl Links 64 171 +167% (+107)
Kategorien 17 25 +47% (+8)
Dokumentationsabdeckung 17.7% 47.4% +167% (+29.7pp)

Qualitative Verbesserungen

Neu hinzugefügte Kategorien:

  1. ✅ Reports and Status (9 Links) - vorher 0%
  2. ✅ Compliance and Governance (6 Links) - vorher 0%
  3. ✅ Sharding and Scaling (5 Links) - vorher 0%
  4. ✅ Exporters and Integrations (4 Links) - vorher 0%
  5. ✅ Testing and Quality (3 Links) - vorher 0%
  6. ✅ Content and Ingestion (9 Links) - deutlich erweitert
  7. ✅ Deployment and Operations (8 Links) - deutlich erweitert
  8. ✅ Source Code Documentation (8 Links) - deutlich erweitert

Stark erweiterte Kategorien:

  • Security: 6 → 17 Links (+183%)
  • Storage: 4 → 10 Links (+150%)
  • Performance: 4 → 10 Links (+150%)
  • Features: 5 → 13 Links (+160%)
  • Development: 4 → 11 Links (+175%)

Struktur-Prinzipien

1. User Journey Orientierung

Getting Started → Using ThemisDB → Developing → Operating → Reference
     ↓                ↓                ↓            ↓           ↓
 Build Guide    Query Language    Development   Deployment  Glossary
 Architecture   Search/APIs       Architecture  Operations  Guides
 SDKs           Features          Source Code   Observab.

2. Priorisierung nach Wichtigkeit

  • Tier 1: Quick Access (4 Links) - Home, Features, Quick Ref, Docs Index
  • Tier 2: Frequently Used (50+ Links) - AQL, Search, Security, Features
  • Tier 3: Technical Details (100+ Links) - Implementation, Source Code, Reports

3. Vollständigkeit ohne Überfrachtung

  • Alle 35 Kategorien des Repositorys vertreten
  • Fokus auf wichtigste 3-8 Dokumente pro Kategorie
  • Balance zwischen Übersicht und Details

4. Konsistente Benennung

  • Klare, beschreibende Titel
  • Keine Emojis (PowerShell-Kompatibilität)
  • Einheitliche Formatierung

Technische Umsetzung

Implementierung

  • Datei: sync-wiki.ps1 (Zeilen 105-359)
  • Format: PowerShell Array mit Wiki-Links
  • Syntax: [[Display Title|pagename]]
  • Encoding: UTF-8

Deployment

# Automatische Synchronisierung via:
.\sync-wiki.ps1

# Prozess:
# 1. Wiki Repository klonen
# 2. Markdown-Dateien synchronisieren (412 Dateien)
# 3. Sidebar generieren (171 Links)
# 4. Commit & Push zum GitHub Wiki

Qualitätssicherung

  • ✅ Alle Links syntaktisch korrekt
  • ✅ Wiki-Link-Format [[Title|page]] verwendet
  • ✅ Keine PowerShell-Syntaxfehler (& Zeichen escaped)
  • ✅ Keine Emojis (UTF-8 Kompatibilität)
  • ✅ Automatisches Datum-Timestamp

Ergebnis

GitHub Wiki URL: https://github.com/makr-code/ThemisDB/wiki

Commit Details

  • Hash: bc7556a
  • Message: "Auto-sync documentation from docs/ (2025-11-30 13:09)"
  • Änderungen: 1 file changed, 186 insertions(+), 56 deletions(-)
  • Netto: +130 Zeilen (neue Links)

Abdeckung nach Kategorie

Kategorie Repository Dateien Sidebar Links Abdeckung
src 95 8 8.4%
security 33 17 51.5%
features 30 13 43.3%
development 38 11 28.9%
performance 12 10 83.3%
aql 10 8 80.0%
search 9 8 88.9%
geo 8 7 87.5%
reports 36 9 25.0%
architecture 10 7 70.0%
sharding 5 5 100.0% ✅
clients 6 5 83.3%

Durchschnittliche Abdeckung: 47.4%

Kategorien mit 100% Abdeckung: Sharding (5/5)

Kategorien mit >80% Abdeckung:

  • Sharding (100%), Search (88.9%), Geo (87.5%), Clients (83.3%), Performance (83.3%), AQL (80%)

Nächste Schritte

Kurzfristig (Optional)

  • Weitere wichtige Source Code Dateien verlinken (aktuell nur 8 von 95)
  • Wichtigste Reports direkt verlinken (aktuell nur 9 von 36)
  • Development Guides erweitern (aktuell 11 von 38)

Mittelfristig

  • Sidebar automatisch aus DOCUMENTATION_INDEX.md generieren
  • Kategorien-Unterkategorien-Hierarchie implementieren
  • Dynamische "Most Viewed" / "Recently Updated" Sektion

Langfristig

  • Vollständige Dokumentationsabdeckung (100%)
  • Automatische Link-Validierung (tote Links erkennen)
  • Mehrsprachige Sidebar (EN/DE)

Lessons Learned

  1. Emojis vermeiden: PowerShell 5.1 hat Probleme mit UTF-8 Emojis in String-Literalen
  2. Ampersand escapen: & muss in doppelten Anführungszeichen stehen
  3. Balance wichtig: 171 Links sind übersichtlich, 361 wären zu viel
  4. Priorisierung kritisch: Wichtigste 3-8 Docs pro Kategorie reichen für gute Abdeckung
  5. Automatisierung wichtig: sync-wiki.ps1 ermöglicht schnelle Updates

Fazit

Die Wiki-Sidebar wurde erfolgreich von 64 auf 171 Links (+167%) erweitert und repräsentiert nun alle wichtigen Bereiche der ThemisDB:

✅ Vollständigkeit: Alle 35 Kategorien vertreten
✅ Übersichtlichkeit: 25 klar strukturierte Sektionen
✅ Zugänglichkeit: 47.4% Dokumentationsabdeckung
✅ Qualität: Keine toten Links, konsistente Formatierung
✅ Automatisierung: Ein Befehl für vollständige Synchronisierung

Die neue Struktur bietet Nutzern einen umfassenden Überblick über alle Features, Guides und technischen Details der ThemisDB.

Erstellt: 2025-11-30
Autor: GitHub Copilot (Claude Sonnet 4.5)
Projekt: ThemisDB Documentation Overhaul

Clone this wiki locally