pgcdc: update examples with quoting

redpanda-data · Dec 13, 2024 · 9b77304 · 9b77304
1 parent 20e90bf
commit 9b77304
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 13 deletions.
diff --git a/docs/modules/components/pages/inputs/pg_stream.adoc b/docs/modules/components/pages/inputs/pg_stream.adoc
@@ -193,6 +193,8 @@ The PostgreSQL schema from which to replicate data.
 # Examples
 
 schema: public
+
+schema: '"MyCaseSensitiveSchemaNeedingQuotes"'
 ```
 
 === `tables`
@@ -206,10 +208,9 @@ A list of table names to include in the logical replication. Each table should b
 ```yml
 # Examples
 
-tables: |2-
-  			- my_table
-  			- my_table_2
-  		
+tables:
+  - my_table_1
+  - '"MyCaseSensitiveTableNeedingQuotes"'
 ```
 
 === `checkpoint_limit`

diff --git a/docs/modules/components/pages/inputs/postgres_cdc.adoc b/docs/modules/components/pages/inputs/postgres_cdc.adoc
@@ -188,6 +188,8 @@ The PostgreSQL schema from which to replicate data.
 # Examples
 
 schema: public
+
+schema: '"MyCaseSensitiveSchemaNeedingQuotes"'
 ```
 
 === `tables`
@@ -201,10 +203,9 @@ A list of table names to include in the logical replication. Each table should b
 ```yml
 # Examples
 
-tables: |2-
-  			- my_table
-  			- my_table_2
-  		
+tables:
+  - my_table_1
+  - '"MyCaseSensitiveTableNeedingQuotes"'
 ```
 
 === `checkpoint_limit`

diff --git a/internal/impl/postgresql/input_pg_stream.go b/internal/impl/postgresql/input_pg_stream.go
@@ -85,13 +85,11 @@ This input adds the following metadata fields to each message:
 			Default(0)).
 		Field(service.NewStringField(fieldSchema).
 			Description("The PostgreSQL schema from which to replicate data.").
-			Example("public")).
+			Examples("public", `"MyCaseSensitiveSchemaNeedingQuotes"`),
+		).
 		Field(service.NewStringListField(fieldTables).
 			Description("A list of table names to include in the logical replication. Each table should be specified as a separate item.").
-			Example(`
-			- my_table
-			- my_table_2
-		`)).
+			Example([]string{"my_table_1", `"MyCaseSensitiveTableNeedingQuotes"`})).
 		Field(service.NewIntField(fieldCheckpointLimit).
 			Description("The maximum number of messages that can be processed at a given time. Increasing this limit enables parallel processing and batching at the output level. Any given LSN will not be acknowledged unless all messages under that offset are delivered in order to preserve at least once delivery guarantees.").
 			Default(1024)).