EricJoy2048 commented on code in PR #3786:
URL: 
https://github.com/apache/incubator-seatunnel/pull/3786#discussion_r1059249427


##########
docs/en/transform-v2/replace.md:
##########
@@ -0,0 +1,161 @@
+# Replace
+
+> Replace transform plugin
+
+## Description
+
+Examines string value in a given field and replaces substring of the string 
value that matches the given string literal or regexes with the given 
replacement.
+
+## Options
+
+| name           | type   | required | default value |
+| -------------- | ------ | -------- |---------------|
+| replace_field  | string | yes      |               |
+| pattern        | string | yes      | -             |
+| replacement    | string | yes      | -             |
+| is_regex       | boolean| no       | false         |
+| replace_first  | boolean| no       | false         |
+
+### replace_field [string]
+
+The field you want to replace
+
+### pattern [string]
+
+The old string that will be replaced
+
+### replacement [string]
+
+The new string for replace
+
+### is_regex [boolean]
+
+Use regex for string match
+
+### replace_first [boolean]
+
+Whether replace the first match string. Only used when `is_regex = true`.
+
+### common options [string]
+
+Transform plugin common parameters, please refer to [Transform 
Plugin](common-options.md) for details
+
+## Example
+
+The data read from source is a table like this:
+
+| name     | age | card |
+|----------|-----|------|
+| Joy Ding | 20  | 123  |
+| May Ding | 20  | 123  |
+| Kin Dom  | 20  | 123  |
+| Joy Dom  | 20  | 123  |
+
+We want to replace the char ` ` to `_` at the `name` field. Then we can add a 
`Replace` Transform like this:
+
+```
+transform {
+  Replace {
+    source_table_name = "fake"
+    result_table_name = "fake1"
+    replace_field = "name"
+    pattern = " "
+    replacement = "_"
+    is_regex = true
+  }
+}
+```
+
+Then the data in result table `fake1` will update to 
+
+
+| name     | age | card |
+|----------|-----|------|
+| Joy_Ding | 20  | 123  |
+| May_Ding | 20  | 123  |
+| Kin_Dom  | 20  | 123  |
+| Joy_Dom  | 20  | 123  |
+
+## Job Config Example
+
+```
+env {
+  job.mode = "BATCH"
+}
+
+source {
+  FakeSource {
+    result_table_name = "fake"
+    row.num = 100
+    schema = {
+      fields {
+        id = "int"
+        name = "string"
+      }
+    }
+  }
+}
+
+transform {
+  Replace {
+    source_table_name = "fake"
+    result_table_name = "fake1"
+    replace_field = "name"
+    pattern = ".+"
+    replacement = "b"
+    is_regex = true
+  }
+}
+
+sink {
+  Console {
+    source_table_name = "fake1"
+  }
+  Assert {

Review Comment:
   done



##########
docs/en/transform-v2/filter-rowkind.md:
##########
@@ -0,0 +1,83 @@
+# FilterRowKind
+
+> FilterRowKind transform plugin
+
+## Description
+
+Filter the data by RowKind
+
+## Options
+
+| name          | type  | required | default value |
+|---------------|-------| -------- |---------------|
+| include_kinds | array | yes      |               |
+| exclude_kinds | array | yes      |               |
+
+### include_kinds [array]
+
+The row kinds to include
+
+### exclude_kinds [array]
+
+The row kinds to exclude.
+
+You can only config one of `include_kinds` and `exclude_kinds`.
+
+### common options [string]
+
+Transform plugin common parameters, please refer to [Transform 
Plugin](common-options.md) for details
+
+## Examples
+
+The RowKink of the data generate by FakeSource is `INSERT`, If we use 
`FilterRowKink` transform and exclude the `INSERT` data, we will write zero 
rows into sink.
+
+```yaml
+
+env {
+  job.mode = "BATCH"
+}
+
+source {
+  FakeSource {
+    result_table_name = "fake"
+    row.num = 100
+    schema = {
+      fields {
+        id = "int"
+        name = "string"
+        age = "int"
+      }
+    }
+  }
+}
+
+transform {
+  FilterRowKind {
+    source_table_name = "fake"
+    result_table_name = "fake1"
+    exclude_kinds = ["INSERT"]
+  }
+}
+
+sink {
+  Console {
+    source_table_name = "fake1"
+  }
+  Assert {

Review Comment:
   done



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to