# incatswetrust/databasebackuputility architecture

> Architecture diagram of the GitHub repository incatswetrust/databasebackuputility, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/incatswetrust/databasebackuputility
- Repository: https://github.com/incatswetrust/databasebackuputility

## Overview

Database Backup Utility is a .NET command-line tool for testing connections, listing backups, scheduling runs, and backing up or restoring MySQL, PostgreSQL, MongoDB, and SQLite. The principal workflow starts at the CLI, validates configuration, selects a database connection, then saves backup data and chain metadata; restore resolves a chain before applying it. The README documents cloud storage, compression, and notifications. Sampled Program code confirms CLI setup, connection-factory creation, and chain handling; many service implementations were not excerpted, so their detailed call paths are not asserted.

Main entry points: [`DatabaseBackupUtility/Program.cs`](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Program.cs) (CLI workflow), [`DatabaseBackupUtility/Services/Fabric/DatabaseConnectionFactory.cs`](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/Fabric/DatabaseConnectionFactory.cs) (Connection factory), [`DatabaseBackupUtility/Services/PostgreSqlConnectionService.cs`](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/PostgreSqlConnectionService.cs) (PostgreSQL operations), [`DatabaseBackupUtility/Services/MySqlConnectionService.cs`](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/MySqlConnectionService.cs) (MySQL operations)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["CLI and configuration"]
  node_program["CLI workflow<br/>[Program.cs]"]
  node_parser["Command parser"]
  node_dbconfig["Database config<br/>[DatabaseConfig.cs]"]
  node_dbvalidator["Database validation"]
  node_storagevalidator["Storage validation"]
  node_notificationvalidator["Notification validation"]
end

subgraph group_database["Database operations"]
  node_factory["Connection factory"]
  node_mysql["MySQL operations"]
  node_postgres["PostgreSQL operations"]
  node_mongo["MongoDB operations"]
  node_sqlite["SQLite operations"]
  node_mongo_restore["MongoDB chain restore"]
end

subgraph group_backup["Backup chains"]
  node_chain["Chain resolution"]
  node_manifest["Chain manifest<br/>[BackupManifest.cs]"]
  node_parent["Backup context<br/>[BackupParent.cs]"]
  node_backup_type["Backup types<br/>[BackupType.cs]"]
end

subgraph group_storage["Storage and delivery"]
  node_local_storage["Local storage"]
  node_cloud_storage["Cloud storage"]
  node_azure_storage["Azure Blob storage"]
  node_google_storage["Google Cloud storage"]
end

subgraph group_integrations["Supporting services"]
  node_compression["Gzip compression"]
  node_notification["Notifications"]
  node_null_notification["Null notifications"]
  node_process["External process runner<br/>[ProcessRunner.cs]"]
  node_table_filter["SQL table filtering"]
  node_wal_translator["WAL translation"]
end

node_operator(("Operator"))

node_operator -->|"runs commands"| node_program
node_program -->|"parses options"| node_parser
node_program -->|"validates config"| node_dbvalidator
node_program -->|"validates storage"| node_storagevalidator
node_program -->|"validates notifications"| node_notificationvalidator
node_program -->|"creates connection"| node_factory
node_factory -->|"selects MySQL"| node_mysql
node_factory -->|"selects PostgreSQL"| node_postgres
node_factory -->|"selects MongoDB"| node_mongo
node_factory -->|"selects SQLite"| node_sqlite
node_program -->|"resolves chains"| node_chain
node_program -.->|"stores backup files"| node_local_storage
node_program -.->|"stores backup blobs"| node_cloud_storage
node_program -.->|"stores backup blobs"| node_azure_storage
node_program -.->|"stores backup blobs"| node_google_storage
node_program -->|"compresses backups"| node_compression
node_program -->|"sends completion alerts"| node_notification
node_program -.->|"uses optional fallback"| node_null_notification
node_program -.->|"applies restore chain"| node_mongo_restore
node_chain -->|"reads chain records"| node_manifest
node_program -->|"persists sidecars"| node_manifest
node_mysql -->|"runs database tools"| node_process
node_postgres -->|"runs database tools"| node_process
node_mongo -->|"runs database tools"| node_process
node_mysql -->|"uses table filter"| node_table_filter
node_postgres -->|"uses table filter"| node_table_filter
node_postgres -->|"translates WAL changes"| node_wal_translator
node_mongo -->|"uses chain checkpoint"| node_parent

