add init_replication description and required permissions #3020
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for dlt-hub-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
VioletM
requested changes
Aug 26, 2025
| - Ownership of the publication and tables to add them | ||
| - Superuser privileges if replicating an entire schema | ||
| - `SELECT` on source tables and `CREATE` on the target schema for snapshots | ||
| - Superuser or the `REPLICATION` attribute for replication slot operations |
There was a problem hiding this comment.
As an item 3: users also need ownership of the tables
molkazhani2001
force-pushed
the
docs/pg_replication_improvement
branch
from
b81688d to
9372083
Compare
anuunchin
force-pushed
the
docs/pg_replication_improvement
branch
from
9372083 to
37f1380
Compare
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs | 6097a65 | Commit Preview URL Branch Preview URL |
Oct 02 2025, 07:59 AM |
anuunchin
force-pushed
the
docs/pg_replication_improvement
branch
2 times, most recently
from
f50f87b to
027b3c3
Compare
anuunchin
reviewed
Oct 1, 2025
| | Name | Description | | ||
| | -------------------- | ----------------------------------------------- | | ||
| | replication_resource | Load published messages from a replication slot | | ||
| | init_replication | Initialize replication and optionally return snapshot resources for initial data load | |
There was a problem hiding this comment.
@VioletM thought it makes sense to add it here, because it does serve as a resource 👀
anuunchin
force-pushed
the
docs/pg_replication_improvement
branch
from
027b3c3 to
6097a65
Compare
VioletM
requested changes
Oct 23, 2025
| ... | ||
| ``` | ||
|
|
||
| `slot_name`: Name of the replication slot to create if it does not exist yet. |
There was a problem hiding this comment.
This section is just a copy-past from the verified-source repo. Do you think it makes sense to leave it here? I think it will only create an additional place to edit together with the code :)
|
|
||
| ### Snapshot resources from `init_replication` | ||
|
|
||
| The `init_replication` function serves two main purposes: |
There was a problem hiding this comment.
The usage of init_replication is kind of complex also because of all the permissions. I would also add:
The example below make use of the `init_replication` helper from the `pg_replication` source.
When you run `init_replication`, Postgres is prepared for logical replication: a publication is created and tables (or the whole schema) are added, a replication slot is created, and—if `persist_snapshots=True` snapshot tables are generated to capture the initial state.
To perform these steps your Postgres user needs the following permissions:
- `CREATE` on the database (or superuser) to create publications
- Ownership of the publication and tables to add them
- Superuser privileges if replicating an entire schema
- `SELECT` on source tables and `CREATE` on the target schema for snapshots
- Superuser or the `REPLICATION` attribute for replication slot operations
There was a problem hiding this comment.
Thank you so much for taking care of it @anuunchin !
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is a twin PR to the one in verified sources.
Relates to 640 in verified sources.