Skip to content

Commit cab07ad

Browse files
committed
Update README
1 parent 92c34f2 commit cab07ad

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Overview
66

7-
Ptrack is a fast block-level incremental backup engine for PostgreSQL. Currently `ptrack` codebase is split approximately 50/50% between PostgreSQL core patch and extension. All public SQL API methods are placed in the `ptrack` extension, while the main engine is still in core.
7+
Ptrack is a fast block-level incremental backup engine for PostgreSQL. Currently `ptrack` codebase is split between small PostgreSQL core patch and extension. All public SQL API methods and main engine are placed in the `ptrack` extension, while the core patch contains only certain hooks and modifies binary utilities to ignore `ptrack.map.*` files.
88

99
## Installation
1010

@@ -17,15 +17,16 @@ git clone https://github.com/postgres/postgres.git -b REL_12_STABLE && cd postgr
1717
2) Apply PostgreSQL core patch:
1818

1919
```shell
20-
git apply ptrack/patches/ptrack-2.0-core.diff
20+
git apply -3 ptrack/patches/REL_12_STABLE-ptrack-core.diff
2121
```
2222

2323
3) Compile and install PostgreSQL
2424

25-
4) Set `ptrack_map_size` (in MB)
25+
4) Set `ptrack.map_size` (in MB)
2626

2727
```shell
28-
echo 'ptrack_map_size = 64' >> postgres_data/postgresql.conf
28+
echo "shared_preload_libraries = 'ptrack'" >> postgres_data/postgresql.conf
29+
echo "ptrack.map_size = 64" >> postgres_data/postgresql.conf
2930
```
3031

3132
5) Compile and install `ptrack` extension
@@ -42,10 +43,9 @@ CREATE EXTENSION ptrack;
4243

4344
## Public SQL API
4445

45-
* ptrack_version() --- returns ptrack version string (2.0 currently).
46-
* pg_ptrack_get_pagemapset('LSN') --- returns a set of changed data files with bitmaps of changed blocks since specified LSN.
47-
* pg_ptrack_control_lsn() --- returns LSN of the last ptrack map initialization.
48-
* pg_ptrack_get_block --- returns a requested block of relation.
46+
* ptrack_version() — returns ptrack version string (2.0 currently).
47+
* ptrack_get_pagemapset('LSN') — returns a set of changed data files with bitmaps of changed blocks since specified LSN.
48+
* ptrack_init_lsn() — returns LSN of the last ptrack map initialization.
4949

5050
## Architecture
5151

0 commit comments

Comments
 (0)