Skip to content

Commit adec2b3

Browse files
postgres_cdc: Improve documentation around replication slot name (#3834)
1 parent db256b9 commit adec2b3

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/modules/components/pages/inputs/postgres_cdc.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,9 @@ If set to true, creates a temporary replication slot that is automatically dropp
222222
223223
The name of the PostgreSQL logical replication slot to use. If not provided, a random name will be generated. You can create this slot manually before starting replication if desired.
224224
225+
Note: To avoid needing to grant the replication user permission to create publications, you can manually create the publications ahead of time.
226+
This connector uses the naming pattern `pglog_stream_<replication_slot_name>`, so be sure to create them using this convention.
227+
225228
226229
*Type*: `string`
227230

internal/impl/postgresql/input_pg_stream.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,11 @@ This input adds the following metadata fields to each message:
116116
Description("If set to true, creates a temporary replication slot that is automatically dropped when the connection is closed.").
117117
Default(false)).
118118
Field(service.NewStringField(fieldSlotName).
119-
Description("The name of the PostgreSQL logical replication slot to use. If not provided, a random name will be generated. You can create this slot manually before starting replication if desired.").
119+
Description(`The name of the PostgreSQL logical replication slot to use. If not provided, a random name will be generated. You can create this slot manually before starting replication if desired.
120+
121+
Note: To avoid needing to grant the replication user permission to create publications, you can manually create the publications ahead of time.
122+
This connector uses the naming pattern ` + "`pglog_stream_<replication_slot_name>`" + `, so be sure to create them using this convention.
123+
`).
120124
Example("my_test_slot")).
121125
Field(service.NewDurationField(fieldPgStandbyTimeout).
122126
Description("Specify the standby timeout before refreshing an idle connection.").

0 commit comments

Comments
 (0)