Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

typos corrected and added some explanations #8

Merged
merged 2 commits into from
Jan 2, 2024
Merged

typos corrected and added some explanations #8

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52abb46
typos corrected
hkey0 Dec 26, 2023
8e8b5a8
fixed as requested
hkey0 Dec 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Sinker is built by [Paradigm](https://www.paradigm.xyz/), and is licensed under

In Postgres, you might have a normalized schema like this:

- A Student and a Teacher refer to a Person
- A Student and a Teacher refers to a Person
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is correct as is

- A Course is taught by a Teacher
- Students have and belong to many Courses through the Enrollment join table
- Students have taken and belong to many Courses through the Enrollment join table
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer to keep this language as HABTM is a standard way to indicate a many-to-many relationship.


![schema](sinker_schema.png)

Expand Down Expand Up @@ -78,7 +78,7 @@ Sinker creates triggers on the Postgres tables that you want to synchronize (e.g
above). When a row is inserted, updated, or deleted in any of these tables, the trigger schedules the materialized view
to be refreshed at the next interval.

The changes to the materialized view are sent to a logical replication slot. Sinker reads from this slot and indexes the
The changes into the materialized view are sent to a logical replication slot. Sinker reads from this slot and indexes the
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "changes to" is correct as is.

documents in Elasticsearch.

You define the query behind the materialized view, so you can denormalize the data however you want, filter out unwanted
Expand Down Expand Up @@ -331,7 +331,7 @@ Spin up Postgres and Elasticsearch:
docker-compose --env-file=.env.test up -d
```

Run tests:
Run tests (with -s option to allow more verbose output):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


```shell
poetry run pytest -s
Expand Down