This is an automated email from the ASF dual-hosted git repository.
hansva 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 a53166ff33 Update getvariable.adoc
new 1d98f33c04 Merge pull request #3182 from Mattang-Dan/patch-6
a53166ff33 is described below
commit a53166ff33c5491153ccb18acc6fcc968821c9d2
Author: Mattang-Dan <[email protected]>
AuthorDate: Tue Aug 29 13:56:13 2023 -0700
Update getvariable.adoc
---
.../modules/ROOT/pages/pipeline/transforms/getvariable.adoc | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/getvariable.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/getvariable.adoc
index 2f08cb6bbf..4783ecfdc8 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/getvariable.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/getvariable.adoc
@@ -27,10 +27,19 @@ under the License.
|
== Description
-The Get Variables transform allows you to get the value of a variable and
returns rows or adds values to existing input rows.
+The Get Variables transform allows you to get the value of a variable and
create field(s) from it or allows you to add values to existing input rows. You
could consider it to be a "Set fields” transform. It can retrieve the value of
a previous variable and/or retrieves previous rows or you can set static values
to a variable or input rows. You only need to use this transform if you need
the variable value in a field.
+
+Note that workflow/environment variables are set only once. A pipeline needs
to start to get any new variables. A running or sequential or nested (nested
pipelines are technically the same pipeline) pipeline can't fetch new variable
values. A pipeline is considered started when a pipeline starts for every row
in a pipeline executor.
+
+You can always refer to variables/parameters using the syntax: ${myVariable},
for example from a previous pipeline.
For example, you can specify:
${openvar}java.io.tmpdir{closevar}/hop/tempfile.txt and it will be expanded to
/tmp/hop/tempfile.txt on Unix-like systems.
+You must always specify the data type or you will have errors like the
following:
+ 2023/07/21 09:30:23 - REST client.0 - ERROR: Because of an error, this
transform can't continue:
+ 2023/07/21 09:30:23 - REST client.0 - TOKEN_URL None : Unknown type 0
specified.
+ 2023/07/21 09:30:23 - REST client.0 - ERROR:
org.apache.hop.core.exception.HopValueException:
+
See also the Set Variables transform.
To convert the Variable into a data type other than String use Select Values -
Meta Data tab.
To get system values, including command line arguments, use the Get System
Info transform.
@@ -74,4 +83,4 @@ For example, $10,000.00 or E5.000,00.
== Metadata Injection Support
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.
\ No newline at end of file
+You can use this transform with ETL Metadata Injection to pass metadata to
your pipeline at runtime.
