Hopiu/postgres-upgrade
1
0
Fork 0
mirror of https://github.com/Hopiu/postgres-upgrade.git synced 2026-03-16 14:10:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
1 commit 1 branch 0 tags 31 KiB
Shell 100%
Find a file
Benedikt Willi ce31ae1a43 Add initial script and documentation for PostgreSQL Docker upgrade 
- Introduced `simple_postgres_upgrade.sh`, a script to streamline the PostgreSQL upgrade process within Docker containers, featuring backup, restore, and upgrade capabilities.
- Includes a detailed `README.md` with usage instructions, options, and examples.
- Provides a `CHANGELOG.md` to track changes and features of the script.
- Licensed under MIT as outlined in `LICENSE` file.
- Initial version set to `0.0.1`.
2024-10-25 14:25:23 +02:00
CHANGELOG.md Add initial script and documentation for PostgreSQL Docker upgrade 2024-10-25 14:25:23 +02:00
LICENSE Add initial script and documentation for PostgreSQL Docker upgrade 2024-10-25 14:25:23 +02:00
README.md Add initial script and documentation for PostgreSQL Docker upgrade 2024-10-25 14:25:23 +02:00
simple_postgres_update.sh Add initial script and documentation for PostgreSQL Docker upgrade 2024-10-25 14:25:23 +02:00

README.md

simple_postgres_upgrade Script

This script facilitates upgrading a PostgreSQL instance running in a Docker container, supporting operations like backups, restores, and version upgrades.

Key Features

  • Backup Creation: Safely back up your current PostgreSQL database.
  • Data Restoration: Restore databases from backups.
  • Version Upgrades: Seamlessly upgrade PostgreSQL to a specified version using Docker.
  • Log and Error Tracking: All operations and errors are logged in detail.
  • Progress Feedback: Progress spinners indicate ongoing operations.
  • Color-Coded Logs: Info, warnings, and errors are easily distinguishable with colors.

Prerequisites

  • Docker and Docker Compose must be installed.
  • Your PostgreSQL container should be managed using Docker Compose.
  • Ensure you have permissions to run Docker commands and access local files.

Updated Usage

./simple_postgres_upgrade.sh [OPTIONS] <from-version> <to-version>

Options

  • -n, --name NAME: Specify the container name (mandatory).
  • -d, --data-dir DIR: Specify the data directory (default: /var/lib/postgresql/data).
  • --backup-only: Create a backup of the specified PostgreSQL version without upgrading.
  • --restore-only: Restore from an existing backup without upgrading.
  • --dry-run: Simulate the PostgreSQL upgrade without actual changes.
  • --version: Display the script version.
  • --help: Display the help message.

Updated Example Commands

  • Upgrade from PostgreSQL version 13 to 14:

    ./simple_postgres_upgrade.sh -n postgres-db 13 14

  • Create a backup of PostgreSQL version 13:

    ./simple_postgres_upgrade.sh -n postgres-db --backup-only 13

  • Restore from an existing backup of version 13:

    ./simple_postgres_upgrade.sh -n postgres-db --restore-only 13

  • Simulate an upgrade from version 13 to 14:

    ./simple_postgres_upgrade.sh -n postgres-db --dry-run 13 14

File Locations

  • Backups: Stored in ./postgres-upgrade/backups
  • Logs: Located at ./postgres-upgrade/upgrade.log

Logging and Error Handling

Logs include timestamps and are categorized by level (INFO, WARNING, ERROR, PROGRESS). The script halts on errors due to command failures, undefined variables, or pipe errors, and a trap function reports the error line number.

Notes

  • Ensure sufficient disk space for backups.
  • The script assumes Docker Compose manages your PostgreSQL container.
  • A docker-compose.yml file must be in the script's directory to configure containers.

License

This script is licensed under the MIT License. Refer to the LICENSE file for details.