Files
archivdms/internal/storage/migrations
patrick 9a24ea29e1 FDN-01: repository & projektgerüst
Git-Repository für bestehenden archivdms-Code initialisiert, Branch-/Commit-Konvention (feature/<ticket>-<slug>-Branches, Ticket-Prefix in Commit-Nachricht) etabliert.
2026-08-11 21:27:53 +02:00
..
2026-08-11 21:27:53 +02:00

Migrations-Konvention

archivdms verwendet, wie archivmail, kein externes Migrationstool. Das tatsächliche Schema wird idempotent zur Laufzeit von initSchema()-Funktionen in den jeweiligen Store-Paketen angelegt/erweitert (CREATE TABLE IF NOT EXISTS, ALTER TABLE ... ADD COLUMN IF NOT EXISTS, CREATE INDEX IF NOT EXISTS). Das ist sicher gegen mehrfaches Ausführen und gegen bereits existierende Produktiv-Datenbanken.

Dieses Verzeichnis dokumentiert trotzdem jede Schemaänderung als nummerierte NNN_name.sql-Datei — rein informativ/Doku, nicht ausführbar über ein Migrationstool. Sie dient als:

  • lesbare Historie, welche Änderung wann und warum kam
  • Referenz für DBAs, die das Schema manuell nachvollziehen wollen
  • Grundlage für Code-Review von Schemaänderungen (PR zeigt sowohl den Go-Diff in initSchema() als auch die dazugehörige NNN_name.sql-Doku)

Regeln

  1. Jede neue Migration bekommt eine fortlaufende Nummer (001, 002, ...).
  2. Der Dateiname beschreibt die Änderung kurz (002_add_reminders.sql).
  3. Der SQL-Inhalt muss exakt dem entsprechen, was initSchema() (oder das jeweilige Store-Paket) zur Laufzeit ausführt.
  4. Migrationen werden nie verändert oder gelöscht, nur ergänzt.

Vorhandene Migrationen

  • 001_initial.sqltenants, users, token_blacklist, documents, audit_log
  • 002_reminders.sqlreminders (Wiedervorlage)
  • 003_documents_unique_hash.sqlUNIQUE INDEX (tenant_id, content_hash) auf documents (DB-seitiger Duplikatschutz für die Upload-Pipeline)
  • 004_sftp_credentials.sqlsftp_credentials (per-Mandant SFTP-Zugangsdaten für den eingebetteten SFTP-Server, internal/sftpserver)
  • 005_taxonomy.sqltags/document_types/correspondents/document_tags (strukturierte Entitäten mit Matching-Algorithmus + Barcode-Wert) plus documents.doc_type_id/correspondent_id/barcode_values-ALTER
  • 006_custom_fields.sqlcustom_field_defs/document_type_fields/document_field_values (benutzerdefinierte Felder pro Mandant/Dokumenttyp/Dokument)
  • 007_trash.sql — Papierkorb + gestaffeltes Löschkonzept: documents.deleted_at/deleted_by-ALTER (Soft-Delete) plus document_delete_requests (Vier-Augen-Workflow für finales WORM-Löschen, Retention-Prüfung, Tombstone)
  • 011_classification_templates.sqlclassification_templates/classification_template_tags/classification_template_field_defaults (Klassifizierungsvorlagen: benannte Bündel aus Dokumenttyp/Tags/Custom-Field-Defaults/Aufbewahrungsdauer, anwendbar per Preview+Commit; keine persistente Kopplung an documents, Retention nur verlängerbar)
  • 021_title_template.sqlclassification_templates.title_template-ALTER + tenants.default_title_template-ALTER (Titel-Vorlage pro Klassifizierungsvorlage mit tenant-weitem Default-Fallback; Go-text/template-Rendering in classification_templates_title.go, angewendet in ApplyTemplate für manuellen Endpoint UND Workflow-Trigger; setzt Titel nur wenn title_manually_set=false und lässt das Flag false)
  • 022_retention_rules.sqlretention_rules (GoBD-Aufbewahrungsregeln / "Disposition Schedules" pro Dokumenttyp bzw. tenant-weiter Default mit doc_type_id IS NULL): trigger_type (document_date/upload_date/fixed_date/event) + retention_years/days berechnen documents.retain_until über den Batch-Job archivdms retention apply (initRetentionRulesSchema/ApplyRetentionRules). Setzt nur retain_until (WORM-Sperre), löscht nie und verkürzt nie; die Vernichtung läuft weiter über 007_trash.sql. event-Regeln werden nicht auto-berechnet (künftiger Erweiterungspunkt)
  • 024_ocr_words.sqlocr_words (word-level OCR bounding boxes per Dokument, Phase 2 des Text-Highlight/Overlay-Features, internal/storage/ocr_words.go/initOCRWordsSchema): document_id FK ON DELETE CASCADE, kein tenant_id (immer über document_id mediiert), ReplaceOCRWords löscht+re-inserted atomar bei jedem (Re-)OCR-Lauf (Upload-Job, /reprocess-Endpoint, documents reprocess-all CLI), damit kein Duplikat-Anhäufen entsteht
  • 025_document_date_score.sqldocuments.document_date_score (NUMERIC, nullable, kein Backfill): persistiert die Konfidenz (0.4-0.9 automatische Keyword-Proximity-Heuristik, 1.0 = manuell bestätigt/überschrieben via PUT /api/documents/{id}/document-date) der bereits vorhandenen document_date-Erkennung, vorbereitend für die geplante Buchhaltungs-Pull-API (Score >= 0.75 als Pull-Filter)
  • 020_ml_classifier.sqlml_classifier_tokens/ml_classifier_classes/ml_classifier_runs (Naive-Bayes-Retraining-Klassifizierung Phase 1, ergänzt die Regel-Engine) plus document_tags.assigned_via/documents.doc_type_assigned_via/documents.correspondent_assigned_via-ALTER (Provenienz: manual/rule/ml_accepted, Default manual zum Schutz bestehender Trainingsdaten)