Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update formula.adoc with better formatting #3255

Merged
merged 4 commits into from
Oct 13, 2023
Merged

Update formula.adoc with better formatting #3255

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d8ed45e
Update formula.adoc with better formatting
Mattang-Dan Sep 26, 2023
c0de3fa
Update formula.adoc
Mattang-Dan Sep 26, 2023
f724e35
Update formula.adoc with a TIP and clarifications
Mattang-Dan Sep 26, 2023
ae09b54
Update formula.adoc
Mattang-Dan Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/formula.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,20 @@ under the License.

The Formula transform allows you to apply Excel-like formulas and functions on fields in a pipeline.


With a formula you are not limited to comparing to three fields like in the Calculator. This is where you can set and compare Date and Times as well.

You have the option of creating a new field (use New field column) or replacing a field (use Replace value column).

You have the option of creating a new field (use New field column) or setting a field value (use Replace value column).

TIP: The formula will not evaluate a field unless the field pre-exists. Either start the execution of that pipeline to create missing fields or check if the field exists by viewing fields in the Replace value dropdown.

Formula Examples using the TEXT function:

* Int to Text: "size=" & TEXT([RowLimitInteger],"0").

* DateTime to Text: [StartDateField] & "=" & TEXT([StartDateTime], "yyyy-mm-dd")

* String to Text: "new_counter=" & TEXT([counter]+1, "0")

|
Expand All @@ -64,13 +71,13 @@ Formula Examples using the TEXT function:
|===
|Option|Description
|transform name|Change the name of this transform to explain the purpose of the formula fields you're adding.
|New Field|the name of the new field that will be created from the formula. The Formula transform requires a data row to create a new field. You can add a row generator with a single row as the first transform in your pipeline.
|New Field|the name of the new field that will be created from the formula. The Formula transform requires a data row to create a new field. If needed, you can add a row generator with a single row as the first transform in your pipeline.
|Formula|the formula that will be used to create the new field. Click on the field to open the Formula Editor (see the Formula Editor section for more details). To use a value from a data row field, use square brackets like [field1]. To use a parameter or variable, use the normal syntax ${param1}. If you use a parameter in place of text like with CONCATENATE (see samples) you must put double quotes around it. Example: CONCATENATE([field1], “${Param1}”)
* Note: You may have to add quotes around variables in formulas as variables have no type.
|Value type|the data type for the new formula field
|Length|field length
|Precision|field precision
|Replace value|select a pipeline field from the dropdown to replace that field's value with the formula result. Alteratively, you can pre-create the field with a NULL value in a “Get variables” transform.
|Replace value|select a pipeline field from the dropdown to replace that field's value with the formula result. It is not recommended to pre-create a field with a NULL value in a "Get variables" transform as that is considered a hack and is not supported behavior.
|===

== Formula Editor
Expand Down