Skip to content

Commit

Permalink
Add PostgreSQL to README (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
nathan-artie authored Jan 26, 2024
1 parent d0bd081 commit 98f618f
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div align="center">
<img height="150px" src="https://github.com/artie-labs/transfer/assets/4412200/238df0c7-6087-4ddc-b83b-24638212af6a"/>
<h3>Artie Reader</h3>
<p><b>📚 Grabbing data changes from various sources such as DynamoDB 📚</b></p>
<p><b>📚 Grabbing data changes from various sources such as PostgreSQL & DynamoDB 📚</b></p>
<a href="https://artie.so/slack"><img src="https://img.shields.io/badge/[email protected]?logo=slack"/></a>
<a href="https://github.com/artie-labs/reader/blob/master/LICENSE.txt"><img src="https://user-images.githubusercontent.com/4412200/201544613-a7197bc4-8b61-4fc5-bf09-68ee10133fd7.svg"/></a>
<img src="https://github.com/artie-labs/reader/actions/workflows/gha-go-test.yaml/badge.svg"/>
Expand All @@ -12,7 +12,7 @@

## Getting this running

Generate a `config.yaml` file with the following contents:
For DynamoDB create a `config.yaml` file with the following contents:

```yaml
source: dynamodb
Expand All @@ -30,6 +30,26 @@ kafka:
topicPrefix: topicPrefix
```
For PostgreSQL create a `config.yaml` file with the following contents:

```yaml
source: postgresql
postgresql:
host: hostname
port: 5432
userName: username
password: password
database: postgres
tables:
- name: table
schema: public
kafka:
bootstrapServers: localhost:29092
topicPrefix: topicPrefix
```

Then run the following command:

```bash
Expand All @@ -38,3 +58,4 @@ go run main.go --config config.yaml

## What is currently supported?
* DynamoDB (via DynamoDB streams)
* PostgreSQL

0 comments on commit 98f618f

Please sign in to comment.