Value functions

Values

Function Description
Value.Compare Returns 1, 0, or -1 based on value1 being greater than, equal to, or less than the value2. An optional comparer function can be provided.
Value.Equals Returns whether two values are equal.
Value.NativeQuery Evaluates a query against a target.
Value.NullableEquals Returns a logical value or null based on two values .
Value.Type Returns the type of the given value.

Arithmetic operations

Function 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

Type Description
Value.As Value.As is the function corresponding to the as operator in the formula language. The expression value as type asserts that the value of a value argument is compatible with type as per the is operator. If it is not compatible, an error is raised.
Value.Is Value.Is is the function corresponding to the is operator in the formula language. The expression value is type returns true if the ascribed type of vlaue is compatible with type, and returns false if the ascribed type of value is incompatible with type.
Value.ReplaceType A value may be ascribed a type using Value.ReplaceType. Value.ReplaceType either returns a new value with the type ascribed or raises an error if the new type is incompatible with the value’s native primitive type. In particular, the function raises an error when an attempt is made to ascribe an abstract type, such as any. When replacing a the type of a record, the new type must have the same number of fields, and the new fields replace the old fields by ordinal position, not by name. Similarly, when replacing the type of a table, the new type must have the same number of columns, and the new columns replace the old columns by ordinal position.
Implementation Description
DirectQueryCapabilities.From DirectQueryCapabilities.From
Embedded.Value Accesses a value by name in an embedded mashup.
Value.Firewall Value.Firewall
Variable.Value Variable.Value
SqlExpression.SchemaFrom SqlExpression.SchemaFrom
SqlExpression.ToExpression SqlExpression.ToExpression

Metadata

Function 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.