Skip to content

Commit 188bbdd

Browse files
committed
Rename project to pg_probackup.
1 parent 054226d commit 188bbdd

29 files changed

+231
-1231
lines changed

Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
PROGRAM = pg_arman
1+
PROGRAM = pg_probackup
22
OBJS = backup.o \
33
catalog.o \
44
data.o \
@@ -7,7 +7,7 @@ OBJS = backup.o \
77
fetch.o \
88
init.o \
99
parray.o \
10-
pg_arman.o \
10+
pg_probackup.o \
1111
restore.o \
1212
show.o \
1313
status.o \
@@ -25,7 +25,7 @@ EXTRA_CLEAN = datapagemap.c datapagemap.h xlogreader.c receivelog.c receivelog.h
2525

2626
REGRESS = init option show delete backup restore
2727

28-
all: checksrcdir datapagemap.h logging.h receivelog.h streamutil.h pg_arman
28+
all: checksrcdir datapagemap.h logging.h receivelog.h streamutil.h pg_probackup
2929

3030
MAKE_GLOBAL="../../src/Makefile.global"
3131
TEST_GLOBAL:=$(shell test -e ../../src/Makefile.global)
@@ -45,7 +45,7 @@ endif
4545
else
4646
#TODO: fix me
4747
REGRESS =
48-
subdir=contrib/pg_arman
48+
subdir=contrib/pg_probackup
4949
top_builddir=../..
5050
include $(top_builddir)/src/Makefile.global
5151
include $(top_srcdir)/contrib/contrib-global.mk

README.md

Lines changed: 24 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
pg_arman fork from Postgres Professional
1+
pg_probackup fork of pg_arman by Postgres Professional
22
========================================
33

4-
This repository contains fork of pg_arman by Postgres Professional with
5-
block level incremental backup support.
6-
7-
pg_arman is a backup and recovery manager for PostgreSQL servers able to do
4+
pg_probackup is a backup and recovery manager for PostgreSQL servers able to do
85
differential and full backup as well as restore a cluster to a
96
state defined by a given recovery target. It is designed to perform
107
periodic backups of an existing PostgreSQL server, combined with WAL
@@ -28,37 +25,37 @@ Download
2825
--------
2926

3027
The latest version of this software can be found on the project website at
31-
https://github.com/postgrespro/pg_arman. Original fork of pg_arman can be
28+
https://github.com/postgrespro/pg_probackup. Original fork of pg_probackup can be
3229
found at https://github.com/michaelpq/pg_arman.
3330

3431
Installation
3532
------------
3633

37-
Compiling pg_arman requires a PostgreSQL installation to be in place
34+
Compiling pg_probackup requires a PostgreSQL installation to be in place
3835
as well as a raw source tree. Pass the path to the PostgreSQL source tree
3936
to make, in the top_srcdir variable:
4037

4138
make USE_PGXS=1 top_srcdir=<path to PostgreSQL source tree>
4239

4340
In addition, you must have pg_config in $PATH.
4441

45-
The current version of pg_arman is compatible with PostgreSQL 9.5 and
42+
The current version of pg_probackup is compatible with PostgreSQL 9.5 and
4643
upper versions.
4744

4845
Platforms
4946
---------
5047

51-
pg_arman has been tested on Linux and Unix-based platforms.
48+
pg_probackup has been tested on Linux and Unix-based platforms.
5249

5350
Documentation
5451
-------------
5552

56-
All the documentation you can find [here](doc/pg_arman.md).
53+
All the documentation you can find [here](doc/pg_probackup.md).
5754

5855
Regression tests
5956
----------------
6057

61-
The test suite of pg_arman is available in the code tree and can be
58+
The test suite of pg_probackup is available in the code tree and can be
6259
launched in a way similar to common PostgreSQL extensions and modules:
6360

6461
make installcheck
@@ -85,7 +82,7 @@ of these approach is requirement to have WAL archive.
8582
some overhead to PostgreSQL performance. On our experiments it appears to be
8683
less than 3%.
8784

