Files
AzerothCore-RealmMaster/database-import/README.md
uprightbass360 5c9f1d7389 feat: comprehensive module system and database management improvements
This commit introduces major enhancements to the module installation system,
database management, and configuration handling for AzerothCore deployments.

## Module System Improvements

### Module SQL Staging & Installation
- Refactor module SQL staging to properly handle AzerothCore's sql/ directory structure
- Fix SQL staging path to use correct AzerothCore format (sql/custom/db_*/*)
- Implement conditional module database importing based on enabled modules
- Add support for both cpp-modules and lua-scripts module types
- Handle rsync exit code 23 (permission warnings) gracefully during deployment

### Module Manifest & Automation
- Add automated module manifest generation via GitHub Actions workflow
- Implement Python-based module manifest updater with comprehensive validation
- Add module dependency tracking and SQL file discovery
- Support for blocked modules and module metadata management

## Database Management Enhancements

### Database Import System
- Add db-guard container for continuous database health monitoring and verification
- Implement conditional database import that skips when databases are current
- Add backup restoration and SQL staging coordination
- Support for Playerbots database (4th database) in all import operations
- Add comprehensive database health checking and status reporting

### Database Configuration
- Implement 10 new dbimport.conf settings from environment variables:
  - Database.Reconnect.Seconds/Attempts for connection reliability
  - Updates.AllowedModules for module auto-update control
  - Updates.Redundancy for data integrity checks
  - Worker/Synch thread settings for all three core databases
- Auto-apply dbimport.conf settings via auto-post-install.sh
- Add environment variable injection for db-import and db-guard containers

### Backup & Recovery
- Fix backup scheduler to prevent immediate execution on container startup
- Add backup status monitoring script with detailed reporting
- Implement backup import/export utilities
- Add database verification scripts for SQL update tracking

## User Import Directory

- Add new import/ directory for user-provided database files and configurations
- Support for custom SQL files, configuration overrides, and example templates
- Automatic import of user-provided databases and configs during initialization
- Documentation and examples for custom database imports

## Configuration & Environment

- Eliminate CLIENT_DATA_VERSION warning by adding default value syntax
- Improve CLIENT_DATA_VERSION documentation in .env.template
- Add comprehensive database import settings to .env and .env.template
- Update setup.sh to handle new configuration variables with proper defaults

## Monitoring & Debugging

- Add status dashboard with Go-based terminal UI (statusdash.go)
- Implement JSON status output (statusjson.sh) for programmatic access
- Add comprehensive database health check script
- Add repair-storage-permissions.sh utility for permission issues

## Testing & Documentation

- Add Phase 1 integration test suite for module installation verification
- Add comprehensive documentation for:
  - Database management (DATABASE_MANAGEMENT.md)
  - Module SQL analysis (AZEROTHCORE_MODULE_SQL_ANALYSIS.md)
  - Implementation mapping (IMPLEMENTATION_MAP.md)
  - SQL staging comparison and path coverage
  - Module assets and DBC file requirements
- Update SCRIPTS.md, ADVANCED.md, and troubleshooting documentation
- Update references from database-import/ to import/ directory

## Breaking Changes

- Renamed database-import/ directory to import/ for clarity
- Module SQL files now staged to AzerothCore-compatible paths
- db-guard container now required for proper database lifecycle management

## Bug Fixes

- Fix module SQL staging directory structure for AzerothCore compatibility
- Handle rsync exit code 23 gracefully during deployments
- Prevent backup from running immediately on container startup
- Correct SQL staging paths for proper module installation
2025-11-20 18:26:00 -05:00

1.9 KiB

Database Import

📌 Note: This directory is maintained for backward compatibility. New location: import/db/ - See import/README.md for the new unified import system.

Place your database backup files here for automatic import during deployment.

Supported Imports

  • .sql files (uncompressed SQL dumps)
  • .sql.gz files (gzip compressed SQL dumps)
  • Full backup directories (e.g., ExportBackup_YYYYMMDD_HHMMSS/ containing multiple dumps)
  • Full backup archives (.tar, .tar.gz, .tgz, .zip) that contain the files above

How to Use

  1. Copy your backup files here:

    cp my_auth_backup.sql.gz ./database-import/
    cp my_world_backup.sql.gz ./database-import/
    cp my_characters_backup.sql.gz ./database-import/
    # or drop an entire ExportBackup folder / archive
    cp -r ExportBackup_20241029_120000 ./database-import/
    cp ExportBackup_20241029_120000.tar.gz ./database-import/
    
  2. Run deployment:

    ./deploy.sh
    
  3. Files are automatically copied to backup system and imported during deployment

File Naming

  • Any filename works - the system will auto-detect database type by content
  • Recommended naming: auth.sql.gz, world.sql.gz, characters.sql.gz
  • Full backups keep their original directory/archive name so you can track multiple copies

What Happens

  • Individual .sql/.sql.gz files are copied to storage/backups/daily/ with a timestamped name
  • Full backup directories or archives are staged directly under storage/backups/ (e.g., storage/backups/ExportBackup_20241029_120000/)
  • Database import system automatically restores the most recent matching backup
  • Original files remain here for reference (archives are left untouched)

Notes

  • Only processed on first deployment (when databases don't exist)
  • Files/directories are copied once; existing restored databases will skip import
  • Empty folder is ignored - no files, no import