Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Caleb Grant <[email protected]>
  • Loading branch information
geocoug committed Nov 13, 2024
1 parent e74a34c commit e45a216
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ options:

#### Configuration File

To use a configuration file, create a YAML file with the format below. This is also provided in the [pg_upsert.example.yaml](./pg_upsert.example.yaml) file in the repository.
To use a configuration file, create a YAML file with the format below. This example is also provided in the [pg_upsert.example.yaml](./pg_upsert.example.yaml) file. The configuration file can be passed to `pg_upsert` using the `-f` or `--config-file` flag.

```yaml
debug: false
Expand Down Expand Up @@ -147,7 +147,7 @@ null_columns:
Then, run `pg_upsert -f pg_upsert.yaml`.

If the user specifies a configuration file and command line arguments, the configuration file will override the command line arguments.
If the user specifies a configuration file **and** command line arguments, the configuration file will override any command line arguments specified.

### Docker

Expand Down
7 changes: 3 additions & 4 deletions docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,7 @@ This example will demonstrate how to use `pg_upsert` to upsert data from staging
logger.addHandler(logging.StreamHandler())
PgUpsert(
host="localhost",
port=5432,
database="dev",
user="username",
uri="postgresql://user@localhost:5432/database", # Note the missing password. pg_upsert will prompt for the password.
tables=("genres", "books", "authors", "book_authors"),
stg_schema="staging",
base_schema="public",
Expand Down Expand Up @@ -243,6 +240,8 @@ This example will demonstrate how to use `pg_upsert` to upsert data from staging

## QA and upsert

Run all QA checks and then run the upsert process on all tables.

```python
upsert.run()
```
Expand Down

0 comments on commit e45a216

Please sign in to comment.