click node_program "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Program.cs"
click node_parser "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/CommandLineParser.cs"
click node_dbconfig "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Models/DatabaseConfig.cs"
click node_dbvalidator "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Validator/DatabaseConfigValidator.cs"
click node_storagevalidator "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Validator/StorageConfigValidator.cs"
click node_notificationvalidator "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Validator/NotificationConfigValidator.cs"
click node_factory "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/Fabric/DatabaseConnectionFactory.cs"
click node_mysql "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/MySqlConnectionService.cs"
click node_postgres "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/PostgreSqlConnectionService.cs"
click node_mongo "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/MongoDbConnectionService.cs"
click node_sqlite "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/SqliteConnectionService.cs"
click node_mongo_restore "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/MongoDbRestoreService.cs"
click node_chain "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/BackupChainService.cs"
click node_manifest "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Models/BackupManifest.cs"
click node_parent "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Models/BackupParent.cs"
click node_backup_type "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Models/BackupType.cs"
click node_local_storage "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/LocalStorageService.cs"
click node_cloud_storage "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/AwsS3StorageService.cs"
click node_azure_storage "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/AzureBlobStorageService.cs"
click node_google_storage "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/GoogleCloudStorageService.cs"
click node_compression "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/CompressionService.cs"
click node_notification "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/SlackNotificationService.cs"
click node_null_notification "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/NullNotificationService.cs"
click node_process "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/ProcessRunner.cs"
click node_table_filter "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/SqlDumpTableFilter.cs"
click node_wal_translator "https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/Wal2JsonTranslator.cs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_program,node_parser,node_dbconfig,node_dbvalidator,node_storagevalidator,node_notificationvalidator toneBlue
class node_factory,node_mysql,node_postgres,node_mongo,node_sqlite,node_mongo_restore toneAmber
class node_chain,node_manifest,node_parent,node_backup_type toneMint
class node_local_storage,node_cloud_storage,node_azure_storage,node_google_storage toneRose
class node_compression,node_notification,node_null_notification,node_process,node_table_filter,node_wal_translator,node_operator toneIndigo
```

## Components

### CLI and configuration

- [CLI workflow](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Program.cs): `DatabaseBackupUtility/Program.cs`
- [Command parser](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/CommandLineParser.cs): `DatabaseBackupUtility/Services/CommandLineParser.cs`
- [Database config](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Models/DatabaseConfig.cs): `DatabaseBackupUtility/Models/DatabaseConfig.cs`
- [Database validation](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Validator/DatabaseConfigValidator.cs): `DatabaseBackupUtility/Validator/DatabaseConfigValidator.cs`
- [Storage validation](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Validator/StorageConfigValidator.cs): `DatabaseBackupUtility/Validator/StorageConfigValidator.cs`
- [Notification validation](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Validator/NotificationConfigValidator.cs): `DatabaseBackupUtility/Validator/NotificationConfigValidator.cs`

### Database operations

- [Connection factory](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/Fabric/DatabaseConnectionFactory.cs): `DatabaseBackupUtility/Services/Fabric/DatabaseConnectionFactory.cs`
- [MySQL operations](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/MySqlConnectionService.cs): `DatabaseBackupUtility/Services/MySqlConnectionService.cs`
- [PostgreSQL operations](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/PostgreSqlConnectionService.cs): `DatabaseBackupUtility/Services/PostgreSqlConnectionService.cs`
- [MongoDB operations](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/MongoDbConnectionService.cs): `DatabaseBackupUtility/Services/MongoDbConnectionService.cs`
- [SQLite operations](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/SqliteConnectionService.cs): `DatabaseBackupUtility/Services/SqliteConnectionService.cs`
- [MongoDB chain restore](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/MongoDbRestoreService.cs): `DatabaseBackupUtility/Services/MongoDbRestoreService.cs`

### Backup chains

- [Chain resolution](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/BackupChainService.cs): `DatabaseBackupUtility/Services/BackupChainService.cs`
- [Chain manifest](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Models/BackupManifest.cs): `DatabaseBackupUtility/Models/BackupManifest.cs`
- [Backup context](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Models/BackupParent.cs): `DatabaseBackupUtility/Models/BackupParent.cs`
- [Backup types](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Models/BackupType.cs): `DatabaseBackupUtility/Models/BackupType.cs`

### Storage and delivery

- [Local storage](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/LocalStorageService.cs): `DatabaseBackupUtility/Services/LocalStorageService.cs`
- [Cloud storage](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/AwsS3StorageService.cs): `DatabaseBackupUtility/Services/AwsS3StorageService.cs`
- [Azure Blob storage](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/AzureBlobStorageService.cs): `DatabaseBackupUtility/Services/AzureBlobStorageService.cs`
- [Google Cloud storage](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/GoogleCloudStorageService.cs): `DatabaseBackupUtility/Services/GoogleCloudStorageService.cs`

### Supporting services

- [Gzip compression](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/CompressionService.cs): `DatabaseBackupUtility/Services/CompressionService.cs`
- [Notifications](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/SlackNotificationService.cs): `DatabaseBackupUtility/Services/SlackNotificationService.cs`
- [Null notifications](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/NullNotificationService.cs): `DatabaseBackupUtility/Services/NullNotificationService.cs`
- [External process runner](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/ProcessRunner.cs): `DatabaseBackupUtility/Services/ProcessRunner.cs`
- [SQL table filtering](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/SqlDumpTableFilter.cs): `DatabaseBackupUtility/Services/SqlDumpTableFilter.cs`
- [WAL translation](https://github.com/incatswetrust/databasebackuputility/blob/main/DatabaseBackupUtility/Services/Wal2JsonTranslator.cs): `DatabaseBackupUtility/Services/Wal2JsonTranslator.cs`

### Other components

- **Operator**

## Connections

- Operator → CLI workflow: runs commands
- CLI workflow → Command parser: parses options (evidence: `DatabaseBackupUtility/Program.cs`)
- CLI workflow → Database validation: validates config (evidence: `DatabaseBackupUtility/Program.cs`)
- CLI workflow → Storage validation: validates storage (evidence: `DatabaseBackupUtility/Program.cs`)
- CLI workflow → Notification validation: validates notifications (evidence: `DatabaseBackupUtility/Program.cs`)
- CLI workflow → Connection factory: creates connection (evidence: `DatabaseBackupUtility/Program.cs`)
- Connection factory → MySQL operations: selects MySQL (evidence: `DatabaseBackupUtility/Services/Fabric/DatabaseConnectionFactory.cs`)
- Connection factory → PostgreSQL operations: selects PostgreSQL (evidence: `DatabaseBackupUtility/Services/Fabric/DatabaseConnectionFactory.cs`)
- Connection factory → MongoDB operations: selects MongoDB (evidence: `DatabaseBackupUtility/Services/Fabric/DatabaseConnectionFactory.cs`)
- Connection factory → SQLite operations: selects SQLite (evidence: `DatabaseBackupUtility/Services/Fabric/DatabaseConnectionFactory.cs`)
- CLI workflow → Chain resolution: resolves chains (evidence: `DatabaseBackupUtility/Program.cs`)
- CLI workflow → Local storage: stores backup files
- CLI workflow → Cloud storage: stores backup blobs
- CLI workflow → Azure Blob storage: stores backup blobs
- CLI workflow → Google Cloud storage: stores backup blobs
- CLI workflow → Gzip compression: compresses backups (evidence: `DatabaseBackupUtility/Program.cs`)
- CLI workflow → Notifications: sends completion alerts (evidence: `DatabaseBackupUtility/Program.cs`)
- CLI workflow → Null notifications: uses optional fallback (evidence: `DatabaseBackupUtility/Program.cs`)
- CLI workflow → MongoDB chain restore: applies restore chain
- Chain resolution → Chain manifest: reads chain records (evidence: `DatabaseBackupUtility/Services/BackupChainService.cs`)
- CLI workflow → Chain manifest: persists sidecars (evidence: `DatabaseBackupUtility/Program.cs`)
- MySQL operations → External process runner: runs database tools (evidence: `DatabaseBackupUtility/Services/MySqlConnectionService.cs`)
- PostgreSQL operations → External process runner: runs database tools (evidence: `DatabaseBackupUtility/Services/PostgreSqlConnectionService.cs`)
- MongoDB operations → External process runner: runs database tools (evidence: `DatabaseBackupUtility/Services/MongoDbConnectionService.cs`)
- MySQL operations → SQL table filtering: uses table filter (evidence: `DatabaseBackupUtility/Services/MySqlConnectionService.cs`)
- PostgreSQL operations → SQL table filtering: uses table filter (evidence: `DatabaseBackupUtility/Services/PostgreSqlConnectionService.cs`)
- PostgreSQL operations → WAL translation: translates WAL changes (evidence: `DatabaseBackupUtility/Services/PostgreSqlConnectionService.cs`)
- MongoDB operations → Backup context: uses chain checkpoint (evidence: `DatabaseBackupUtility/Services/MongoDbConnectionService.cs`)
