Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Minimistro32 committed May 19, 2024
1 parent 3daef39 commit 6bebeb4
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ TOKENSECRET=...
4. Hit `Run All`
5. Look for the results in the results folder.

<img src="./system/imgs/query.png" alt="Query GUI Example">

#### Query Options
* If you want to query an additional environment (like a sandbox) create a second `.env` file with a seperate name (like `.env.sb2`). Then simply type the name of the `.env` file you want to use in the `environment variable.
* To specify a name for the results csv, enter it into the `results_file` variable. Leave it as the empty string to skip writing a file.
* Use `should_print` to control whether the query output displays to the screen.

<img src="./system/imgs/query.png" alt="Query GUI Example">

### Schema Browsing (`schema.ipynb`)

1. Open `schema.ipynb`.
Expand All @@ -57,7 +57,7 @@ TOKENSECRET=...
*Sample Outputs:*
All Tables | Transaction Table
:-------------------------:|:-------------------------:
<img src="./system/imgs/db.png" alt="schema viewer gif"> | <img src="./system/imgs/table.png" alt="schema viewer gif">
<img src="./system/imgs/db.png" alt="Schema Browser: Sample DB Tables Output"> | <img src="./system/imgs/table.png" alt="Schema Browser: Sample Table Output">

#### Browser Options
* Enter a regex search pattern in the `pattern` variable to find columns more easily.
Expand All @@ -76,4 +76,4 @@ drilldown = """
└─ comments
└─ companyname
"""
```
```

0 comments on commit 6bebeb4

Please sign in to comment.