Commit 64fa797

mo khan <mo@mokhan.ca>
2015-12-24 00:25:08
remove comments.
1 parent 311340b
templates/pg_backup.config.erb
@@ -1,41 +1,10 @@
-##############################
-## POSTGRESQL BACKUP CONFIG ##
-##############################
-
-# Optional system user to run backups as.  If the user the script is running as doesn't match this
-# the script terminates.  Leave blank to skip check.
 BACKUP_USER=
-
-# Optional hostname to adhere to pg_hba policies.  Will default to "localhost" if none specified.
-HOSTNAME=
-
-# Optional username to connect to database as.  Will default to "postgres" if none specified.
-USERNAME=
-
-# This dir will be created if it doesn't exist.  This must be writable by the user the script is
-# running as.
+HOSTNAME="localhost"
+USERNAME="postgres"
 BACKUP_DIR=<%= @backup_dir %>
-
-# List of strings to match against in database name, separated by space or comma, for which we only
-# wish to keep a backup of the schema, not the data. Any database names which contain any of these
-# values will be considered candidates. (e.g. "system_log" will match "dev_system_log_2010-01")
 SCHEMA_ONLY_LIST=""
-
-# Will produce a custom-format backup if set to "yes"
 ENABLE_CUSTOM_BACKUPS=yes
-
-# Will produce a gzipped plain-format backup if set to "yes"
 ENABLE_PLAIN_BACKUPS=yes
-
-#### SETTINGS FOR ROTATED BACKUPS ####
-
-# Which day to take the weekly backup from (1-7 = Monday-Sunday)
 DAY_OF_WEEK_TO_KEEP=5
-
-# Number of days to keep daily backups
 DAYS_TO_KEEP=7
-
-# How many weeks to keep weekly backups
 WEEKS_TO_KEEP=5
-
-######################################
templates/pg_backup_rotated.sh.erb
@@ -1,60 +1,43 @@
 #!/bin/bash
 
-###########################
-####### LOAD CONFIG #######
-###########################
-
 while [ $# -gt 0 ]; do
-        case $1 in
-                -c)
-                        CONFIG_FILE_PATH="$2"
-                        shift 2
-                        ;;
-                *)
-                        ${ECHO} "Unknown Option \"$1\"" 1>&2
-                        exit 2
-                        ;;
-        esac
+	case $1 in
+		-c)
+			CONFIG_FILE_PATH="$2"
+			shift 2
+			;;
+		*)
+			${ECHO} "Unknown Option \"$1\"" 1>&2
+			exit 2
+			;;
+	esac
 done
 
 if [ -z $CONFIG_FILE_PATH ] ; then