88-
These two approaches were implemented in this fork of pg_arman. The second
85+
These two approaches were implemented in this fork of pg_probackup. The second
8986
approach requires [patch for PostgreSQL 9.5](https://gist.github.com/stalkerg/44703dbcbac1da08f448b7e6966646c0) or
9087
[patch for PostgreSQL 10](https://gist.github.com/stalkerg/ab833d94e2f64df241f1835651e06e4b).
9188

@@ -101,29 +98,29 @@ You need to enable WAL archive by adding following lines to postgresql.conf:
10198

10299
```
103100
wal_level = archive
104-
archive_command = 'test ! -f /home/postgres/backup/arman/wal/%f && cp %p /home/postgres/backup/arman/wal/%f'
101+
archive_command = 'test ! -f /home/postgres/backup/wal/%f && cp %p /home/postgres/backup/wal/%f'
105102
```
106103

107104
Example backup (assuming PostgreSQL is running):
108105
```bash
109106
# Init pg_aramn backup folder
110-
pg_arman init -B /home/postgres/backup/pgarman
107+
pg_probackup init -B /home/postgres/backup
111108
# Make full backup with 2 thread and verbose mode.
112-
pg_arman backup -B /home/postgres/backup/pgarman -D /home/postgres/pgdata/arman -b full -v -j 2
109+
pg_probackup backup -B /home/postgres/backup -D /home/postgres/pgdata -b full -v -j 2
113110
# Show backups information
114-
pg_arman show -B /home/postgres/backup/pgarman
111+
pg_probackup show -B /home/postgres/backup
115112

116113
# Now you can insert or update some data in your database
117114

118115
# Then start the incremental backup.
119-
pg_arman backup -B /home/postgres/backup/pgarman -D /home/postgres/pgdata/arman -b page -v -j 2
116+
pg_probackup backup -B /home/postgres/backup -D /home/postgres/pgdata -b page -v -j 2
120117
# You should see that increment is really small
121-
pg_arman show -B /home/postgres/backup/pgarman
118+
pg_probackup show -B /home/postgres/backup
122119
```
123120

124121
For restore after remove your pgdata you can use:
125122
```
126-
pg_arman restore -B /home/postgres/backup/pgarman -D /home/postgres/pgdata/arman -j 4 --verbose
123+
pg_probackup restore -B /home/postgres/backup -D /home/postgres/pgdata -j 4 --verbose
127124
```
128125

129126
### Retrieving changed blocks from ptrack
@@ -134,33 +131,33 @@ The advantage of this approach is that you don't have to save WAL archive. You
134131
ptrack_enable = on
135132
```
136133

137-
Also, some WALs still need to be fetched in order to get consistent backup. pg_arman can fetch them trough the streaming replication protocol. Thus, you also need to [enable streaming replication connection](https://wiki.postgresql.org/wiki/Streaming_Replication).
134+
Also, some WALs still need to be fetched in order to get consistent backup. pg_probackup can fetch them trough the streaming replication protocol. Thus, you also need to [enable streaming replication connection](https://wiki.postgresql.org/wiki/Streaming_Replication).
138135

139136
Example backup (assuming PostgreSQL is running):
140137
```bash
141138
# Init pg_aramn backup folder
142-
pg_arman init -B /home/postgres/backup/pgarman
139+
pg_probackup init -B /home/postgres/backup
143140
# Make full backup with 2 thread and verbose mode.
144-
pg_arman backup -B /home/postgres/backup/pgarman -D /home/postgres/pgdata/arman -b full -v -j 2 --stream
141+
pg_probackup backup -B /home/postgres/backup -D /home/postgres/pgdata -b full -v -j 2 --stream
145142
# Show backups information
146-
pg_arman show -B /home/postgres/backup/pgarman
143+
pg_probackup show -B /home/postgres/backup
147144

148145
# Now you can insert or update some data in your database
149146

150147
# Then start the incremental backup.
151-
pg_arman backup -B /home/postgres/backup/pgarman -D /home/postgres/pgdata/arman -b ptrack -v -j 2 --stream
148+
pg_probackup backup -B /home/postgres/backup -D /home/postgres/pgdata -b ptrack -v -j 2 --stream
152149
# You should see that increment is really small
153-
pg_arman show -B /home/postgres/backup/pgarman
150+
pg_probackup show -B /home/postgres/backup
154151
```
155152

156153
For restore after remove your pgdata you can use:
157154
```
158-
pg_arman restore -B /home/postgres/backup/pgarman -D /home/postgres/pgdata/arman -j 4 --verbose --stream
155+
pg_probackup restore -B /home/postgres/backup -D /home/postgres/pgdata -j 4 --verbose --stream
159156
```
160157

161158
License
162159
-------
163160

164-
pg_arman can be distributed under the PostgreSQL license. See COPYRIGHT
161+
pg_probackup can be distributed under the PostgreSQL license. See COPYRIGHT
165162
file for more information. pg_arman is a fork of the existing project
166163
pg_rman, initially created and maintained by NTT and Itagaki Takahiro.

backup.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
*-------------------------------------------------------------------------
88
*/
99

10-
#include "pg_arman.h"
10+
#include "pg_probackup.h"
1111

1212
#include <stdio.h>
1313
#include <stdlib.h>
@@ -35,7 +35,7 @@ static int server_version = 0;
3535
static bool in_backup = false; /* TODO: more robust logic */
3636
static int standby_message_timeout = 10 * 1000; /* 10 sec = default */
3737
static XLogRecPtr stop_backup_lsn = InvalidXLogRecPtr;
38-
const char *progname = "pg_arman";
38+
const char *progname = "pg_probackup";
3939

4040
/* list of files contained in backup */
4141
parray *backup_files_list;
@@ -161,7 +161,7 @@ do_backup_database(parray *backup_list, pgBackupOption bkupopt)
161161

162162
/* notify start of backup to PostgreSQL server */
163163
time2iso(label, lengthof(label), current.start_time);
164-
strncat(label, " with pg_arman", lengthof(label));
164+
strncat(label, " with pg_probackup", lengthof(label));
165165
pg_start_backup(label, smooth_checkpoint, &current);
166166

167167
/* start stream replication */
@@ -476,7 +476,7 @@ do_backup(pgBackupOption bkupopt)
476476
elog(ERROR, "cannot lock backup catalog");
477477
else if (ret == 1)
478478
elog(ERROR,
479-
"another pg_arman is running, skipping this backup");
479+
"another pg_probackup is running, skipping this backup");
480480

481481
/* initialize backup result */
482482
current.status = BACKUP_STATUS_RUNNING;

catalog.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
*-------------------------------------------------------------------------
88
*/
99

10-
#include "pg_arman.h"
10+
#include "pg_probackup.h"
1111

1212
#include <dirent.h>
1313
#include <fcntl.h>
@@ -28,7 +28,7 @@ static pgBackup *catalog_read_ini(const char *path);
2828
static int lock_fd = -1;
2929

3030
/*
31-
* Lock of the catalog with pg_arman.ini file and return 0.
31+
* Lock of the catalog with pg_probackup.conf file and return 0.
3232
* If the lock is held by another one, return 1 immediately.
3333
*/
3434
int

data.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
*-------------------------------------------------------------------------
88
*/
99

10-
#include "pg_arman.h"
10+
#include "pg_probackup.h"
1111

1212
#include <unistd.h>
1313
#include <time.h>

delete.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
*-------------------------------------------------------------------------
88
*/
99

10-
#include "pg_arman.h"
10+
#include "pg_probackup.h"
1111

1212
#include <dirent.h>
1313
#include <unistd.h>
@@ -34,7 +34,7 @@ do_delete(time_t backup_id)
3434
elog(ERROR, "can't lock backup catalog.");
3535
else if (ret == 1)
3636
elog(ERROR,
37-
"another pg_arman is running, stop delete.");
37+
"another pg_probackup is running, stop delete.");
3838

3939
/* Get complete list of backups */
4040
backup_list = catalog_get_backup_list(0);
@@ -109,7 +109,7 @@ int do_deletewal(time_t backup_id, bool strict)
109109
elog(ERROR, "can't lock backup catalog.");
110110
else if (ret == 1)
111111
elog(ERROR,
112-
"another pg_arman is running, stop delete.");
112+
"another pg_probackup is running, stop delete.");
113113

114114
backup_list = catalog_get_backup_list(0);
115115
for (i = 0; i < parray_num(backup_list); i++)

dir.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
*-------------------------------------------------------------------------
88
*/
99

10-
#include "pg_arman.h"
10+
#include "pg_probackup.h"
1111

1212
#include <libgen.h>
1313
#include <unistd.h>

0 commit comments

Comments
 (0)