Skip to content

Commit 04ebcb0

Browse files
committed
Clarify Sequin Postgres config
1 parent 186c220 commit 04ebcb0

File tree

5 files changed

+16
-3
lines changed

5 files changed

+16
-3
lines changed

docker/playground.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,3 @@ databases:
1515
port: 5432
1616
slot_name: "sequin_slot"
1717
publication_name: "sequin_pub"
18-
tables:
19-
- table_name: "products"
20-
sort_column_name: "updated_at"

docs/introduction.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ Sequin works great for CDC use cases like:
4343

4444
Sequin is a Docker image you can run next to your Postgres database. Sequin itself is built on Postgres and uses Postgres to store sink state.
4545

46+
<Note>
47+
The Postgres instance Sequin uses for its own state is distinct from the databases you stream from. You configure Sequin's database connection with the `PG_*` environment variables and configure your source databases in [`sequin.yaml`](/reference/sequin-yaml#database-configuration).
48+
</Note>
49+
4650
## Demo
4751

4852
See Sequin in action. In this demo, we'll stream changes to Kafka, deploy to production, and scale to 2,000 messages / second.

docs/reference/configuration.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ You can provide a YAML configuration file to Sequin. This configuration file wil
4949
- `PG_SSL`: Enable SSL for Postgres connection (default: false)
5050
- `PG_POOL_SIZE`: Database connection pool size (default: 10)
5151

52+
<Note>
53+
These variables configure the Postgres database that Sequin itself uses to store state. They are not for the databases you stream from—those are defined in [`sequin.yaml`](/reference/sequin-yaml#database-configuration).
54+
</Note>
55+
5256
#### `PG_POOL_SIZE`
5357

5458
The `PG_POOL_SIZE` variable controls the maximum number of concurrent connections that Sequin will maintain to Postgres. For higher throughput on larger Postgres instances, you should increase this value.

docs/reference/sequin-yaml.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ api_tokens:
5151
5252
### Database configuration
5353
54+
<Note>
55+
These database entries tell Sequin which Postgres instances to capture changes from. They are separate from the Postgres database that Sequin itself uses, which is configured via the `PG_*` environment variables.
56+
</Note>
57+
5458
```yaml
5559
databases:
5660
- name: "my-database" # Required, unique identifier

docs/running-sequin.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,10 @@ The easiest way to get started with Sequin is with our [Docker Compose file](htt
135135

136136
Sequin uses a Postgres database for configuration and to assist with its change data capture process.
137137

138+
<Note>
139+
These `PG_*` variables configure Sequin's internal Postgres database. The Postgres databases you want to stream from are configured separately in [`sequin.yaml`](/reference/sequin-yaml#database-configuration).
140+
</Note>
141+
138142
We recommend creating a new logical database for Sequin in your existing Postgres instance:
139143

140144
```sql

0 commit comments

Comments
 (0)