Skip to content

Commit 643469f

Browse files
committed
site(docs): update documentations
1 parent 4d13731 commit 643469f

File tree

4 files changed

+159
-61
lines changed

4 files changed

+159
-61
lines changed
Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
date: 2020-05-21
2+
date: 2020-09-30
33
title: "Conditional Execution"
44
linkTitle: "Conditional Execution"
55
weight: 60
@@ -11,7 +11,7 @@ A conditional property `if` can be configured on each filter to determine if tha
1111
When a filter is skipped, message flow to the next filter without any modification.
1212

1313
`if` configuration accepts a Simple Connect Expression that must return to `true` or `false`.
14-
If the configured expression does not evaluate to a boolean value the filter chain will failed.
14+
If the configured expression does not evaluate to a boolean value the filter chain will fail.
1515

1616
The`if` property supports ([simple expression](accessing-data-and-metadata))
1717

@@ -27,19 +27,21 @@ filters.TagSecurityException.field=tags
2727
filters.TagSecurityException.values=SecurityAlert
2828
```
2929

30-
These boolean functions are available for use with `if` configuration :
31-
32-
| Function | Description | Syntax |
33-
| --------------| --------------|-----------|
34-
| `contains` | Returns `true` if an array field's value contains the specified value | `{% raw %}{{ contains(field, value) }}{% endraw %}` |
35-
| `ends_with` | Returns `true` if an a string field's value end with the specified string suffix | `{% raw %}{{ ends_with(field, suffix) }}{% endraw %}` |
36-
| `equals` | Returns `true` if an a string or number fields's value equals the specified value | `{% raw %}{{ equals(field, value) }}{% endraw %}` |
37-
| `exists` | Returns `true` if an the specified field exists | `{% raw %}{{ exists(struct, field) }}{% endraw %}` |
38-
| `is_null` | Returns `true` if a field's value is null | `{% raw %}{{ is_null(field) }}{% endraw %}` |
39-
| `matches` | Returns `true` if a field's value match the specified regex | `{% raw %}{{ matches(field, regex) }}{% endraw %}` |
40-
| `starts_with` | Returns `true` if an a string field's value start with the specified string prefix | `{% raw %}{{ starts_with(field, prefix) }}{% endraw %}` |
41-
30+
These conditional functions are available for use with the `if` config property :
31+
32+
| Function | Since | Description | Syntax |
33+
| --------------| --------| -------|-----------|
34+
| `and` | `2.4.0` | Checks if all of the given conditional expressions are `true`. | `{{ and(booleanExpression1, booleanExpression2, ...) }}` |
35+
| `contains` | | Returns `true` if an array field's value contains the specified value | `{{ contains(field, value) }}` |
36+
| `ends_with` | | Returns `true` if an a string field's value end with the specified string suffix | `{{ ends_with(field, suffix) }}` |
37+
| `equals` | | Returns `true` if an a string or number fields's value equals the specified value | `{{ equals(field, value) }}` |
38+
| `exists` | | Returns `true` if an the specified field exists | `{{ exists(struct, field) }}{% endraw %}` |
39+
| `gt` | `2.4.0` | Executes "*greater than operation*" on two values and returns `true` if the first value is greater than the second value, `false`, otherwise. | `{{ gt(expressionValue1, expressionValue2) }}` |
40+
| `is_null` | | Returns `true` if a field's value is null | `{{ is_null(field) }}` |
41+
| `lt` | `2.4.0` | Executes "*less than operation*" on two values and returns `true` if the first value is less than the second value, `false`, otherwise. | `{{ lt(expressionValue1, expressionValue2) }}` |
42+
| `matches` | | Returns `true` if a field's value match the specified regex | `{{ matches(field, regex) }}` |
43+
| `starts_with` | | Returns `true` if an a string field's value start with the specified string prefix | `{{ starts_with(field, prefix) }}` |
44+
| `or` | `2.4.0` | Checks if at least one of the given conditional expressions is `true`.. | `{{ or(booleanExpression1, booleanExpression2, ...) }}` |
4245

4346
**Limitations** :
44-
* `if` property does not support binary operator and then a single condition can be configured.
45-
* condition cannot be used to easily create pipeline branching.
47+
* conditions cannot be used to easily create pipeline branching.

site/content/en/docs/Developer Guide/file-readers.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
date: 2021-06-10
2+
date: 2021-09-30
33
title: "File Readers"
44
linkTitle: "File Readers"
55
weight: 40
@@ -82,12 +82,19 @@ The `<PREFIX>XMLFileInputReader`s can be used to read XML files.
8282

8383
### Configuration
8484

85-
| Configuration | Description | Type | Default | Importance |
86-
| --------------| --------------|-----------| --------- | ------------- |
87-
|`xpath.expression` | The XPath expression used extract data from XML input files | `String` | `/` | High |
88-
|`xpath.result.type` | The expected result type for the XPath expression in [NODESET, STRING] | `String` | `NODESET` | High |
89-
|`force.array.on.fields` | The comma-separated list of fields for which an array-type must be forced | `List` | `-` | High |
90-
85+
| Configuration | Since | Description | Type | Default | Importance |
86+
| --------------------------------------------------| --------|-------------| --------- | ------------- |-------------- |
87+
|`reader.xpath.expression` | | The XPath expression used extract data from XML input files | `String` | `/` | High |
88+
|`reader.xpath.result.type` | | The expected result type for the XPath expression in [NODESET, STRING] | `String` | `NODESET` | High |
89+
|`reader.xml.force.array.on.fields` | | The comma-separated list of fields for which an array-type must be forced | `List` | `-` | High |
90+
|`reader.xml.parser.validating.enabled` | `2.2.0` | Specifies that the parser will validate documents as they are parsed (default: false).";
91+
|`reader.xml.parser.namespace.aware.enabled` | `2.2.0` | Specifies that the XML parser will provide support for XML namespaces (default: false).";
92+
|`reader.xml.exclude.empty.elements` | `2.2.0` | Specifies that the reader should exclude element having no field (default: false).";
93+
|`reader.xml.exclude.node.attributes` | `2.4.0` | Specifies that the reader should exclude all node attributes (default: false).";
94+
|`reader.xml.exclude.node.attributes.in.namespaces` | `2.4.0` | Specifies that the reader should only exclude node attributes in the defined list of namespaces.";
95+
|`reader.xml.data.type.inference.enabled` | `2.3.0` | Specifies that the reader should try to infer the type of data nodes (default: false).";
96+
|`reader.xml.attribute.prefix` | `2.4.0` | If set, the name of attributes will be prepended with the specified prefix when they are added to a record (default: '').";
97+
9198
## XxxMetadataFileInputReader
9299

93100
The `FileInputMetadataReader`s can be used to send a single record per file containing metadata, i.e.: `name`, `path`, `hash`, `lastModified`, `size`, etc.

site/content/en/docs/Developer Guide/filters-chain-definition.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
date: 2020-05-21
2+
date: 2020-09-30
33
title: "Filter Chain Definition"
44
linkTitle: "Filter Chain Definition"
55
weight: 50
@@ -42,21 +42,25 @@ These filters are available for use with Kafka Connect File Pulse:
4242

4343
| Filter | Description | Since
4444
|--- | --- | --- |
45-
| [AppendFilter](../filters#appendfilter) | Appends one or more values to an existing or non-existing array field | |
46-
| [ConvertFilter](../filters#convertfilter) | Converts a message field's value to a specific type | |
47-
| [DateFilter](../filters#datefilter) | Converts a field's value containing a date to a unix epoch time | |
48-
| [DelimitedRowFilter](./filters#delimitedrowfilter) | Parses a message field's value containing columns delimited by a separator into a struct | |
49-
| [DropFilter](../filters#dropfilter) | Drops messages satisfying a specific condition without throwing exception. | |
50-
| [ExcludeFilter](../filters#excludeFilter) | Excludes one or more fields from the input record. | `v1.4.0` |
51-
| [ExplodeFilter](../filters#explodeFilter) | Explodes an array or list field into separate records. | `v1.4.0` |
52-
| [FailFilter](../filters#failfilter) | Throws an exception when a message satisfy a specific condition | |
53-
| [GrokFilter](../filters#grokfilter) | Parses an unstructured message field's value to a struct by combining Grok patterns | |
54-
| [GroupRowFilter](../filters#grouprowfilter) | Regroups multiple following messages into a single message by composing a grouping key| |
55-
| [JoinFilter](../filters#joinfilter) | Joins values of an array field with a specified separator | |
56-
| [JSONFilter](../filters#jsonfilter) | Unmarshallings a JSON message field's value to a complex struct | |
57-
| [MultiRowFilter](../filters#multirowfilter) | Combines following message lines into single one by combining patterns | |
58-
| [RenameFilter](../filters#renamefilter) | Renames a message field | |
59-
| [SplitFilter](../filters#splitfilter) | Splits a message field's value to array | |
45+
| [AppendFilter](../filters#appendfilter) | Appends one or more values to an existing or non-existing array field | |
46+
| [ConvertFilter](../filters#convertfilter) | Converts a message field's value to a specific type | |
47+
| [DateFilter](../filters#datefilter) | Converts a field's value containing a date to a unix epoch time | |
48+
| [DelimitedRowFilter](../filters#delimitedrowfilter) | Parses a message field's value containing columns delimited by a separator into a struct | |
49+
| [DropFilter](../filters#dropfilter) | Drops messages satisfying a specific condition without throwing exception. | |
50+
| [ExcludeFilter](../filters#excludefilter) | Excludes one or more fields from the input record. | `v1.4.0` |
51+
| [ExplodeFilter](../filters#explodefilter) | Explodes an array or list field into separate records. | `v1.4.0` |
52+
| [FailFilter](../filters#failfilter) | Throws an exception when a message satisfy a specific condition | |
53+
| [GrokFilter](../filters#grokfilter) | Parses an unstructured message field's value to a struct by combining Grok patterns | |
54+
| [GroupRowFilter](../filters#grouprowfilter) | Regroups multiple following messages into a single message by composing a grouping key| |
55+
| [JoinFilter](../filters#joinfilter) | Joins values of an array field with a specified separator | |
56+
| [JSONFilter](../filters#jsonfilter) | Unmarshallings a JSON message field's value to a complex struct | |
57+
| [MoveFilter](../filters#movefilter) | Moves an existing record field's value to a specific target path | `v1.5.0` |
58+
| [MultiRowFilter](../filters#multirowfilter) | Combines following message lines into single one by combining patterns | |
59+
| [NullValueFilter](../filters#nullvaluefilter) | Combines following message lines into single one by combining patterns | `v2.3.0` |
60+
| [RenameFilter](../filters#renamefilter) | Renames a message field | |
61+
| [SplitFilter](../filters#splitfilter) | Splits a message field's value to array | |
62+
| [XmlToJsonFilter](../filters#xmltojsonfilter) | Parses an XML record-field and convert it to a JSON string | `v2.4.0` |
63+
| [XmlToStructFilter](../filters#xmltostructfilter) | Parses an XML record-field into STRUCT | `v2.4.0` |
6064

6165
## Difference between Kafka Connect Single Message Transforms (SMT) functionality
6266

0 commit comments

Comments
 (0)