This is an automated email from the ASF dual-hosted git repository.

bamaer pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hop.git


The following commit(s) were added to refs/heads/main by this push:
     new bf6ae34079 Transform pages: Samples section for Delay row to File 
exists, addresses #9469 (#9495)
bf6ae34079 is described below

commit bf6ae340799e75d5795b04faafc9b998fc8a7e43
Author: Adalennis <[email protected]>
AuthorDate: Mon Nov 16 14:05:43 2026 +0100

    Transform pages: Samples section for Delay row to File exists, addresses 
#9469 (#9495)
---
 .../modules/ROOT/pages/pipeline/transforms/delay.adoc               | 6 +++++-
 .../modules/ROOT/pages/pipeline/transforms/delete.adoc              | 4 ++++
 .../modules/ROOT/pages/pipeline/transforms/detectemptystream.adoc   | 4 ++++
 .../modules/ROOT/pages/pipeline/transforms/dimensionlookup.adoc     | 5 +++++
 .../modules/ROOT/pages/pipeline/transforms/dynamicsqlrow.adoc       | 6 +++++-
 .../modules/ROOT/pages/pipeline/transforms/edi2xml.adoc             | 4 ++++
 .../modules/ROOT/pages/pipeline/transforms/emailinput.adoc          | 5 +++++
 .../modules/ROOT/pages/pipeline/transforms/enhancedjsonoutput.adoc  | 4 ++++
 .../modules/ROOT/pages/pipeline/transforms/excelinput.adoc          | 6 ++++++
 .../modules/ROOT/pages/pipeline/transforms/excelwriter.adoc         | 4 ++++
 .../modules/ROOT/pages/pipeline/transforms/execinfo.adoc            | 3 +++
 .../modules/ROOT/pages/pipeline/transforms/execprocess.adoc         | 4 ++++
 .../modules/ROOT/pages/pipeline/transforms/execsql.adoc             | 4 ++++
 .../modules/ROOT/pages/pipeline/transforms/execsqlrow.adoc          | 6 +++++-
 .../modules/ROOT/pages/pipeline/transforms/exectests.adoc           | 6 +++++-
 .../modules/ROOT/pages/pipeline/transforms/fake.adoc                | 4 ++++
 .../modules/ROOT/pages/pipeline/transforms/fileexists.adoc          | 4 ++++
 17 files changed, 75 insertions(+), 4 deletions(-)

diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/delay.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/delay.adoc
index ab382407d2..805e6ac066 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/delay.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/delay.adoc
@@ -37,4 +37,8 @@ Use this transform if you deliberately want to slow down your 
pipeline.
 |Time scale|Select whether the timeout is expressed in milliseconds, seconds, 
minutes, or hours.
 |Get time scale from field|Enable this option to pick the time scale from a 
field in the incoming stream.
 |Time scale field|Field that contains the time scale value. Accepted values 
(case-insensitive) are: `ms`, `millisecond(s)`, `s`, `second(s)`, `m`, 
`minute(s)`, `h`, `hour(s)`. Empty values default to seconds.
-|===
\ No newline at end of file
+|===
+
+== Samples
+
+The samples project has `transforms/delay-row-basic.hpl`, which delays each of 
10 generated rows by 5 seconds, so a line appears in the log every 5 seconds.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/delete.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/delete.adoc
index 39b5495408..78182d90da 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/delete.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/delete.adoc
@@ -43,3 +43,7 @@ This is important for data sources that allow for table names 
with periods in th
 |Commit size|The number of rows to change (insert / update) before running a 
commit.
 |The keys(s) to look up the value(s)|Specify fields to delete the 
corresponding rows for
 |===
+
+== Samples
+
+The samples project has `transforms/delete.hpl`, which deletes the employees 
with `id` 1 and 2 from the `employees` table of the `hop-samples` connection.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/detectemptystream.adoc
 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/detectemptystream.adoc
index fe69079212..2d75127372 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/detectemptystream.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/detectemptystream.adoc
@@ -37,3 +37,7 @@ If the input stream is not empty it will not output anything.
 This name must be unique throughout the pipeline.
 |===
 
+== Samples
+
+The samples project has `transforms/detect-empty-stream-basic.hpl`: Get file 
names looks for a file that doesn't exist, so Detect empty stream passes on one 
row with null values for the Get file names fields.
+The *No files found!* error in the log comes from Get file names and doesn't 
stop the pipeline.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/dimensionlookup.adoc
 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/dimensionlookup.adoc
index ae6da47b67..7d09ad19cc 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/dimensionlookup.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/dimensionlookup.adoc
@@ -189,3 +189,8 @@ The result can be one of the following situations:
 ** Stream date field" cannot be before the earliest start date of the 
currently valid rows.
 ** select min(date_from) from dim_table where date_to = "2199-12-31 
23:59:59.999"
 ** It is important to ensure that the incoming rows are sorted by the "Stream 