-        SCRIPTPATH=$(cd ${0%/*} && pwd -P)
-        CONFIG_FILE_PATH="${SCRIPTPATH}/pg_backup.config"
+	SCRIPTPATH=$(cd ${0%/*} && pwd -P)
+	CONFIG_FILE_PATH="${SCRIPTPATH}/pg_backup.config"
 fi
 
 if [ ! -r ${CONFIG_FILE_PATH} ] ; then
-        echo "Could not load config file from ${CONFIG_FILE_PATH}" 1>&2
-        exit 1
+	echo "Could not load config file from ${CONFIG_FILE_PATH}" 1>&2
+	exit 1
 fi
 
 source "${CONFIG_FILE_PATH}"
 
-###########################
-#### PRE-BACKUP CHECKS ####
-###########################
-
-# Make sure we're running as the required backup user
 if [ "$BACKUP_USER" != "" -a "$(id -un)" != "$BACKUP_USER" ] ; then
 	echo "This script must be run as $BACKUP_USER. Exiting." 1>&2
 	exit 1
 fi
 
-###########################
-### INITIALISE DEFAULTS ###
-###########################
-
 if [ ! $HOSTNAME ]; then
 	HOSTNAME="localhost"
 fi;
- 
+
 if [ ! $USERNAME ]; then
 	USERNAME="postgres"
 fi;
 
-###########################
-#### START THE BACKUPS ####
-###########################
-
 function perform_backups()
 {
 	SUFFIX=$1
@@ -67,41 +50,28 @@ function perform_backups()
 		exit 1;
 	fi;
 
-
-	###########################
-	### SCHEMA-ONLY BACKUPS ###
-	###########################
-
 	for SCHEMA_ONLY_DB in ${SCHEMA_ONLY_LIST//,/ }
 	do
-	        SCHEMA_ONLY_CLAUSE="$SCHEMA_ONLY_CLAUSE or datname ~ '$SCHEMA_ONLY_DB'"
+		SCHEMA_ONLY_CLAUSE="$SCHEMA_ONLY_CLAUSE or datname ~ '$SCHEMA_ONLY_DB'"
 	done
 
 	SCHEMA_ONLY_QUERY="select datname from pg_database where false $SCHEMA_ONLY_CLAUSE order by datname;"
-
 	echo -e "\n\nPerforming schema-only backups"
 	echo -e "--------------------------------------------\n"
-
 	SCHEMA_ONLY_DB_LIST=`psql -h "$HOSTNAME" -U "$USERNAME" -At -c "$SCHEMA_ONLY_QUERY" postgres`
-
 	echo -e "The following databases were matched for schema-only backup:\n${SCHEMA_ONLY_DB_LIST}\n"
 
 	for DATABASE in $SCHEMA_ONLY_DB_LIST
 	do
-	        echo "Schema-only backup of $DATABASE"
+		echo "Schema-only backup of $DATABASE"
 
-	        if ! pg_dump -Fp -s -h "$HOSTNAME" -U "$USERNAME" "$DATABASE" | gzip > $FINAL_BACKUP_DIR"$DATABASE"_SCHEMA.sql.gz.in_progress; then
-	                echo "[!!ERROR!!] Failed to backup database schema of $DATABASE" 1>&2
-	        else
-	                mv $FINAL_BACKUP_DIR"$DATABASE"_SCHEMA.sql.gz.in_progress $FINAL_BACKUP_DIR"$DATABASE"_SCHEMA.sql.gz
-	        fi
+		if ! pg_dump -Fp -s -h "$HOSTNAME" -U "$USERNAME" "$DATABASE" | gzip > $FINAL_BACKUP_DIR"$DATABASE"_SCHEMA.sql.gz.in_progress; then
+			echo "[!!ERROR!!] Failed to backup database schema of $DATABASE" 1>&2
+		else
+			mv $FINAL_BACKUP_DIR"$DATABASE"_SCHEMA.sql.gz.in_progress $FINAL_BACKUP_DIR"$DATABASE"_SCHEMA.sql.gz
+		fi
 	done
 
-
-	###########################
-	###### FULL BACKUPS #######
-	###########################
-
 	for SCHEMA_ONLY_DB in ${SCHEMA_ONLY_LIST//,/ }
 	do
 		EXCLUDE_SCHEMA_ONLY_CLAUSE="$EXCLUDE_SCHEMA_ONLY_CLAUSE and datname !~ '$SCHEMA_ONLY_DB'"
@@ -135,44 +105,29 @@ function perform_backups()
 				mv $FINAL_BACKUP_DIR"$DATABASE".custom.in_progress $FINAL_BACKUP_DIR"$DATABASE".custom
 			fi
 		fi
-
 	done
-
 	echo -e "\nAll database backups complete!"
 }
 
-# MONTHLY BACKUPS
-
 DAY_OF_MONTH=`date +%d`
 
 if [ $DAY_OF_MONTH -eq 1 ];
 then
 	# Delete all expired monthly directories
 	find $BACKUP_DIR -maxdepth 1 -name "*-monthly" -exec rm -rf '{}' ';'
-
 	perform_backups "-monthly"
-
 	exit 0;
 fi
 
-# WEEKLY BACKUPS
-
 DAY_OF_WEEK=`date +%u` #1-7 (Monday-Sunday)
 EXPIRED_DAYS=`expr $((($WEEKS_TO_KEEP * 7) + 1))`
 
 if [ $DAY_OF_WEEK = $DAY_OF_WEEK_TO_KEEP ];
 then
-	# Delete all expired weekly directories
 	find $BACKUP_DIR -maxdepth 1 -mtime +$EXPIRED_DAYS -name "*-weekly" -exec rm -rf '{}' ';'
-
 	perform_backups "-weekly"
-
 	exit 0;
 fi
 
-# DAILY BACKUPS
-
-# Delete daily backups 7 days old or more
 find $BACKUP_DIR -maxdepth 1 -mtime +$DAYS_TO_KEEP -name "*-daily" -exec rm -rf '{}' ';'
-
 perform_backups "-daily"