Differences

This shows you the differences between two versions of the page.

--- syntax:functions:columnexists [2020/07/06 07:07] – created dmitry
+++ syntax:functions:columnexists [2021/09/12 11:29] (current) – [Examples] craigt
@@ Line 1: / Line 1: @@
-====== ColumnExists(text) ======
+====== ColumnExists(col_name) ======
+Category:  Special function
-Returns TRUE if the input dataset of the current action contains a column with provided name, otherwise returns FALSE.
+\\
+=====Description=====
+This function tests whether a column named //col_name// exists in the input dataset.  TRUE is returned if the named column exists, otherwise, FALSE is returned.
-Example:
+\\
+=====Arguments=====
+^Argument^Type^Description^
+|col_name|Text  |The name of a column to test for within the input dataset.  |
-Let's assume the input dataset is as below.
+**Return value type:** Boolean (TRUE/FALSE)
+\\
+=====Remarks=====
+This function is case sensitive.
+\\
+=====Examples=====
+\\
+**Sample dataset:**
 ^ Amount  ^ Description ^
 |  200 | Product A  |
 |  3000| Product B  |
+Given the dataset above, ColumnExists() would return the following results:
+  columnexists('Description') = TRUE
+  columnexists('description') = FALSE  //Function is case-sensitive
+  columnexists('Price') = FALSE
-Then the function would return the following results:
-^ Expression  ^ Result^
-|columnexists('Description')   | TRUE |
-|columnexists('Price')      | FALSE |