Skip to content

Commit

Permalink
MGDCTRS-537 Add processor definitions for Debezium SMTs/processors
Browse files Browse the repository at this point in the history 
+ apply wording changes, round 1

closes https://issues.redhat.com/browse/MGDCTRS-537
  • Loading branch information
@rk3rn3r
rk3rn3r committed Feb 8, 2023
1 parent c4162d5 commit 67ab8d6
Show file tree
Hide file tree
Showing 8 changed files with 146 additions and 147 deletions.
32 changes: 16 additions & 16 deletions descriptors/mongodb/debezium-mongodb-2.0.1.Final.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -301,12 +301,12 @@
},
"includes" : {
"title" : "Included fields",
"description" : "List of field names that should pass filtering. When set, fields that are not included in this list will be filtered out / removed from the payload. Mind that excludes have precedence over the included fields!",
"description" : "List of field names of fields to include in the payload. Fields that are not listed are removed from the payload. Note that the \"Excluded fields\" list takes precedence over the \"Included fields\" list.",
"$ref" : "#/$defs/include_exclude_list"
},
"excludes" : {
"title" : "Excluded fields",
"description" : "List of field names that should not pass filtering. When set, fields that are excluded will be filtered out / removed from the payload. Excludes have precedence over the include list!",
"description" : "List of field names of fields to remove from the payload. The \"Exclude fields\" list takes precedence over the \"Included fields\" list.",
"$ref" : "#/$defs/include_exclude_list"
},
"rename_fields" : {
Expand All @@ -320,7 +320,7 @@
"properties" : {
"old_name" : {
"title" : "Old field name",
"description" : "The old field name in the payload that should be renamed.",
"description" : "The original label of the field that you want to rename in the payload.",
"type" : "string"
},
"new_name" : {
Expand Down Expand Up @@ -350,15 +350,15 @@
},
"fields" : {
"title" : "Fields",
"description" : "Fields in the payload which values should be replaced with <code>replacement</code> or with a valid null value for the field type (i.e. 0, false, empty string, and so on) when no replacement is set.",
"description" : "Fields in the payload whose original values you want to replace with <code>replacement</code>. If no replacement value is specified, values are replaced with a valid null value for the field type (0, false, empty string, and so on).",
"type" : "array",
"items" : {
"type" : "string"
}
},
"replacement" : {
"title" : "Replacement",
"description" : "When set, the given fields are replaced with this value that is converted to the correct type. Else with a valid null value for the field type (i.e. 0, false, empty string, and so on).",
"description" : "When set, the values of the specified fields are replaced with this value which will be converted to the correct type. If no replacement value is specified, values are replaced with a valid null value for the field type (0, false, empty string, and so on).",
"type" : "string"
}
}
Expand Down Expand Up @@ -398,8 +398,8 @@
"required" : [ "fields" ],
"properties" : {
"fields" : {
"title" : "Value fields for new key",
"description" : "Name of the fields that will be used to replace the message key.",
"title" : "Fields for new key",
"description" : "Name/s of the field/s in the payload to be used to replace the original message key.",
"type" : "array",
"items" : {
"type" : "string"
Expand All @@ -409,9 +409,9 @@
}
}
}, {
"type" : "object",
"title" : "Simple Debezium Topic Router (not enforcing message key uniqueness)",
"description" : "Simple Debezium Topic Router for sending change events from multiple physical tables to one topic without enforcing message key uniqueness. See: <a href=\"https://debezium.io/documentation/reference/transformations/topic-routing.html\">Topic Routing section</a> in the Debezium docs.",
"description" : "Simple Debezium Topic Router for sending change events from multiple physical tables to a specified Kafka topic. The router does not enforce message key uniqueness. See: <a href=\"https://debezium.io/documentation/reference/transformations/topic-routing.html\">Topic Routing section</a> in the Debezium docs.",
"type" : "object",
"required" : [ "debezium_topic_router_simple" ],
"additionalProperties" : false,
"properties" : {
Expand All @@ -421,7 +421,7 @@
"properties" : {
"topic_regex" : {
"title" : "Input topic regex",
"description" : "A regular expression on the topic name of each message that determines if it should be routed to a another destination topic and captures one or more groups of characters to be applied in <code>output_topic</code>",
"description" : "A regular expression that evaluates the original destination topic name of each message that the connector emits to determine whether to route it to an alternate destination topic. The expression captures one or more groups of characters to apply in <code>output_topic</code>.",
"type" : "string",
"format" : "regex"
},
Expand All @@ -434,9 +434,9 @@
}
}
}, {
"type" : "object",
"title" : "Unique Key Debezium Topic Router (enforcing message key uniqueness)",
"description" : "Debezium Topic Router for sending change events from multiple physical tables to a specific topic and enforcing message key uniqueness. See: <a href=\"https://debezium.io/documentation/reference/transformations/topic-routing.html\">Topic Routing section</a> in the Debezium docs.",
"description" : "Debezium Topic Router for sending change events from multiple physical tables to a specified Kafka topic. The router enforces message key uniqueness. See: <a href=\"https://debezium.io/documentation/reference/transformations/topic-routing.html\">Topic Routing section</a> in the Debezium docs.",
"type" : "object",
"required" : [ "debezium_topic_router_unique_keys" ],
"additionalProperties" : false,
"properties" : {
Expand All @@ -446,7 +446,7 @@
"properties" : {
"topic_regex" : {
"title" : "Input topic regex",
"description" : "A regular expression on the original/input destination topic name of each message that determines if it should be routed to a another destination topic and captures one or more groups of characters to be applied in <code>output_topic</code>",
"description" : "A regular expression on the original destination topic name of each message that determines if it should be routed to a another destination topic and captures one or more groups of characters to be applied in <code>output_topic</code>",
"type" : "string",
"format" : "regex"
},
Expand All @@ -457,13 +457,13 @@
},
"key_field_name" : {
"title" : "Key field name",
"description" : "Name of the field to be added to the message key. The value of this field identifies the original table name using the original/input destination topic name and can optionally be manipulated with <code>key_field_topic_regex</code> and <code>key_field_value</code>.",
"description" : "Specifies the name of the field to add to the message key. The field value identifies the name of the source table, based on the original destination topic name. Optionally, you can manipulate the key field by setting the <code>key_field_topic_regex</code> and <code>key_field_value</code>.",
"type" : "string",
"default" : "__dbz__physicalTableIdentifier"
},
"key_field_topic_regex" : {
"title" : "Key field topic regex",
"description" : "Regular expression that gets applied on the original/input destination topic name to capture one or more groups of characters and then apply them in <code>key_field_value</code>",
"description" : "A regular expression that is applied to the original destination topic name to capture one or more groups of characters and then apply them in <code>key_field_value</code>",
"type" : "string",
"format" : "regex",
"default" : "(.*)"
Expand Down Expand Up @@ -530,7 +530,7 @@
},
"insert_field_name" : {
"title" : "Field name",
"description" : "The name of the field to insert. Suffix with <code>!</code> to make this a required/mandatory field, or <code>?</code> to keep it optional.",
"description" : "The name of the field to insert. Append the suffix <code>!</code> for a required field, or <code>?</code> for an optional field.",
"type" : "string"
},
"apply_to" : {
Expand Down
32 changes: 16 additions & 16 deletions descriptors/mysql/debezium-mysql-2.0.1.Final.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -331,12 +331,12 @@
},
"includes" : {
"title" : "Included fields",
"description" : "List of field names that should pass filtering. When set, fields that are not included in this list will be filtered out / removed from the payload. Mind that excludes have precedence over the included fields!",
"description" : "List of field names of fields to include in the payload. Fields that are not listed are removed from the payload. Note that the \"Excluded fields\" list takes precedence over the \"Included fields\" list.",
"$ref" : "#/$defs/include_exclude_list"
},
"excludes" : {
"title" : "Excluded fields",
"description" : "List of field names that should not pass filtering. When set, fields that are excluded will be filtered out / removed from the payload. Excludes have precedence over the include list!",
"description" : "List of field names of fields to remove from the payload. The \"Exclude fields\" list takes precedence over the \"Included fields\" list.",
"$ref" : "#/$defs/include_exclude_list"
},
"rename_fields" : {
Expand All @@ -350,7 +350,7 @@
"properties" : {
"old_name" : {
"title" : "Old field name",
"description" : "The old field name in the payload that should be renamed.",
"description" : "The original label of the field that you want to rename in the payload.",
"type" : "string"
},
"new_name" : {
Expand Down Expand Up @@ -380,15 +380,15 @@
},
"fields" : {
"title" : "Fields",
"description" : "Fields in the payload which values should be replaced with <code>replacement</code> or with a valid null value for the field type (i.e. 0, false, empty string, and so on) when no replacement is set.",
"description" : "Fields in the payload whose original values you want to replace with <code>replacement</code>. If no replacement value is specified, values are replaced with a valid null value for the field type (0, false, empty string, and so on).",
"type" : "array",
"items" : {
"type" : "string"
}
},
"replacement" : {
"title" : "Replacement",
"description" : "When set, the given fields are replaced with this value that is converted to the correct type. Else with a valid null value for the field type (i.e. 0, false, empty string, and so on).",
"description" : "When set, the values of the specified fields are replaced with this value which will be converted to the correct type. If no replacement value is specified, values are replaced with a valid null value for the field type (0, false, empty string, and so on).",
"type" : "string"
}
}
Expand Down Expand Up @@ -428,8 +428,8 @@
"required" : [ "fields" ],
"properties" : {
"fields" : {
"title" : "Value fields for new key",
"description" : "Name of the fields that will be used to replace the message key.",
"title" : "Fields for new key",
"description" : "Name/s of the field/s in the payload to be used to replace the original message key.",
"type" : "array",
"items" : {
"type" : "string"
Expand All @@ -439,9 +439,9 @@
}
}
}, {
"type" : "object",
"title" : "Simple Debezium Topic Router (not enforcing message key uniqueness)",
"description" : "Simple Debezium Topic Router for sending change events from multiple physical tables to one topic without enforcing message key uniqueness. See: <a href=\"https://debezium.io/documentation/reference/transformations/topic-routing.html\">Topic Routing section</a> in the Debezium docs.",
"description" : "Simple Debezium Topic Router for sending change events from multiple physical tables to a specified Kafka topic. The router does not enforce message key uniqueness. See: <a href=\"https://debezium.io/documentation/reference/transformations/topic-routing.html\">Topic Routing section</a> in the Debezium docs.",
"type" : "object",
"required" : [ "debezium_topic_router_simple" ],
"additionalProperties" : false,
"properties" : {
Expand All @@ -451,7 +451,7 @@
"properties" : {
"topic_regex" : {
"title" : "Input topic regex",
"description" : "A regular expression on the topic name of each message that determines if it should be routed to a another destination topic and captures one or more groups of characters to be applied in <code>output_topic</code>",
"description" : "A regular expression that evaluates the original destination topic name of each message that the connector emits to determine whether to route it to an alternate destination topic. The expression captures one or more groups of characters to apply in <code>output_topic</code>.",
"type" : "string",
"format" : "regex"
},
Expand All @@ -464,9 +464,9 @@
}
}
}, {
"type" : "object",
"title" : "Unique Key Debezium Topic Router (enforcing message key uniqueness)",
"description" : "Debezium Topic Router for sending change events from multiple physical tables to a specific topic and enforcing message key uniqueness. See: <a href=\"https://debezium.io/documentation/reference/transformations/topic-routing.html\">Topic Routing section</a> in the Debezium docs.",
"description" : "Debezium Topic Router for sending change events from multiple physical tables to a specified Kafka topic. The router enforces message key uniqueness. See: <a href=\"https://debezium.io/documentation/reference/transformations/topic-routing.html\">Topic Routing section</a> in the Debezium docs.",
"type" : "object",
"required" : [ "debezium_topic_router_unique_keys" ],
"additionalProperties" : false,
"properties" : {
Expand All @@ -476,7 +476,7 @@
"properties" : {
"topic_regex" : {
"title" : "Input topic regex",
"description" : "A regular expression on the original/input destination topic name of each message that determines if it should be routed to a another destination topic and captures one or more groups of characters to be applied in <code>output_topic</code>",
"description" : "A regular expression on the original destination topic name of each message that determines if it should be routed to a another destination topic and captures one or more groups of characters to be applied in <code>output_topic</code>",
"type" : "string",
"format" : "regex"
},
Expand All @@ -487,13 +487,13 @@
},
"key_field_name" : {
"title" : "Key field name",
"description" : "Name of the field to be added to the message key. The value of this field identifies the original table name using the original/input destination topic name and can optionally be manipulated with <code>key_field_topic_regex</code> and <code>key_field_value</code>.",
"description" : "Specifies the name of the field to add to the message key. The field value identifies the name of the source table, based on the original destination topic name. Optionally, you can manipulate the key field by setting the <code>key_field_topic_regex</code> and <code>key_field_value</code>.",
"type" : "string",
"default" : "__dbz__physicalTableIdentifier"
},
"key_field_topic_regex" : {
"title" : "Key field topic regex",
"description" : "Regular expression that gets applied on the original/input destination topic name to capture one or more groups of characters and then apply them in <code>key_field_value</code>",
"description" : "A regular expression that is applied to the original destination topic name to capture one or more groups of characters and then apply them in <code>key_field_value</code>",
"type" : "string",
"format" : "regex",
"default" : "(.*)"
Expand Down Expand Up @@ -560,7 +560,7 @@
},
"insert_field_name" : {
"title" : "Field name",
"description" : "The name of the field to insert. Suffix with <code>!</code> to make this a required/mandatory field, or <code>?</code> to keep it optional.",
"description" : "The name of the field to insert. Append the suffix <code>!</code> for a required field, or <code>?</code> for an optional field.",
"type" : "string"
},
"apply_to" : {
Expand Down
Loading

0 comments on commit 67ab8d6

Please sign in to comment.