date field"
+
+== Samples
+
+The samples project has `transforms/dimensionlookup-basic.hpl`, which loads 
five rows for three customers into the `dim_sample` dimension of the 
`hop-samples` connection.
+A new `street`, `number` or `zip` adds a version, a new `name` is written to 
every version (punch through), and a new `city` only changes the latest version.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/dynamicsqlrow.adoc
 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/dynamicsqlrow.adoc
index cb933956a8..fdd37c62c4 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/dynamicsqlrow.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/dynamicsqlrow.adoc
@@ -42,4 +42,8 @@ The lookup values returned by the transform are added as new 
fields onto the str
 |Query only on parameters change|If your SQL statements do not change a lot, 
check this option to reduce the number of physical database queries.
 |Template SQL|In Hop meta and data are separate so you have to specify the 
meta part in template SQL (field name and type).
 I mean any statement that returns the same row structure.
-|===
\ No newline at end of file
+|===
+
+== Samples
+
+The samples project has `transforms/dynamic-sql-row.hpl`, which finds the 
tables with an `ID` column in the `PUBLIC` schema of the `hop-samples` 
connection, builds a query for each table in a JavaScript transform, and writes 
each table name and id to the log.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/edi2xml.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/edi2xml.adoc
index e861480cb3..7415e0f727 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/edi2xml.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/edi2xml.adoc
@@ -54,3 +54,7 @@ The conversion rules are:
 * each segment in the edifact message is converted to a tag, using the segment 
name as the tag name.
 * each field within a segment is represented by an "element" tag
 * each value within a field is represented by an "value" tag
+
+== Samples
+
+The samples project has `transforms/edi-to-xml.hpl`, which loads 
`files/edi-to-xml.txt` into a field and converts that EDI message to XML in the 
field `xml`.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/emailinput.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/emailinput.adoc
index 2440666325..d1e9cec907 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/emailinput.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/emailinput.adoc
@@ -99,3 +99,8 @@ Mail for which the header matches your filter will be 
retrieved, the rest is ign
 |Option|Description
 |Sender (FROM)|Only retrieve
 |===
+
+== Samples
+
+The samples project has `transforms/email-messages-input.hpl`, which reads the 
messages in the `INBOX` folder of a mail server and its subfolders.
+Create a mail server connection named `sample-mail` before you run it.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/enhancedjsonoutput.adoc
 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/enhancedjsonoutput.adoc
index bd58cd11ba..237305aadf 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/enhancedjsonoutput.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/enhancedjsonoutput.adoc
@@ -173,3 +173,7 @@ The sample writes this value.
 ----
 
{"results":[{"campo1":"C","details":[{"campo2":"B","campo3":"7"},{"campo2":"F","campo3":"5"},{"campo2":"F","campo3":"6"},{"campo2":"V","campo3":"6"}]},{"campo1":"B","details":[{"campo2":"C","campo3":"1"},{"campo2":"C","campo3":"2"},{"campo2":"D","campo3":"4"}]},{"campo1":"A","details":[{"campo2":"B","campo3":"1"},{"campo2":"B","campo3":"2"}]}]}
 ----
+
+== Samples
+
+The samples project has 
`transforms/json-output-generate-nested-structure.hpl`: a first Enhanced JSON 
output groups the `field2` and `field3` values of nine rows by `field1`, and a 
second one puts those groups as `details` in a single `results` JSON value.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/excelinput.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/excelinput.adoc
index 2eca8a45de..af1934882e 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/excelinput.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/excelinput.adoc
@@ -152,3 +152,9 @@ Some of these are missing.
 |Root uri field|The field name that contains only the root part of the URI.
 |===
 
+== Samples
+
+The samples project has:
+
+* `transforms/microsoft-excel-input.hpl`, which reads the `id`, `title` and 
`author` of two books from the `Books` sheet of 
`files/microsoft-excel-input.xlsx`.
+* `pipelines/read-transactions.hpl`, which reads the files in 
`pipelines/input/` that match the regular expression `file-.*.xlsx`, and uses 
the sheet row number to split the header row of each file from its data rows.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/excelwriter.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/excelwriter.adoc
index b0b75ef0ae..450d108b1f 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/excelwriter.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/excelwriter.adoc
@@ -178,3 +178,7 @@ Known differences:
 * *Sheet protection* — Uses ODF `table:protected` with SHA-1 password hash 
(LibreOffice Calc compatible). The *protected by user* field is not used for 
`.ods`.
 * *Streaming* — The *Stream XLSX data* option applies to `.xlsx` only.
 * *Sheet names* — The 31-character Excel sheet name limit is not enforced for 
`.ods`.
+
+== Samples
+
+The samples project has `transforms/microsoft-excel-writer.hpl`, which writes 
two books from a Data grid to the `Books` sheet of 
`output/microsoft-excel-writer.xlsx`.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execinfo.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execinfo.adoc
index 366536f0cf..e4a0efb3b2 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execinfo.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execinfo.adoc
@@ -125,3 +125,6 @@ If no execution matches, the transform writes no output row 
for that input.
 
 *Find previous successful execution* is the operation to use for incremental 
