Skip to content

Commit 70255b6

Browse files
committed
Doc touch-up
1 parent 769c44c commit 70255b6

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,20 @@ Similar tools include Tonic.ai's platform and [condenser](https://github.com/Ton
1212
This is meant to be a simple CLI tool that overcomes many of the difficulties in
1313
using `condenser`.
1414

15+
## Installation
16+
17+
You can use subsetter by installing it through pip:
18+
19+
```sh
20+
pip install subsetter
21+
```
22+
23+
Or by using the published `msg555/subsetter` image:
24+
25+
```sh
26+
docker run --rm -v "./subsetter.yaml:/tmp/subsetter.yaml" msg555/subsetter -c /tmp/subsetter.yaml subset
27+
```
28+
1529
## Limitations
1630

1731
The subsetter tool takes an approach of "one table, one query". This means that

subsetter.example.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ source:
1313
- SET @@session.wait_timeout=28800
1414
- SET @@session.innodb_lock_wait_timeout=3600
1515

16+
# Set transaction isolation level. Defaults to 'READ COMMITTED' (SERIALIZABLE
17+
# for sqlite).
18+
isolation_level: "READ COMMITTED"
19+
1620
# For engines where it applies specify database name to connect to as well.
1721
# database: my_dbname # deafults to SUBSET_SOURCE_DATABASE
1822

0 commit comments

Comments
 (0)