mirror of
https://github.com/postgrespro/pg_probackup.git
synced 2024-11-24 08:52:38 +02:00
Backup and recovery manager for PostgreSQL
https://postgrespro.github.io/pg_probackup/
| doc | ||
| expected | ||
| pgut | ||
| sql | ||
| .gitignore | ||
| backup.c | ||
| catalog.c | ||
| COPYRIGHT | ||
| data.c | ||
| delete.c | ||
| dir.c | ||
| fetch.c | ||
| init.c | ||
| Makefile | ||
| parray.c | ||
| parray.h | ||
| pg_arman.c | ||
| pg_arman.h | ||
| README | ||
| restore.c | ||
| show.c | ||
| status.c | ||
| util.c | ||
| validate.c | ||
| xlog.c | ||
pg_arman ======== pg_arman is a backup and recovery manager for PostgreSQL servers able to do differential and full backup as well as restore a cluster to a state defined by a given recovery target. It is designed to perform periodic backups of an existing PostgreSQL server, combined with WAL archives to provide a way to recover a server in case of failure of server because of a reason or another. Its differential backup facility reduces the amount of data necessary to be taken between two consecutive backups. Download -------- The latest version of this software can be found on the project website at https://github.com/michaelpq/pg_arman. Installation ------------ Compiling pg_arman requires a PostgreSQL installation and can be done in two ways: 1. Put pg_arman project directory inside PostgreSQL source tree as contrib/pg_arman, and use this command for compilation: $ cd $POSTGRES_SOURCE/contrib/pg_arman $ make 2. Keep the project directory as-is and use the PGXS development infrastructure provided by a PostgreSQL installation to perform the compilation: $ make USE_PGXS=1 In addition, you must have pg_config in $PATH. The current version of pg_arman is compatible with PostgreSQL 9.3 and upper versions. Platforms --------- pg_arman has been tested on Linux and Unix-based platforms. Documentation ------------- All the documentation is maintained in doc/ as text file, that is then fetched by asciidoc to generate automatically man pages and html documentation. In order to generate the documentation, the variables XMLTO and ASCIIDOC need to be set to proper values indicating where are located the binaries of respectively xmlto and asciidoc. An example of build is as follows: $ make USE_PGXS=1 ASCIIDOC=asciidoc XMLTO=xmlto They could as well be set as environment variables for development purposes. On OSX, it is necessary to set XML_CATALOG_FILES to point to the correct xml catalogs. In the case of an environment with Homebrew after having install xmlto and asciidoc: $ export XML_CATALOG_FILES="/usr/local/etc/xml/catalog" Regression tests ---------------- The test suite of pg_arman is available in the code tree and can be launched in a way similar to common PostgreSQL extensions and modules: 1) "make check" or "make installcheck" if the project directory is located in PostgreSQL code tree. 2) "make installcheck" on an already installed server if project directory is kept as-is. License ------- pg_arman can be distributed under the PostgreSQL license. See COPYRIGHT file for more information. pg_arman is a fork of the existing project pg_arman, initially created and maintained by NTT and Itagaki Takahiro.