REFERENCE
U.COMPARE
Summary
Returns the result of a comparing input subject to specified comparator using specified algorithm
Syntax
Parameters
| Parameter | Required | Description |
|---|---|---|
subject |
Yes | The value(s) whose to be compared with the comparand |
comparand |
Yes | The value against which the subject(s) will be compared |
[algorithm] |
No | The type of comparison. Currently only "edit_distance" and range comparisons are supported, but other comparison algorithms will be added over time. A sort order comparison is performed if not specified |
[parameter] |
No | A parameter passed to the comparison algorithm |
[parameter] |
No | An additional parameter passed to the comparison algorithm |
[parameter] |
No | An additional parameter passed to the comparison algorithm |
Behavior
The documented public interface is supported by the current U Add-in source signature and the maintained Usage Examples workbook. Optional parameters are shown in square brackets in the syntax above; omit the brackets when entering a formula.
Return Value
Returns the function result or action status described by the formula and parameters above. The maintained sources do not define a narrower, stable return contract for this function.
Examples
Notes
- Formula examples are preserved from maintained workbook usage and normalized to the current
U.prefix. - Complete formulas demonstrate working patterns; they do not imply that undocumented option values are supported.
- Where maintained sources do not specify every accepted value, default, or error message, this page does not infer one.
- For functions that perform actions, use a visible trigger or supported block/throttle parameter to avoid unintended repetition during recalculation.
Related
- How-to: Process CSV Files
- Example: CSV Processing Pipeline