extracts: it answers “when did this workflow or pipeline last succeed?” so a 
xref:pipeline/transforms/tableinput.adoc[Table Input] can filter on a timestamp 
or increasing ID. How to wire that (or write the watermark yourself on the 
success path) is in xref:how-to-guides/cdc-filtered-selection.adoc[CDC: 
filtered selection].
 
+== Samples
+
+The samples project has `transforms/execution-information.hpl`, which lists up 
to 10 execution IDs from the execution information location `local`.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execprocess.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execprocess.adoc
index b10ada480e..02dbf6f620 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execprocess.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execprocess.adoc
@@ -97,3 +97,7 @@ If you have a pipeline that relies on quote characters 
reaching the process as-i
 Enable *Arguments in fields* when you would rather not rely on quoting at all, 
or when an argument contains characters that are awkward to quote.
 The process field then holds only the executable and each *Argument fields* 
entry is passed as one argument exactly as it is, with no splitting and no 
quote removal.
 This is the most reliable option for values that come from your data, such as 
file paths built at runtime.
+
+== Samples
+
+The samples project has `transforms/execute-a-process.hpl`, which runs `echo` 
with the arguments `hello` and `world` from two fields and puts `hello world` 
in the field `output` and the exit value in `Exit value`.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execsql.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execsql.adoc
index de205b24cc..85a8a47113 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execsql.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execsql.adoc
@@ -103,3 +103,7 @@ 
image:transforms/execute-sql-script-dialog-parameters-tab.png[Execute SQL script
 |Parameters|The list of parameters that will replace the question marks in the 
query in the given order.
 So the first question mark will be replaced by the first parameter, the second 
question mark by the second parameter etc.
 |===
+
+== Samples
+
+The samples project has `transforms/execute-sql-script.hpl`, which runs a 
`CREATE TABLE IF NOT EXISTS employees` statement once through the `hop-samples` 
connection.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execsqlrow.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execsqlrow.adoc
index 199eb8ddad..4e8e2923fe 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execsqlrow.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/execsqlrow.adoc
@@ -51,4 +51,8 @@ The same counts show up in the transform's own metrics: read 
rows as input (I),
 == Notes
 
 Because of the scripting/dynamic nature of the transform, it does not use 
prepared statements and thus is not intended to work fast or optimal.
-For good performance turn to dedicated transforms like Table Output (insert 
into), Table Input (Select), Update, Delete, etc.
\ No newline at end of file
+For good performance turn to dedicated transforms like Table Output (insert 
into), Table Input (Select), Update, Delete, etc.
+
+== Samples
+
+The samples project has `transforms/execute-row-sql-script.hpl`, which runs 
the `DELETE` and the `UPDATE` statement in the two rows of a Data grid against 
the `employees` table of the `hop-samples` connection, and adds to each row the 
number of rows the statement updated, inserted, deleted and read.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/exectests.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/exectests.adoc
index 5beb2feaeb..144ed3fd4e 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/exectests.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/exectests.adoc
@@ -40,4 +40,8 @@ This option is only available when the transform receives 
input.
 |transform output field name|the transform that is used in this test
 |Error output field name|error status (Y or N)
 |Comment output field name|the comment or error message returned by the test
-|===
\ No newline at end of file
+|===
+
+== Samples
+
+The samples project has `transforms/execute-unit-tests.hpl`, which runs the 
unit test `run-pipeline-tests-unit` and returns one row for the check against 
its golden data set and one for the test as a whole.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/fake.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/fake.adoc
index 77394859aa..1b70a976a0 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/fake.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/fake.adoc
@@ -398,3 +398,7 @@ For instance, we could generate some random Pokémon data.
 - en-US
 - nl
 - ...
+
+== Samples
+
+The samples project has `transforms/fake-data-generate-person-record.hpl`, 
which generates 1,000 fake person records: a name, a birthday, a blood group, a 
credit card number, a cell phone number, a favourite book, a workplace, a 
programming language, a digit and a random number.
diff --git 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/fileexists.adoc 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/fileexists.adoc
index 45eed01276..4306608c1f 100644
--- 
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/fileexists.adoc
+++ 
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/fileexists.adoc
@@ -39,3 +39,7 @@ The transform outputs a boolean flag field, indicating 
whether a file exists or
 |Include file type|Include the file type in a field.
 |File type field|The name of the field that will contain the file type as a 
String: "file", "folder", "imaginary"
 |===
+
+== Samples
+
+The samples project has `transforms/file-exists-basic.hpl`, which checks 
whether `files/customers-100.txt` exists, adds the result and the file type, 
and writes the row to the log through *log exists* or *log does not exist*.

Reply via email to