Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 62238ac

Browse files
committed
Describe the test backup directory prefix
1 parent bd37658 commit 62238ac

File tree

1 file changed

+6
-14
lines changed

1 file changed

+6
-14
lines changed

testgres/plugins/pg_probackup2/README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,14 @@ The package requires testgres~=1.9.3.
1616

1717
## Usage
1818

19-
### Environment
19+
### Environment variables
2020

21-
> Note: by default testgres runs `initdb`, `pg_ctl`, `psql` provided by `PATH`.
22-
23-
There are several ways to specify a custom postgres installation:
24-
25-
* export `PG_CONFIG` environment variable pointing to the `pg_config` executable;
26-
* export `PG_BIN` environment variable pointing to the directory with executable files.
27-
28-
Example:
29-
30-
```bash
31-
export PG_BIN=$HOME/pg/bin
32-
python my_tests.py
33-
```
21+
| Variable | Required | Default value | Description |
22+
| - | - | - | - |
23+
| PGPROBACKUP_TMP_DIR | No | tmp_dirs | The root of the temporary directory hierarchy where tests store data and logs. Relative paths start from the `tests` directory. |
24+
| PG_PROBACKUP_TEST_BACKUP_DIR_PREFIX | No | Temporary test hierarchy | Prefix of the test backup directories. Must be an absolute path. Use this variable to store test backups in a location other than the temporary test hierarchy. |
3425

26+
See [Testgres](https://github.com/postgrespro/testgres/tree/master#environment) on how to configure a custom Postgres installation using `PG_CONFIG` and `PG_BIN` environment variables.
3527

3628
### Examples
3729

0 commit comments

Comments
 (0)