ruanwenjun commented on code in PR #2022: URL: https://github.com/apache/incubator-seatunnel/pull/2022#discussion_r900276305
########## docs/en/connector/sink/Assert.md: ########## @@ -0,0 +1,105 @@ +# Assert + +> # Sink plugin: Assert [Flink] + +## Description + +A flink sink plugin which can assert illegal data by user defined rules + +:::tip + +Engine Supported and plugin name + +* [ ] Spark +* [x] Flink: AssertSink + +::: + +## Options + +| name | type | required | default value | +| ----------------------- | -------- | -------- | ------------- | +| rules | ConfigList | yes | - | +|  field_name | `String` | yes | - | +|  field_type | `String` | no | - | +|  field_value | ConfigList | no | - | +|   rule_type | `String` | no | - | +|   rule_value | double | no | - | + + +### rules + +Rule definition of user's available data. Each rule represents one field validation. + +### field_name + +field name（string） + +### field_type + +field type (string), e.g. `short/int/long/string/boolean` Review Comment: Please give the complete supported field types in the doc, don't just say e.g. `short/int/long/string/boolean`, if I see this, I will believe that the assert plugin only support these 5 types. ########## docs/en/connector/sink/Assert.md: ########## @@ -0,0 +1,105 @@ +# Assert + +> # Sink plugin: Assert [Flink] + +## Description + +A flink sink plugin which can assert illegal data by user defined rules + +:::tip + +Engine Supported and plugin name + +* [ ] Spark +* [x] Flink: AssertSink + +::: + +## Options + +| name | type | required | default value | +| ----------------------- | -------- | -------- | ------------- | +| rules | ConfigList | yes | - | +|  field_name | `String` | yes | - | +|  field_type | `String` | no | - | +|  field_value | ConfigList | no | - | +|   rule_type | `String` | no | - | +|   rule_value | double | no | - | + + +### rules + +Rule definition of user's available data. Each rule represents one field validation. + +### field_name + +field name（string） + +### field_type + +field type (string), e.g. `short/int/long/string/boolean` + +### field_value + +A list value rule define the data value validation + +### rule_type + +The following rules are supported for now +` +NOT_NULL, +MIN, +MAX, +MIN_LENGTH, +MAX_LENGTH Review Comment: Please clarify the meaning of each rule type, and if we break the rule, what will happen. -- 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]
