Skip to content

Latest commit

 

History

History
263 lines (199 loc) · 10.4 KB

BACKUP_RESTORE_DOCS_INDEX.md

File metadata and controls

263 lines (199 loc) · 10.4 KB

💾 Backup & Recovery Documentation Index

Welcome to ThemisDB's Backup & Recovery documentation! This index helps you find the right document for your needs, whether you're setting up backups, implementing disaster recovery, or using point-in-time recovery features.

🎯 Choose Your Document

📖 For First-Time Users

Start here to understand the backup and recovery system:

  1. backup_recovery_system.md ⭐ START HERE
    • Complete overview of backup & recovery features
    • Backup types (full, incremental, differential)
    • WAL archiving and PITR basics
    • Code examples and best practices
    • Time: 20-30 minutes

🚀 Core Features

Point-in-Time Recovery (PITR)

  • en/features/features_pitr.md 🇬🇧

    • Complete PITR feature guide
    • Named snapshots and restore operations
    • API reference and usage examples
    • Production-ready since v1.4.0
    • Time: 25-35 minutes

  • de/features/features_pitr.md 🇩🇪

    • PITR Dokumentation (Deutsch)
    • Benannte Snapshots und Wiederherstellung
    • Zeit: 25-35 Minuten

RAID Backup Support

Snapshot Management

🔧 Operational Guides

Disaster Recovery

Production Operations

📚 Related Features

Git-like Version Control

📖 Knowledge Base

🔬 Implementation Details

For developers and maintainers:

📑 Documentation Map

Backup & Recovery Documentation Structure
├── backup_recovery_system.md ..................... Core system overview
├── en/
│   ├── features/
│   │   ├── features_pitr.md ...................... Point-in-Time Recovery guide
│   │   ├── features_snapshots.md ................. Named snapshots
│   │   ├── features_raid5_backup.md .............. RAID backup support
│   │   ├── features_diff.md ...................... Diff API for change tracking
│   │   └── features_branches.md .................. Git-like branching (future)
│   └── guides/
│       └── disaster_recovery.md .................. DR procedures and runbooks
├── de/ (German translations)
│   ├── features/
│   │   ├── features_pitr.md
│   │   ├── features_snapshots.md
│   │   └── features_raid5_backup.md
│   └── guides/
│       └── disaster_recovery.md
├── production/
│   └── DISASTER_RECOVERY.md ...................... Production DR plan
├── operations/
│   └── disaster-recovery/
│       ├── DR_CHECKLISTS.md ...................... Operational checklists
│       └── DR_TESTING.md ......................... Testing procedures
├── knowledge-base/
│   └── BACKUP_RECOVERY.md ........................ KB articles and FAQ
└── implementation-history/ (historical reference)
    ├── BACKUP_RECOVERY_IMPLEMENTATION_SUMMARY.md
    └── PITR_IMPLEMENTATION_COMPLETE.md

🔗 Quick Links by Use Case

I want to...

Set up basic backups

→ Start with backup_recovery_system.md

Configure automatic backups

→ See en/guides/disaster_recovery.md § Backup Automation

Restore to a specific point in time

→ See en/features/features_pitr.md § Restore Operations

Create named snapshots for auditing

→ See en/features/features_snapshots.md

Set up RAID backups

→ See en/features/features_raid5_backup.md

Plan disaster recovery

→ See en/guides/disaster_recovery.md

Test my DR procedures

→ See operations/disaster-recovery/DR_TESTING.md

Compare database states

→ See en/features/features_diff.md

Troubleshoot backup issues

→ See knowledge-base/BACKUP_RECOVERY.md

Understand WAL archiving

→ See backup_recovery_system.md § WAL Archiving

🎓 Learning Paths

For Database Administrators

  1. backup_recovery_system.md - Core concepts
  2. en/guides/disaster_recovery.md - DR planning
  3. operations/disaster-recovery/DR_CHECKLISTS.md - Operational checklists
  4. en/features/features_pitr.md - Advanced recovery

For DevOps Engineers

  1. backup_recovery_system.md - System overview
  2. en/features/features_raid5_backup.md - RAID setup
  3. en/guides/disaster_recovery.md - Automation
  4. operations/disaster-recovery/DR_TESTING.md - Testing

For Compliance Officers

  1. en/features/features_snapshots.md - Audit snapshots
  2. en/features/features_diff.md - Change tracking
  3. en/features/features_pitr.md - Point-in-time recovery
  4. en/guides/disaster_recovery.md - DR compliance

For Developers

  1. implementation-history/BACKUP_RECOVERY_IMPLEMENTATION_SUMMARY.md - Implementation details
  2. backup_recovery_system.md - API usage
  3. en/features/features_pitr.md - PITR API
  4. Include files: include/storage/backup_manager.h, include/storage/pitr_manager.h

📊 Feature Status

Feature Status Version Documentation
Full Backup ✅ Production 1.3.0+ backup_recovery_system.md
Incremental Backup ✅ Production 1.3.0+ backup_recovery_system.md
Differential Backup ✅ Production 1.3.0+ backup_recovery_system.md
WAL Archiving ✅ Production 1.3.0+ backup_recovery_system.md
RAID5/6 Backup ✅ Production 1.3.5+ en/features/features_raid5_backup.md
Named Snapshots ✅ Production 1.4.0+ en/features/features_snapshots.md
PITR ✅ Production 1.4.0+ en/features/features_pitr.md
Diff API ✅ Production 1.4.1+ en/features/features_diff.md
Backup Compression ✅ Production 1.3.0+ backup_recovery_system.md
Backup Verification ✅ Production 1.3.0+ backup_recovery_system.md

🆘 Support

For Documentation Questions

For Backup/Recovery Issues

Documentation Updated: February 9, 2026
Version: 1.5.0-dev
Status: Current & Maintained

See Also: