From e45a216c9c47a5b8bff0ae63b769686bb29b0abe Mon Sep 17 00:00:00 2001 From: Caleb Grant Date: Wed, 13 Nov 2024 07:23:56 -0800 Subject: [PATCH] update docs Signed-off-by: Caleb Grant --- README.md | 4 ++-- docs/examples.md | 7 +++---- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index db224b3..42cb37a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/docs/examples.md b/docs/examples.md index ae8158f..01e0e09 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -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", @@ -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() ```