Skip to content

themis docs reports research_postgis_opensearch_h3s2_mvp

makr-code edited this page Dec 2, 2025 · 1 revision

Research-Report: PostGIS vs. OpenSearch vs. H3/S2 – Leitentscheidungen für ThemisDB (MVP)

Ziel: 1–2 Seiten Überblick für Index- und Storage-Entscheidungen in ThemisDB (Geo-MVP). Fokus: Portabilität (Windows/Linux), permissive Lizenzen, schnelle Kandidatenfilter + exakte Geo-Prüfung, einfache Integration in bestehende Engine/HTTP.

Kurzprofil der Optionen

  • PostGIS (Referenz-DB, SQL/OGC ST_*)

    • Storage: WKB/EWKB in geometry-Spalten, Z/M-Varianten, TOAST; GeoJSON als IO.
    • Indizes: GiST/SP-GiST als R-Tree auf MBR (2D), KNN-Unterstützung (<->), BRIN als leichtgewichtige Alternative.
    • Ausführung: Kandidaten via Index (MBR), exakte Tests über GEOS (Prepared Geometries für Speed), umfangreicher ST_* Katalog.
    • Stärken: sehr vollständige Funktionalität, reife Topologie, breite Community; klare Semantik (OGC).
    • Schwächen (für uns): Integration = externer SQL-Server; GEOS/PROJ-Stack (LGPL/MIT) – für In-Process-Core nur optional sinnvoll.
  • OpenSearch (Lucene-basiert, verteilte Suche)

    • Datentypen: geo_point (BKD-Tree), geo_shape (BKD + prägeometrische Zerschnitte/Relationen).
    • Indizes/Ausführung: inverted/bkd-ähnliche Struktur, sehr gut für verteilte Filter, Tiles/Aggregationen; within/intersects/distance werden geometrisch approximiert und verifiziert.
    • Stärken: horizontale Skalierung, REST, Aggregationen/Tile-Kacheln; Apache-2.0.
    • Schwächen (für uns): Inverted/BKD-Index ist komplex/schwergewichtig; nicht ideal für eingebettete, transaktionale Engine; Formen werden vorab zerteilt.
  • H3/S2 (hierarchische Raumzellen)

    • Ansatz: Sphärische Diskretisierung in Zellen-IDs (H3: Hex; S2: Quad auf Sphäre). polyfill(geom, res) → Zellmengen.
    • Nutzung: Sehr schneller Pre-Filter, Sharding/Partitionierung, Aggregation (Heatmaps/Hexbin). Exakte Geometrieprüfung bleibt erforderlich.
    • Stärken: einfache Mengenlogik (Zellen-Sets), skaliert gut, gute Verfügbarkeit (Apache-2.0), ideal für Geofencing/Viewport/Analytics.
    • Schwächen: Approximation; Auflösung/Genauigkeit Trade-off; 3D (Z) nicht abgedeckt; zusätzlicher Precompute/Storage.

Ableitungen (Best Practices)

  • Storage in der Praxis: Binäres WKB/EWKB, GeoJSON für API/Interchange, Sidecar-Felder (MBR, Centroid) für Indizes/Sortierung.
  • Index-Pfad (MVP): R-Tree über MBR (2D) liefert robusten Kandidatenfilter; Z-Range-Index trennt 3D-Pruning; exakte Prüfung mit Boost.Geometry (permissiv) statt hartem GEOS-Depend.
  • Tiling/Cells (H3/S2) sind exzellente Pre-Filter/Analytics-Indizes, aber ergänzend, nicht ersetzend.

Leitentscheidungen (MVP)

  1. Storage

    • WKB/EWKB(Z) als internes Storage-Format (Blob-Feld); GeoJSON als API.
    • Normalisierung: CRS = WGS84 (EPSG:4326) in MVP; Transform optional später (PROJ).
    • Sidecar-Metadaten pro Entity: mbr(minx,miny,maxx,maxy), centroid(lon,lat), z_min, z_max.
  2. Index

    • Primär: R-Tree (R*-ähnlich) über 2D-MBR im SecondaryIndexManager; API: createSpatialIndex(table, column, options).
    • 3D: separater Z-Range-Index (B+-/Range) für schnelles Pruning (Z-Overlap) als AND mit MBR.
    • Optional (nicht MVP): H3-Index (1–2 Auflösungen) für Geo-Prefilter/Aggregationen; S2 Evaluierung später.
  3. Engine/Query-Ausführung

    • Kandidaten: MBR-Scan über R-Tree (+Z-Range-AND), dann exakte Topologie via Boost.Geometry (Intersects/Within/Contains) und Distanz (Haversine für DWithin/Distance in 2D; 3D später).
    • DWithin: MBR-Expand um geodätischen Puffer (approx), dann exakte Distanzprüfung.
    • KNN: ORDER BY Distance mit MBR-Index-gestütztem Early-Out (k-Best Heap) – MVP zunächst seriell, später Heap-gebunden.
  4. Lizenzen

    • Boost.Geometry (BSL-1.0) als Default für exakte Checks.
    • PROJ (MIT/ISC) optional für ST_Transform nach MVP.
    • GEOS (LGPL) nur optional via dyn. Link/Plugin (Prepared Geometries), nicht für MVP erforderlich.
    • H3/S2 (Apache-2.0) optional, nach MVP.

Begründung

  • Implementationsrisiko minimal: R-Tree + Boost.Geometry sind portabel, gut dokumentiert und passen in den bestehenden SecondaryIndexManager/Engine-Ansatz.
  • Korrektheit: Exakte Prädikate bleiben möglich (kein reines Zell-Approx), Semantik an PostGIS orientiert.
  • Performance: R-Tree liefert hohen Pruning-Faktor; Sidecar centroid ermöglicht leichte KNN/Distance; optionaler Z-Range-Index reduziert 3D-Kandidaten signifikant.
  • Evolutionspfad: H3/S2 als Zusatzindex (Analytics/Geofencing), GEOS Prepared Geometries als Speed-Upgrade, GPU/Simd-Pfade später.

Abgrenzung (was wir explizit NICHT im MVP machen)

  • Kein OpenSearch-ähnlicher BKD-/inverted Shape-Index (Komplexität/Footprint).
  • Keine verpflichtenden Copyleft-Libs im Core (GEOS optional, dynamisch).
  • Kein S2/H3 als Primärindex für exakte Topologie (nur Zusatz/Prefilter später).

Risiken & Mitigations

  • Geodätische Genauigkeit (WGS84): MVP nutzt Boost.Geometry + Haversine; PROJ-gestützte ST_Transform folgt in M4.
  • Sehr große Polygone/MultiPolygons: Index kann viele Kandidaten liefern → Prepared-Geom/Cache (später) + Zellen/Tiles für Vorabbeschränkung.
  • Schreibamplifikation im R-Tree: Mit RocksDB CF "spatial" und inkrementeller Pflege begrenzen; Rebuild-API bereitstellen.

Nächste Schritte (konkret)

  • Storage/Sidecar: EWKB(Z) Parser/Serializer, mbr/centroid/z_min/z_max füllen.
  • Index: R-Tree Interface + Metriken (node_count, depth, candidate_count); Z-Range-Index.
  • Engine: ST_Intersects/Within/Contains/DWithin/Distance mit Index+Fallback; Tests gegen Boost.Geometry-Referenz.
  • Optional nach MVP: H3 Pre-Filter (polyfill), GEOS Prepared, SIMD-Kerne (PiP), Morton-Order.

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