This is an automated email from the ASF dual-hosted git repository.
usbrandon pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hop.git
The following commit(s) were added to refs/heads/master by this push:
new 0b97c9fc97 Update filterrows.adoc
new 9e49fe59ca Merge pull request #3482 from Mattang-Dan/patch-63
0b97c9fc97 is described below
commit 0b97c9fc973e4881089923b82d0e9d088b97243f
Author: Mattang-Dan <[email protected]>
AuthorDate: Tue Dec 5 10:20:01 2023 -0800
Update filterrows.adoc
---
.../ROOT/pages/pipeline/transforms/filterrows.adoc | 22 ++++++++++++++++++++--
1 file changed, 20 insertions(+), 2 deletions(-)
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/filterrows.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/filterrows.adoc
index f4ed8dafde..d533957186 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/filterrows.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/filterrows.adoc
@@ -39,11 +39,26 @@ The Filter Rows transform allows you to filter rows based
on conditions and comp
!===
|===
+== Usage
Once this transform is connected to a previous transform (one or more and
receiving input), you can click on the "<field>", "=" and "<value>" areas to
construct a condition. Downstream transforms can be connected to the True or
False hop.
+Right-click a condition to edit, delete, move, or add a sub-condition.
+
+You can use a REGEX expression in the "filter row" transform. See “Filter
Rows” under the Transforms section for more.
+
TIP: To enter an IN LIST operator, use a string value separated by semicolons.
-TIP: Lists also works on numeric values like integers. In this case, the list
of values must be entered with a string data type, e.g.: 2;3;7;8.
+TIP: Lists also works on numeric values like integers. In this case, the list
of values must be entered with a string data type, e.g.: 2;3;7;8.
+
+Remember that all transforms are executed in parallel, so both true and false
paths will run in some cases.
+
+The filter rows transform detects only fields in the input stream. If you want
to filter rows based on a variable value, you can modify the previous
transform. For example, a table input transform can include the variable in the
SQL as another field such as “select field1, field2, ${myvar} as field3 from
table1”, then in the filter row condition you can say field1 = field3.
Alternatively, you can use a ‘Get Variables’ transform to set parameters in
fields. There are various SQL query sta [...]
+
+An example is found in the samples project called “filter-rows-basic.hpl”.
+
+If you cannot select the field you would like because it does not exist yet
because of metadata injection, see this doc:
https://hop.apache.org//manual/latest/pipeline/transforms/filterrows.html#_mdi_example
and the example in the samples project:
metadata-injection/filter-rows-mdi-parent.hpl.
+
+Essentially, to use an MDI field that is not selectable yet (say in a Filter
rows transform), you can setup a transform with a similar field and with a
similar condition. Then open the pipeline in a text editor and update the field
name to the MDI field name that does not exist yet.
== Options
@@ -109,7 +124,10 @@ To filter special characters like explicit EOF (e.g. from
old cobol files) Use a
All fields of this transform support metadata injection.
You can use this transform with ETL Metadata Injection to pass metadata to
your pipeline at runtime.
-If you cannot select the field you would like because it does not exist yet
because of metadata injection, see this doc:
https://hop.apache.org//manual/latest/pipeline/transforms/filterrows.html#_mdi_example
and this example in the samples project:
metadata-injection/filter-rows-mdi-parent.hpl
+If you cannot select the field you would like because it does not exist yet
because of metadata injection, see this doc:
https://hop.apache.org//manual/latest/pipeline/transforms/filterrows.html#_mdi_example
and this example in the samples project:
metadata-injection/filter-rows-mdi-parent.hpl.
+
+Essentially, to use an MDI field that is not selectable yet (say in a Filter
rows transform), you can setup a transform with a similar field and with a
similar condition. Then open the pipeline in a text editor and update the field
name to the MDI field name that does not exist yet.
+
== Special considerations for the condition field