Skip to content

Commit 2d6f1c3

Browse files
committed
update README.md
1 parent e39bdfc commit 2d6f1c3

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

Diff for: README.md

+9
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ We encourage you to use `virtualenv` for your testing environment.
2020

2121
## Usage
2222

23+
### Environment
24+
2325
> Note: by default testgres runs `initdb`, `pg_ctl`, `psql` provided by `PATH`.
2426
2527
There are several ways to specify a custom postgres installation:
@@ -35,6 +37,13 @@ python my_tests.py
3537
```
3638

3739

40+
### Logging
41+
42+
By default, `cleanup()` removes all temporary files (DB files, logs etc) that were created by testgres' API methods. If you'd like to keep logs, execute `configure_testgres(node_cleanup_full=False)` before running any tests.
43+
44+
> Note: context managers (aka `with`) call `cleanup()` automatically.
45+
46+
3847
### Overview
3948

4049
Here is an example of what you can do with `testgres`:

0 commit comments

Comments
 (0)