Data Manipulation Functions
A data manipulation function changes the data into the format required by the data serialization function (see the next section). You can apply a manipulation function on the results from a data selection or other data manipulation function. If the input data is null
, the manipulation function returns null
, unless otherwise specified.
If data manipulation isn’t required, add a data serialization function to the results of the data selection functions.
Returns the first non-null source from a list of sources. Useful for providing a default value in case a function returns a null value.
Argument | Description |
---|---|
source | (Required) Source can be the results of a data selection or other data manipulation function. The source can have any shape. |
Function:
Output:
The output is the result returned by cell(step1.selection, 0, "column1")
. However, if cell(step1.selection, 0, "column1")
returns null
, then the output is
See Also
Joins streams from multiple sources into a one- or two-dimensional array. Null sources are skipped.
Argument | Description |
---|---|
source | (Required) Each source can be the results of a data selection or other data manipulation function. Each source must be either a one- or two-dimensional array. An error occurs if you try to concatenate data from sources of different shapes. For example, the following function produces an error: concat(["a", "b"], ["c", "d", "e"]) . |
Function:
Output:
Function:
Output:
Flattens a two-dimensional array into a one-dimensional array.
Argument | Description |
---|---|
source | (Required) Source can be the results of a data selection or other data manipulation function. The source must be a two-dimensional array. Otherwise, an error occurs because there’s no reason to flatten a one-dimensional array or scalar. |
Function:
Output:
Converts a one- or two-dimensional array into a string by joining the elements using the specified token. An error occurs if the data has any other shape.
Argument | Description |
---|---|
source | (Required) Source can be the results of a data selection or other data manipulation function. The source must be a two-dimensional array. Otherwise, an error occurs. |
token | (Required) Any string value, like + or , . |
Function:
Output:
Function:
Output:
Selects one or more values from a one-dimensional array given a start and, optionally, an end position, and returns a one-dimensional array. An error occurs if the start value is greater than the end value. Negative indices are supported.
Argument | Description |
---|---|
source | (Required) Source can be the results of a data selection or other data manipulation function. The source can have any shape. |
start | (Required) Index that identifies the start value in the array. For example, 0 represents the first element in the array. |
end | (Optional) Index that identifies the end value in the array. |
Returns the last selected row.
Converts scalars to a one-dimensional array, and one-dimensional arrays to a two-dimensional array. For example, use this function to convert the scalar result of a cell function to an array, which is required by compact-form measures, groups, and order clauses. The function returns an error if the input is a series of static one-dimensional arrays, a two-dimensional array, or a mix of scalars and one-dimensional arrays.
Argument | Description |
---|---|
source | (Required) The input must be scalars, including static values, or one-dimensional arrays. |
Consider these Opportunities query result.
Oppty_Name | Owner | Region | Amount | Created_Date |
---|---|---|---|---|
Alpha | Danny | Americas | 1000 | 2/20/2017 |
Bravo | Danny | Americas | 500 | 4/15/2017 |
Charlie | Jeff | EMEA | 2000 | 5/1/2017 |
These interactions use the Opportunities query as a source.
Interaction | Result |
---|---|
toArray( cell(Opportunities.selection, 0, "Region") ) | ["Americas"] |
toArray( "EMEA" ) | ["EMEA"] |
toArray( cell(Opportunities.selection, 0, "Region"), "EMEA" ) | ["Americas", "EMEA"] |
toArray( column(Opportunities.selection, ["Oppty_Name"]), column(Opportunities.selection, ["Region] ) | [["Alpha", "Bravo", "Charlie"], ["Americas", "Americas", "EMEA"]] |
toArray( column(Opportunities.selection, ["Oppty_Name", "Region"]) ) | Error. The column interaction function returns a two-dimensional array, which is an invalid input. |
toArray( [1, 2, 3], [4, 5, 6] ) | Error. The input can't be a series of static one-dimensional arrays. |
Returns the single scalar value at the given index.
Argument | Description |
---|---|
source | (Required) Source can be the results of a data selection or other data manipulation function. The source can have any shape. |
index | (Required) Negative indexes are supported. If you specify an index that doesn't exist, the function returns null. |
Returns the last selected value.