1
0
mirror of https://github.com/postgrespro/pg_probackup.git synced 2024-11-25 09:01:48 +02:00
Backup and recovery manager for PostgreSQL https://postgrespro.github.io/pg_probackup/
Go to file
Michael Paquier d274d27cfc Remove PHONY option in documentation Makefile
This was kicking all the time a clean up of everything, rather unwelcome.
2014-01-12 03:08:57 +09:00
data/sample_backup Refactor write/read calculation size of backups 2014-01-10 04:11:27 +09:00
doc Remove PHONY option in documentation Makefile 2014-01-12 03:08:57 +09:00
expected Fix old backup removal for specified number of days 2014-01-10 08:42:54 +09:00
pgut Remove outdated functions in pgut 2013-12-13 01:02:43 +09:00
sql Fix regression tests 2013-12-10 18:11:32 +09:00
.gitignore Add .gitignore for project 2013-12-10 02:32:17 +09:00
backup.c Fix old backup removal for specified number of days 2014-01-10 08:42:54 +09:00
catalog.c Refactor write/read calculation size of backups 2014-01-10 04:11:27 +09:00
COPYRIGHT revised for pg_rman1.2.2 2011-11-28 04:22:05 +00:00
data.c Remove outdated versions of PageHeaderData 2013-12-13 01:07:43 +09:00
delete.c Fix old backup removal for specified number of days 2014-01-10 08:42:54 +09:00
dir.c Fix create_dir not working properly for OSX 2013-12-15 21:32:02 +09:00
fetch.c Obtain timeline ID with control file and not XLOG system function 2013-12-13 03:55:39 +09:00
init.c Convert newline characters from CRLF to LF. 2013-01-24 06:35:48 +00:00
Makefile Use asciidoc and xmlto to automatic generation of man and html docs 2014-01-12 03:03:30 +09:00
parray.c Correct typo in comment 2013-12-16 01:10:29 +09:00
parray.h Convert newline characters from CRLF to LF. 2013-01-24 06:35:48 +00:00
pg_rman.c Remove undocumented option "force" for delete command 2014-01-10 02:57:15 +09:00
pg_rman.h Refactor write/read calculation size of backups 2014-01-10 04:11:27 +09:00
README Use asciidoc and xmlto to automatic generation of man and html docs 2014-01-12 03:03:30 +09:00
restore.c Improve comment explaining how search_next_wal works with LSN 2013-12-25 08:26:25 +09:00
show.c Refactor write/read calculation size of backups 2014-01-10 04:11:27 +09:00
status.c Fix server status not correctly fetched 2013-12-13 00:29:25 +09:00
util.c Convert newline characters from CRLF to LF. 2013-01-24 06:35:48 +00:00
validate.c Simplify code related to HAVE_DATABASE, HAVE_ARCLOG, TOTAL_READ_SIZE 2013-12-16 00:30:49 +09:00
xlog.c Fix WAL segment file generation 2013-12-25 08:17:01 +09:00

pg_rman
=======

pg_rman is a backup and recovery manager for PostgreSQL servers able to do
incremental, archive 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 incremental and archive backup
facilities 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_rman.

Installation
------------

Compiling pg_rman requires a PostgreSQL installation and can be done in
two ways:

1. Put pg_rman project directory inside PostgreSQL source tree as
contrib/pg_rman, and use this command for compilation:

	$ cd $POSTGRES_SOURCE/contrib/pg_rman
	$ 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_rman is compatible with PostgreSQL 9.3 and
upper versions.

Platforms
---------

pg_rman 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.

Regression tests
----------------

The test suite of pg_rman 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_rman can be distributed under the PostgreSQL license. See COPYRIGHT
file for more information.