Value functions
- Article
-
-
These functions evaluate and perform operations on values.
Name |
Description |
Value.Alternates |
Expresses alternate query plans. |
Value.Compare |
Returns -1, 0, or 1 based on whether the first value is less than, equal to, or greater than the second. |
Value.Equals |
Returns whether two values are equal. |
Value.Expression |
Returns an abstract syntax tree (AST) that represents the value's expression. |
Value.VersionIdentity |
Returns the version identity of a value. |
Value.Versions |
Returns a navigation table containing the available versions of a value. |
Value.NativeQuery |
Evaluates a query against a target. |
Value.NullableEquals |
Returns a logical value or null based on two values. |
Value.Optimize |
If value represents a query that can be optimized, returns the optimized query. Otherwise returns value. |
Value.Type |
Returns the type of the given value. |
Arithmetic operations
Name |
Description |
Value.Add |
Returns the sum of the two values. |
Value.Divide |
Returns the result of dividing the first value by the second. |
Value.Multiply |
Returns the product of the two values. |
Value.Subtract |
Returns the difference of the two values. |
Parameter types
Name |
Description |
Value.As |
Returns the value if it is compatible with the specified type. |
Value.Is |
Determines whether a value is compatible with the specified type. |
Value.ReplaceType |
Replaces the value's type. |
Name |
Description |
Value.Metadata |
Returns a record containing the input’s metadata. |
Value.RemoveMetadata |
Removes the metadata on the value and returns the original value. |
Value.ReplaceMetadata |
Replaces the metadata on a value with the new metadata record provided and returns the original value with the new metadata attached. |
Lineage
Name |
Description |
Graph.Nodes |
This function is intended for internal use only. |
Value.Lineage |
This function is intended for internal use only. |
Value.Traits |
This function is intended for internal use only. |