Skip to content

Commit 7da466a

Browse files
authored
DOC-1215 Add translate ID fields to migrator and schema_registry outputs (#215)
1 parent f026717 commit 7da466a

File tree

3 files changed

+27
-4
lines changed

3 files changed

+27
-4
lines changed

modules/components/pages/outputs/redpanda_migrator.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ output:
7272
input_resource: redpanda_migrator_input
7373
replication_factor_override: true
7474
replication_factor: 3
75-
translate_schema_ids: true
75+
translate_schema_ids: false
7676
schema_registry_output_resource: schema_registry_output
7777
idempotent_write: true
7878
compression: "" # No default (optional)
@@ -611,11 +611,11 @@ The replication factor for created topics. This is only used when `replication_f
611611

612612
=== `translate_schema_ids`
613613

614-
When set to `true`, this field translates the schema ID in each message ready to write to the destination schema registry.
614+
When set to `true`, this field automatically translates the schema ID in each message to match the corresponding schema in the destination schema registry.
615615

616616
*Type*: `bool`
617617

618-
*Default*: `true`
618+
*Default*: `false`
619619

620620
=== `schema_registry_output_resource`
621621

modules/components/pages/outputs/redpanda_migrator_bundle.adoc

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ output:
2525
redpanda_migrator_bundle:
2626
redpanda_migrator: {} # No default (required)
2727
schema_registry: {} # No default (optional)
28+
translate_schema_ids: false
2829
```
2930

3031
== Fields
@@ -40,7 +41,19 @@ The xref:components:outputs/redpanda_migrator.adoc[`redpanda_migrator` output] c
4041

4142
The xref:components:outputs/schema_registry.adoc[`schema_registry` output] configuration. The `subject` field must be left empty.
4243

43-
4444
*Type*: `object`
4545

46+
=== `translate_schema_ids`
47+
48+
When set to `true`, this field enables:
49+
50+
- The `translate_schema_ids` field in the specified xref:components:outputs/redpanda_migrator.adoc#translate_schema_ids[`redpanda_migrator` output].
51+
- The `translate_ids` field in the specified xref:components:outputs/schema_registry.adoc#translate_ids[`schema_registry` output].
52+
53+
When set to `false`, both fields are disabled.
54+
55+
*Type*: `bool`
56+
57+
*Default*: `false`
58+
4659
// end::single-source[]

modules/components/pages/outputs/schema_registry.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ output:
4646
url: "" # No default (required)
4747
subject: "" # No default (required)
4848
backfill_dependencies: true
49+
translate_ids: false
4950
input_resource: schema_registry_input
5051
tls:
5152
enabled: false
@@ -128,6 +129,15 @@ Backfill missing schema references and previous schema versions. If set to `true
128129

129130
*Default*: `true`
130131

132+
=== `translate_ids`
133+
134+
When set to `true`, this field automatically translates the schema ID in each message to match the corresponding schema in the destination schema registry. The updated message is then written to the destination schema registry.
135+
136+
*Type*: `bool`
137+
138+
*Default*: `false`
139+
140+
131141
=== `input_resource`
132142

133143
The label of the xref:components:inputs/schema_registry.adoc[`schema_registry` input] from which to read source schemas.

0 commit comments

Comments
 (0)