Skip to content

Commit

Permalink
Doc touch-up
Browse files Browse the repository at this point in the history
  • Loading branch information
msg555 committed Oct 10, 2024
1 parent 769c44c commit 70255b6
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@ Similar tools include Tonic.ai's platform and [condenser](https://github.com/Ton
This is meant to be a simple CLI tool that overcomes many of the difficulties in
using `condenser`.

## Installation

You can use subsetter by installing it through pip:

```sh
pip install subsetter
```

Or by using the published `msg555/subsetter` image:

```sh
docker run --rm -v "./subsetter.yaml:/tmp/subsetter.yaml" msg555/subsetter -c /tmp/subsetter.yaml subset
```

## Limitations

The subsetter tool takes an approach of "one table, one query". This means that
Expand Down
4 changes: 4 additions & 0 deletions subsetter.example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ source:
- SET @@session.wait_timeout=28800
- SET @@session.innodb_lock_wait_timeout=3600

# Set transaction isolation level. Defaults to 'READ COMMITTED' (SERIALIZABLE
# for sqlite).
isolation_level: "READ COMMITTED"

# For engines where it applies specify database name to connect to as well.
# database: my_dbname # deafults to SUBSET_SOURCE_DATABASE

Expand Down

0 comments on commit 70255b6

Please sign in to comment.