https://github.com/richbl/postgresql-db-dump

shell script to perform a remote postgreSQL database dump
https://github.com/richbl/postgresql-db-dump

bash bash-script database dump postgres postgresql postgresql-database shell shell-script

Last synced: about 1 month ago
JSON representation

shell script to perform a remote postgreSQL database dump

• Host: GitHub
• URL: https://github.com/richbl/postgresql-db-dump
• Owner: richbl
• License: gpl-3.0
• Created: 2015-08-20T15:31:49.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-02-28T02:47:24.000Z (almost 2 years ago)
• Last Synced: 2023-08-24T15:27:31.021Z (over 1 year ago)
• Topics: bash, bash-script, database, dump, postgres, postgresql, postgresql-database, shell, shell-script
• Language: Shell
• Size: 38.1 KB
• Stars: 7
• Watchers: 2
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Postgresql-Db-Dump

**Postgresql-Db-Dump** (`postgres_dump_db.sh`) permits for the remote dump of a PostgreSQL database. It takes a number of command-line parameters, and if run successfully, returns a date-and-time-stamped compressed file (useful for a running backup archive).

This script expects that the host is properly configured to accept remote logins, and that the Postgres user (technically called a *role* in Postgres) is apppropriately associated with the database in question.

## Run_postgres_dump_db.sh

The associated script, `run_postgres_dump.sh`, is really just a front-end script that calls into `postgres_dump_db.sh` with a predefined set of parameters passed in. Useful for automating the dump process (*e.g.*, executing via a cronjob).

## [Developed with a Bash Template (BaT)](https://github.com/richbl/a-bash-template)[](https://github.com/richbl/a-bash-template)

**Postgresql-Db-Dump** uses a bash template (BaT) called **[A-Bash-Template](https://github.com/richbl/a-bash-template)** designed to make script development and command line argument management more robust, easier to implement, and easier to maintain. Here are a few of those features:

- Dependencies checker: a routine that checks all external program dependencies (*e.g.*, [sshpass](http://linux.die.net/man/1/sshpass) and [jq](https://stedolan.github.io/jq/))

- Arguments and script details--such as script description and syntax--are stored in the [JSON](http://www.json.org/) file format (*i.e.*, `config.json`)

- JSON queries (using [jq](https://stedolan.github.io/jq/)) handled through wrapper functions

- A script banner function automates banner generation, reading directly from `config.json`

- Command line arguments are parsed and tested for completeness using both short and long-format argument syntax (*e.g.*, `-u|--username`)

- Optional command line arguments are permissible and managed through the JSON configuration file

- Template functions organized into libraries to minimize code footprint in the main script

For more details about using a bash template, [check out the BaT sources here](https://github.com/richbl/a-bash-template).

## Basic Usage

**Postgresql-Db-Dump** is run through an interactive command line interface, so all of the command options are made available there.

Here's the default response when running `postgres_dump_db.sh` with no arguments:

	 |

	 | A bash script to dump a remote PostgreSQL database

	 |   0.2.0

	 |

	 | Usage:

	 |   postgres_db_dump -h host -u username -p password -d database -o output_dir

	 |

	 |   -h, --host 	website URL or IP address

	 |   -u, --username 	user name

	 |   -p, --password 	password

	 |   -d, --database 	PostgreSQL database name

	 |   -o, --output_dir 	absolute directory path to save dumped file

	 |

	Error: host argument (-h|--host) missing.

	Error: username argument (-u|--username) missing.

	Error: database argument (-d|--database) missing.

	Error: output_dir argument (-o|--output_dir) missing.

In this example, the program responds by indicating that the required script arguments must be set before proper operation.

When arguments are correctly passed, the script provides feedback on the success or failure of the remote folder copy:

	$ ./postgres_db_dump.sh -h example.com -u remote_user -p 'pass123' -d dbname -o /home/user

	 |

	 | A bash script to dump a remote PostgreSQL database

	 |   0.2.0

	 |

	 | Usage:

	 |   postgres_db_dump -h host -u username -p password -d database -o output_dir

	 |

	 |   -h, --host 	website URL or IP address

	 |   -u, --username 	user name

	 |   -p, --password 	password

	 |   -d, --database 	PostgreSQL database name

	 |   -o, --output_dir 	absolute directory path to save dumped file

	 |

	Starting database dump now... this could take some time depending on database size.

	Success: PostgreSQL dump completed. Results file (dbname-database-20160414082441.gz) created in /home/user.

## IMPORTANT: This Project Uses Git Submodules 

This project uses [Git submodule project(s)](https://git-scm.com/book/en/v2/Git-Tools-Submodules) (located in the `bash-lib` folder) to keep this project up-to-date without manual intervention.

**Be sure to clone this project with the `--recursive` switch** (`git clone --recursive https://github.com/richbl/this_project`) so any submodule project(s) will be automatically cloned as well. If you clone into this project without this switch, you'll likely see empty submodule project folders (depending on your version of Git).