Data Transform Listing

These are the transformation functions available in the data source ingress API. These functions can be used to transform and validate your data before you publish your dataset for consumption.

These functions apply in the “Data Transforms” editor in the ingress UI.

See the Apiary Page for the data source ingress API for how to use the transform functions as an API user.

Function Name Description
+ Add two numbers together
|| concatenate two strings
/ Divide a number by another
== Return true if the left side equals the right
= Return true if the left side equals the right
^ No documentation is available.
> Return true if the value on the left is greater than the value on the right
>= Return true if the value on the left is greater than or equal to the value on the right
< Return true if the value on the left is less than the value on the right
<= Return true if the value on the left is less than or equal to the value on the right
% Find the remainder(modulus) of one number divided by another
* Multiply two numbers together
!= Return true if the left side does not equal the right
<> Return true if the left side does not equal the right
- Subtract a number from another
and Logical and of two boolean values
between Return true if the left is within the range of the right values
case Evaluate a series of true/false expressions (predicates) and return the next consequent.
coalesce Take the leftmost non-null value.
contains tell whether or not a string contains another string
ensure_within ensure_within is a function which takes a point and a multipolygon
error Make an error. This is useful in conjunction with a case function,
forgive Turn an error into a null value. This is useful if you have a transformation
geocode geocode is a function which takes human readable addresses
geocode_esri geocode_esri is a function which takes human readable addresses
http_get Make an HTTP Get request to a URL. The response is returned. If the server
in Whether or not a value is in a set of other values
is_not_null Whether or not a value is not null
is_null Whether or not a value is null
is_within is_within is a function which takes a point and a multipolygon
json_pluck Pluck a value out of a JSON string. The returned value may be a primitive like a
like If a string is like another string.
location_to_point Turn a location value into a point
lower lowercase a string
make_location make_location makes a location column from human readable
make_point function to make a point out of a Y (latitude) and X (longitude) coordinate.
not Invert a boolean
not_between Return true if the left is not within the range of the right values
not_in Whether or not a value is absent from a set of other values
not_like If a string is not like another string.
or Logical or of two boolean values
regex_capture function to capture a piece of text based on a regular expression
regex_named_capture capture a piece of text based on a regular expression
regex_replace function to replace a piece of text based on a regular expression
replace replace text with another piece of text
replace_first replace the first occurrence of a piece of text with another piece of text
reproject reproject a geometry from one projection to another.
reproject_to_wgs84 function to reproject a geometry to WGS84. This will allow the geometry
set_projection function to explicitly set the projection value on geometries which do not have projection
split_select function to split a piece of text on a token, and then select
starts_with tell whether or a not a string is prefixed with another string
state_boundary returns the boundary of the US state
to_boolean cast a value to a true or false
to_checkbox No documentation is available.
to_fixed_timestamp Turn a text value into a datetime with a fixed timezone.
to_floating_timestamp Turn a text value into a floating datetime. “Floating” means the timezone
to_line parse a WKT (text) representation of a line into a line value
to_location Attempt to parse an address into a location column.
to_multiline parse a WKT (text) representation of a multiline into a multiline value
to_multipoint parse a WKT (text) representation of a multipoint into a multipoint value
to_multipolygon parse a WKT (text) representation of a multiline into a multiline value
to_number cast a value to a number
to_point parse a WKT (text) representation of a point into a point value
to_polygon parse a WKT (text) representation of a polygon into a polygon value
to_text cast a value to text
upper uppercase a string
xml_pluck Pluck a value out of an XML string using XPath. The returned value will be a string.