Built-in Functions

A built-in function returns a value calculated from one or more value parameters.

The following Built-in functions can be used within 1Validate.

Function	Description	Parameter(s)
angle	Angles are calculated between two line segments, which do not need to converge or touch. Returns an acute angle in either degrees or radians. A negative value is returned for errors.	A two point line segment. A two point line segment. (optional) A boolean flag set to true for degrees. Default is false, for radians.
area	Returns the area of a geometry in dataset units. If the geometry is a point or a line the result will be 0. If the geometry is a complex geometry, the result will be the sum of the areas of each simple area in the complex geometry. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The input geometry.
boundary	Returns the boundary of a line or area. The boundary of a line is a complex point geometry containing the line end points. The boundary of an area is a geometry containing all the rings in the area. This will be a simple line if the area has only an outer ring, otherwise it will be a complex line. This function supports 3D and 2D geometries. For point geometries, a Null value is returned.	The geometry for which the boundary is required.
buffer	Returns an area geometry representing a buffer zone of a fixed distance from the boundary of a geometry.	The geometry to buffer. The distance from the input geometry that the buffer zone will extend to. (optional) The length of the line segments to use to build up the buffer zone. (optional) The square end proportion. The square end proportion determines how far from the end of the line to create the square end. A negative value produces rounded corners and a positive value produces a buffer with square end. (optional) The mitre truncation proportion. A negative mitre truncation proportion value produces rounded corners. A zero value produces a true bevel which would cut off the corner with a straight line. A value greater than zero would extend the bevel away from the geometry by a proportion of the buffer distance.
convex_hull	Returns the smallest convex area geometry that contains the input geometry. The return value will be a simple area geometry with no inner rings. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The input geometry.
count_inner_rings	Counts the clockwise digitised rings of a simple or complex geometry. For a simple area this is the number of inner rings. For a complex geometry this is the sum of inner ring counts for all the simple area components. For a point or line geometry this is 0. If the object passed was not a geometry, returns null.	The input geometry.
count_parts	Returns the number of parts in a geometry. For a clear geometry this is 0. For a simple geometry this is 1. A complex geometry will have one or more parts. If the object passed was not a geometry, returns null.	The input geometry.
count_vertices	Returns the total number of vertices in a simple or complex geometry. The number of points in a ring does not include a duplicate point that closes the ring. For an area geometry, the sum of the vertex counts for each of its rings will be returned. For a complex geometry, the sum of the vertex counts over each of its components will be returned. For anything other than a geometry an exception will be thrown.	The input geometry.
create_geometry_from_wkt	Creates a geometry from a geometric well-known text string (WKT). Supported types are: Point MultiPoint LineString MultiLineString Polygon MultiPolygon Empty geometries, or those which specify their dimension as Z, M or ZM, are not supported.	A geometric WKT string.
difference	Returns the difference between two geometries; all the parts of the first geometry that are not in the second geometry. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The first geometry. The second geometry (to be subtracted from the first geometry).
difference_between_bearings	Returns an angle in degrees between 0 and 90, representing the difference between two bearings.	The first bearing: An angle in radians between -pi and pi. The second bearing: An angle in radians between -pi and pi.
difference_by_dimension	A geometry equal to geometry1 AND NOT geometry2. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The required dimensionality of the result. 0 - for GeomCombineResultType.POINTS 1 - for GeomCombineResultType.LINES 2 - for GeomCombineResultType.AREAS The first geometry. The second geometry (to be subtracted from the first geometry).
dimension	Returns the dimension of the input geometry (0 to 2) or -1 if input is null.	A geometry.
distance	Returns the distance in dataset units at the closest point of approach of two geometries. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	A geometry. Another geometry.
douglas_peucker	Returns a simplified version of a geometry formed by applying the Douglas-Peucker smoothing algorithm to each piece of line-work in the geometry. The result will be a geometry which approximates the original geometry using fewer vertices. The line-work of the resulting geometry will lie entirely within the specified tolerance of the original geometry's line-work.	The geometry to simplify. The required tolerance (must be a positive number).
drag_vertex	Returns a geometry formed by moving a specified vertex on a simple line geometry to a new location. It uses a scale and rotate algorithm to try to preserve the shape of the geometry on either side of the vertex being moved. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	A simple line geometry. A simple point geometry identifying the vertex on the line to be moved. A simple point geometry identifying the new location for the vertex.
end_of	Returns a point geometry at the location of the end of a simple line geometry.	A simple line geometry.
ends_of	Returns the endpoints of a simple line geometry. If the line is closed, the result will be a simple point geometry. Otherwise the result will be a complex geometry containing two points. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	A simple line geometry.
find_duplicates	Returns a collection of point geometries, representing any duplicate points within a geometry. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The geometry to test. (optional) The tolerance (in dataset units) for points to be classed as duplicate. If not specified uses the default geometric tolerance.
find_kickbacks	Returns a collection of point geometries, representing the locations of any kickbacks within a geometry. Kickbacks are a type of geometric error where a line segment changes direction twice by approximately 180 degrees (like a z shape) to repeat part of the line. They are usually detected with larger angles than spikes which is why there is a separate built-in to find them.	The geometry to test. (optional) The maximum value for the sine of the angles in the kickback. If omitted, this defaults to the sine of 1 degree. (optional) The maximum width of the kickback. If omitted, kickbacks with any width will be returned.
find_self_intersections	Returns a multi-point geometry representing the points at which a line, or the rings of an area, self-intersect.	The geometry to test.
find_small_rings	Returns a descriptor for the complex line geometry containing small rings. One or more of the following criteria may be used to determine if a ring is to be considered small: The length of the diagonal if the ring's MBR. The area of the ring. The ratio of the ring's area to the square of its perimeter. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The geometry to test. The maximum MBR diagonal length. (optional) The maximum ring area. (optional) The maximum area to square perimeter ratio. Note: If any of these parameters is negative it is ignored.
find_spikes	Returns a descriptor for the point complex geometry containing spike points. A spike is defined to be three consecutive points (A, B, C) such that: The distance AB is less than the distance BC. The sine of the angle ABC is less than a maximum value which may be specified by the second parameter. (Optionally) the distance AB is less than a maximum "length" value specified by the third parameter.	The geometry to test. (optional) The maximum value for the sine of the angle in the spike (a real number in the range [0, 1]). Note: If omitted, this defaults to the sine of 1 degree (approximately 0.017). (optional) The maximum length of the spike.
get_job_extent	Obtains the extent of the current session. Note: This does not calculate the minimum bounding rectangle (MBR) of the loaded data. This is calculated from the following (in order of priority): If the session is partitioned, the extent of the partition. If an extent such as a bounding box or polygon has been specified for a session, the specified extent. If there are any extents present in the spatial metadata for the loaded data, the MBR of all such extents. A default, arbitrary extent (the whole world if data is in degrees, else a 10,000 width square).
get_point	Returns a point guaranteed to lie on the specified geometry. The point is not necessarily near to the centre of the geometry, but is guaranteed to lie inside it. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	Any geometry.
get_x	Returns the x co-ordinate of a point on a simple or complex geometry. For a point geometry the return will be the x co-ordinate of that geometry. For other types of geometry the return will be the x co-ordinate of an arbitrary point on the input geometry. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	Any geometry.
get_y	Returns the y co-ordinate of a point on a simple or complex geometry. For a point geometry the return will be the y co-ordinate of that geometry. For other types of geometry the return will be the y co-ordinate of an arbitrary point on the input geometry. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	Any geometry.
has_duplicates	Tests to see if a geometry has any consecutive coincident vertices. Returns a Boolean value, true if the geometry has any consecutive coincident vertices and false if it does not.	Any geometry.
has_kickbacks	Checks whether a geometry has any kickbacks (a type of geometric error where a line segment changes direction twice by approximately 180 degrees to repeat part of the line). Kickbacks are also known as snap-backs. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The geometry to test. (optional) The maximum value for the sine of the angles in the kickback. Note: If omitted, this defaults to the sine of 1 degree. (optional) The maximum width of the kickback.
has_small_rings	Checks whether a geometry has any small rings (pig tails). Returns true if the geometry has small rings and false if it does not. One or more of the following criteria may be used to determine if a ring is to be considered small: The length of the diagonal if the ring's MBR. The area of the ring. The ratio of the ring's area to the square of its perimeter. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The geometry to test. The maximum MBR diagonal length. (optional) The maximum ring area. (optional) The maximum area to square perimeter ratio. Note: If any of these parameters is negative it is ignored.
has_spikes	Checks whether a geometry has any spikes. Returns true if the geometry has spikes and false if it does not. A spike is defined to be three consecutive points (A, B, C) such that: The distance AB is less than the distance BC. The sine of the angle ABC is less than a maximum value which may be specified by the second parameter. (Optionally) the distance AB is less than a maximum "length" value specified by the third parameter. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The geometry to test. (optional) The maximum value for the sine of the angle in the spike (a real number in the range [0, 1]). Note: If omitted, this defaults to the sine of 1 degree (approximately 0.017). (optional) The maximum length of the spike.
height	Returns the height of the nearest vertex for a 3D geometry.	A 3D geometry. (optional) A 2D geometry specifying the point on the 3D geometry whose height is to be returned. Note: If this parameter is omitted, then a vertex on the 3D geometry is chosen at random.
inner_rings	Returns the inner rings of a simple area geometry, or the inner rings of all areas in a complex geometry. If there is only one inner ring, that ring is returned as a simple line. If there are several, they are returned as components of a complex line geometry. Returns null if applied to a null geometry, a non-area geometry, an area geometry without inner rings or a complex geometry containing areas with no inner rings. The result has the same dimensionality (2D or 2.5D) as the input geometry.	A simple or complex 2D or 2.5D geometry.
intersection	Returns the intersection of two or more geometries - the parts in common between all of them. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	Any geometry. Another geometry to intersect with the first. (optional) Additional geometries to intersect.
intersection_by_dimension	Returns a geometry equal to the intersection of all the input geometries, or null if the intersection is empty. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The required dimensionality of the result. 0 - for GeomCombineResultType.POINTS 1 - for GeomCombineResultType.LINES 2 - for GeomCombineResultType.AREAS Any geometry. Another geometry to intersect with the first. (optional) Additional geometries to intersect.
is_aligned	Tests whether two line geometries are aligned. Returns true if the geometries are aligned and false otherwise. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	First simple line geometry (must not be null). Second simple line geometry (must not be null).
is_boundary_left	Tests whether a point, line or area geometry is to the left of a line geometry with respect to the direction of the line geometry. Returns true if the boundary left relationship holds and false otherwise. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The line geometry. The area geometry.
is_boundary_right	Tests whether a point, line or area geometry is to the right of a line geometry with respect to the direction of the line geometry. Returns true if the boundary right relationship holds and false otherwise. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The line geometry. The area geometry.
is_closed	Tests whether a geometry is closed. Returns true if the geometry is a simple area or if it is a simple line with coincident end points.	Any geometry.
is_downhill	Tests whether a 3D line geometry is digitised in a downhill direction. Returns a Boolean value, true if the geometry is a 3D line that slopes downwards and false otherwise. Returns null if parameter 1 is not a 3D simple line geometry. An optional tolerance may be supplied to use when comparing the heights of vertices on the line. The line is considered to be downhill if each vertex is lower than all the preceding vertices, to within the specified tolerance.	A 3D line geometry to test. (optional) A numerical value specifying the tolerance to apply to the line's z values.
is_level	Tests whether a 3D line geometry has a constant height along its length. Returns a Boolean value, true if the geometry is a 3D line is level and false otherwise. Returns null if parameter 1 is not a 3D simple line geometry. An optional tolerance may be supplied for use when comparing the heights of vertices on the line. The line is considered to be level if the maximum height minus the minimum height along the line is less than or equal to the specified tolerance.	A 3D line geometry to be tested. (optional) A numerical value specifying the tolerance to apply to the line's z values.
is_noded	Tests if two line geometries intersect at common vertices. Returns true if the geometries are noded and false otherwise.	The first line geometry. The second line geometry. (optional) An optional boolean value indicating for 3D geometries whether or not to check z values at intersections (defaults to true).
is_simple	Tests to see if a geometry is simple according to the OGC definition. Returns a Boolean value, true if the geometry is simple according to the OGC definition and false if it is not. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	Any geometry.
is_uphill	Returns true if a 3D line slopes upwards, with an optional tolerance for comparing the heights of vertices on the line. The line is considered to be uphill if each vertex is higher than all the preceding vertices, to within tolerance.	A 3D line geometry to test. (optional) A numerical value specifying the tolerance to apply to the line's z values.
is_valid	Tests to see if a geometry is valid according to the OGC definition. Returns a Boolean value, true if the geometry is valid according to the OGC definition and false if it is not.	Any geometry.
line	Returns a line geometry constructed from points supplied in parameters. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The start of the line as a simple point geometry. The second vertex of the line as a simple point geometry. optional) Subsequent vertices in the line as point geometries .
line_bearing_at_point	Returns the angle of the line at a point between -pi and pi, measured in radians anti-clockwise from east (positive x axis).	The line geometry for which to measure the angle. The point geometry for the point that is on or near the point on the line at which the angle is to be measured.
line_length	Returns the length of a geometry in dataset units. The length of a point or an area is 0. The length of a complex geometry is the sum of the lengths of its component simple line geometries.	Any geometry.
line_segment	Returns a segment cut out of a simple line geometry, or null if the distance parameters are out of range. The start and end points of the segment are specified by distances along the line, measured from its start. A negative value indicates a distance from the line end instead of the start. With a 3D line geometry, distances are in plan; if the start or end of the segment is between two vertices with height values, the segment endvertex is given an interpolated height.	Any geometry. A distance along the line for the segment start point. A distance along the line for the segment end point.
make_2d	Returns a 2D geometry. If the argument is not valid, then null is returned.	The geometry to convert to 2D.
make_3d	Returns a 3D geometry. If the argument is not valid, then null is returned.	The geometry to convert to 3D. (optional) The x-coordinate value for the first 3D point. (optional) The y-coordinate value for the first 3D point. (optional) The z-coordinate value for the first 3D point. (optional) The x-coordinate value for the second 3D point. (optional) The y-coordinate value for the second 3D point. (optional) The z-coordinate value for the second 3D point. (optional) The x-coordinate value for the third 3D point. (optional) The y-coordinate value for the third 3D point. (optional) The z-coordinate value for the third 3D point.
max_deflection_angle	Returns the maximum deflection angle (in degrees) between adjacent line segments in a geometry. For a point this is always 0. For an area it the maximum deflection in any of its rings. For a complex geometry it is the maximum deflection in any of its simple parts. For 3D geometries, the heights are ignored. For Measured geometries, the measures are ignored.	The input geometry.
max_height	Returns the maximum height of a 3D geometry.	A 3D geometry.
mbr	Returns the minimum bounding rectangle (MBR) of one or more geometries. The result is the smallest rectangle, with sides parallel to the X and Y axes, that contains all the input geometries. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	Any geometry.
min_height	Returns the minimum height of a 3D geometry.	A 3D geometry.
min_intersection_angle	Returns the minimum intersection angle between two geometries. Returns -1 if the two geometries do not intersect. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	First input geometry. Second input geometry.
move_vertex	Returns a geometry formed by moving a vertex on a simple line geometry. This function will only move one vertex on the geometry and so may leave a spike. For smoother results, consider the drag_vertex function. Note: For heighted or measured geometries: If the new point has a height/measure then the height/measure from the point will be applied. If the new location point is 2D then the height/measure value on the original vertex is retained.	A point or line geometry. A simple point geometry identifying the vertex on the line to be moved. A simple point geometry identifying the new location for the vertex.
nearest_point	Returns a geometry representing the nearest point(s) on a provided geometry from an originating point geometry. This will be complex if multiple points are equally close to the originating point. If neither parameter is a geometry an exception is thrown. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	An originating point. A destination geometry (to search), either point, line, area, or complex whose nearest point(s) to parameter 1 are returned. (optional) A Boolean value, true to return an arbitrary single nearest point or false to return all nearest points as a complex geometry. The default value is false.
nearest_vertex	Returns a point geometry at the nearest vertex on a geometry, described by the nearest known X and Y positions. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The geometry on which to find the vertex. The nearest known X position. The nearest known Y position.
offset	Offsets (translates) a geometry by a fixed distance without changing its shape, size or orientation.	The geometry to offset. The distance to move the geometry in the x direction. The distance to move the geometry in the y direction. (optional) The distance to move the geometry in the z direction. Note: If a z offset is specified with a 2D geometry, the result will be a 3D geometry with all heights set to the z offset value.
outer_ring	Returns the outer ring of a simple area geometry. The result will be a closed simple line geometry.	A simple or complex area geometry.
perimeter	Returns the perimeter of an area geometry. If the geometry is a point or a line, the result will be 0. If the geometry is a complex geometry, the result will be the sum of the perimeters of each simple area geometry in the complex geometry. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	Any geometry.
point	Builds a 2D point (if passing x and y values) or a 2.5D point (if passing x, y and z values).	The x-coordinate value of the point. The y-coordinate value of the point. (optional) The z-coordinate value of the point.
point_along_line	Returns a point on a line geometry at a distance along it expressed as a proportion of the total length of the line.	A line geometry. Proportional distance along the line, a real number in the range [0,1]. value <= 0 locates the start point of the line. value >= 1 locates the end point of the line. 0 < value < 1 locates a point within the line.
point_at_projection	Returns a new point, the specified bearing and distance from the origin point.	The origin 2D or 3D point from which to measure the location of the new point. An angle (in degrees anti-clockwise from east) representing the bearing to the new point from the origin point. A distance from the origin point (in dataset units) at which to create the new point.
point_on_line	Finds a point on a line geometry, a given distance along it from its start or end point. Returns null if the distance parameter is out of range. With a 3D line, the height will be interpolated between vertices.	The input geometry. Distance from the start of the line. A negative value indicates distance from the end of the line.
polygon	Forms an area geometry from a simple closed line geometry, a complex line geometry containing one or more rings, a simple area, or a complex area geometry. Returns null if the rings do not form a valid area geometry.	The input geometry.
proportion_along_line	Finds the nearest position on a line to a given point, and calculates its distance along the line, expressed as a proportion of the total length of the line (a real number in the range between 0 and 1).	A line geometry. A point geometry.
remove_duplicates	Removes any duplicate vertices from a geometry. Any occurrence of consecutive, coincident vertices is replaced with a single vertex at the same location.	Any geometry.
remove_kickbacks	Removes any kickbacks (a type of geometric error where a line segment changes direction twice by approximately 180 degrees to repeat part of the line) from a geometry. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The input geometry. (optional) The maximum value for the sine of the angles in the kickback. If omitted, this defaults to the sine of 1 degree. (optional) The maximum width of the kickback.
remove_small_rings	Removes any small rings from a geometry. Returns null if all of the rings are too small. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The input geometry. The maximum MBR diagonal length. (optional) The maximum ring area. (optional) The maximum area to square perimeter ratio.
remove_spikes	Removes any spikes from a geometry. A spike is defined to be three consecutive points (A, B, C) such that: The distance AB is less than the distance BC. The sine of the angle ABC is less than a maximum value which may be specified by the second parameter. (Optionally) the distance AB is less than a maximum "length" value specified by the third parameter. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The input geometry. (optional) The maximum value for the sine of the angle in the spike. Note: If omitted, this defaults to the sine of 1 degree. (optional) The maximum length of the spike.
reverse_line	Reverses the order of the vertices in a simple line geometry. Returns a copy of the line geometry, with the same vertices but running in the opposite direction. Returns null if parameter is not a simple line geometry.	Any simple line geometry.
round_geom	Returns a rounded geometry.	A geometry to round. Precision to round to, as an integer. (optional) Whether or not to check if the geometry is valid after rounding. Default is true.
rule_hotspot_geometry	A collection geometry containing the hotspots from this feature for the triggering Rule, or null. If an optional default is provided, will return the default instead of null.	(optional) A default value if no hotspots are found. The default value must be geometric.
scale_and_rotate	Returns a 2D copy of the input geometry scaled and rotated.	The geometry to scale and rotate. It can be 2D or 3D, of any type. The Point geometry to scale and rotate about, must be a 2D or 3D simple point. The scale factor to use. The angle to rotate the object, in radians.
segment	Returns a segment from a line as two consecutive vertices. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The line geometry from which the segment is taken The index of the vertex to extract, or 0 for the last segment. Note: A negative index will return the segment counting from the last segment.
segments	Obtains the segments from a geometry, returning as a Complex Line. If no segments are present, this geometry will be clear. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The geometry from which to take the segments.
start_of	Returns a point geometry at the location of the start of a simple line geometry.	A simple line geometry.
symmetric_difference	Returns a geometry equal to geometry1 XOR geometry2. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The first geometry. The second geometry (to be XOR'd with the first geometry).
symmetric_difference_by_dimension	Returns a geometry equal to geometry1 XOR geometry2. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The required dimensionality of the result. 0 - for GeomCombineResultType.POINTS 1 - for GeomCombineResultType.LINES 2 - for GeomCombineResultType.AREAS The first geometry. The second geometry (to be XOR'd with the first geometry).
true_distance	Returns the distance along the surface of the earth between the 2 points.	The longitude of point 1 in degrees. The latitude of point 1 in degrees. The longitude of point 2 in degrees. The latitude of point 2 in degrees. The earth spheroid model to use. Note: Allowed values are: 1: WGS-84 2: GRS-80 3: Airy (1830) 4: Int'l 1924 5: Clarke (1880) 6: GRS-67
union	Returns the union of two or more geometries. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	Any geometry. Another geometry to combine with the first. (optional) Additional geometries to add to the union.
union_by_dimension	Returns a geometry equal to the union of all the input geometries. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The required dimensionality of the result. 0 - for GeomCombineResultType.POINTS 1 - for GeomCombineResultType.LINES 2 - for GeomCombineResultType.AREAS Any geometry. Another geometry to combine with the first.
vertices	Obtains the vertices of a geometry, returned as a Complex Point. If no vertices are present, this geometry will be clear. Note: This function does not currently fully support 3D or measured geometries. Any 3D or measured geometries will be projected down to 2 dimensions.	The geometry from which to take the vertices.

Measured Geometry Functions

Function	Description	Parameter(s)
get_measure_maximum	Returns the maximum measure value of a geometry. The maximum value may not necessarily be found at the start/end of the geometry. Measures can be null so the maximum may be null. If the input parameter is null, the value returned will be null. If the input geometry is not a measured geometry, an exception will be thrown.	A measured geometry.
get_measure_minimum	Returns the minimum measure value of a geometry. The minimum value may not necessarily be found at the start/end of the geometry. Measures can be null so the minimum may be null. If the input parameter is null, the value returned will be null. If the input geometry is not a measured geometry, an exception will be thrown.	A measured geometry.
is_measured_line_monotonic_increasing	Returns a boolean to indicate if the input measured geometry is a simple line and measured with values increasing in the digitised direction along its length. If the input geometry is not a simple measured line, an exception will be thrown.	A measured simple line geometry. (optional) A boolean to indicate if null measure values should be ignored.
line_segment_from_measures	Returns the segment of linework between 2 particular measure values. The returned line geometry will be in direction based on the order of the specified measure values, rather than the geometric order of the input line.	A measured simple line geometry. The value of the measure to signify the start point for the output segment. The value of the measure to signify the end point for the output segment.
measure_from_point	Returns the measure value located at the nearest position on the input line to the point geometry. Linear interpolation between stored measure values (located at vertices) will be used to identify the exact measure value along the input line where the nearest location (in 2D plan form) to the point is found. If the measure value at the specified vertex is null or if either of the measure values adjacent to the point geometry are null, the return value will be null. If the input geometry is not a simple measured line, an exception will be thrown.	A measured simple line geometry. The location from which the measure will be retrieved. Note: This is defined as either the nearest point on line to the specified point or as the 1-based integer index of the vertex within the line.
measured_point	Builds a measured point from x, y and m values.	The x-coordinate value of the point. The y-coordinate value of the point. The measure value of the point. May be null.
point_from_measure	Returns a point geometry located at the first position on the input line where the measure value is found. Linear interpolation between stored measure values (located at vertices) will be used to identify the exact position along the line where the specified measure value is found. If the input geometry is not a simple measured line, an exception will be thrown. If the measure value is not found in the input geometry, an exception will be thrown.	A measured simple line geometry. The measure value to find (double).
set_measure	Returns a copy of the input geometry with a measure set at the specified location. Note: This will overwrite any existing measure value at that location. Setting a null measure value is supported.	A measured geometry. The vertex on which to set the measure. Note: This is defined as either the nearest vertex to the specified point or as the 1-based integer index of the vertex within the line.

Conversion Functions

Function	Description	Parameter(s)
to_degrees	Converts an angle specified in radians to degrees.	A numerical value representing an angle in radians.
to_integer	Converts a numerical, boolean or string value to an integer. Any decimal digits present in the number after the decimal point are removed. The boolean values true and false are converted into 1 and 0 respectively.	A numerical, boolean, string or timestamp value.
to_radians	Converts an angle specified in degrees to radians.	A numerical value representing an angle in degrees.
to_real	Converts a numerical, boolean or string value to a real (floating point) number.	A numerical, boolean or string value.
to_string	Converts any value to a string.	Any value.

Mathematical Functions

Function	Description	Parameter(s)
abs	Returns the absolute value of the input parameter. If the parameter is negative, it is returned with its sign reversed so that it becomes positive. Otherwise it is returned unchanged.	Any numerical value.
acos	Returns the inverse cosine in radians (0.0 to pi).	A numerical value in the range [-1,1].
asin	Returns the inverse sine in radians. The result will be an angle in the range between -pi/2 and pi/2.	A numerical value in the range [-1,1].
atan	Returns the inverse tangent in radians. The result will be an angle in the range between –pi/2 and pi/2.	Any numerical value.
atan2	Converts Cartesian x and y co-ordinates to polar co-ordinates and returns the polar angle, measured counter-clockwise from the positive x-axis. The result will be an angle in radians in the range between -pi and pi.	The x-coordinate value. The y-coordinate value.
ceil	Rounds a numerical value up to the nearest integer value greater than or equal to the input value.	Any numerical value.
cos	Returns the cosine of an angle in radians (in the range [-1,1]).	Any numerical value.
exp	Returns the inverse natural logarithm of a number (i.e Euler's number raised to the power of the input parameter, e^x).	Any numerical value.
floor	Rounds a numerical value down to the nearest integer value less than or equal to the input value.	Any numerical value.
is_infinite	Tests if a number is infinite in magnitude. Returns true if the number is positive or negative infinity, and false otherwise.	Any numerical value.
is_NaN	The special numerical value "not a number" results from certain mathematical operations such as dividing 0.0 by 0.0, which cannot be computed. Returns true if the number has the special value "not a number" and false if it is a valid (finite or infinite) number.	Any numerical value.
log	Returns the natural logarithm (base e) of a number.	A numerical value greater than 0.
log10	Returns the logarithm to base 10 of a number.	A numerical value greater than 0.
max	Returns the largest of 2 or more values.	A numerical, boolean or string value. Another numerical, boolean or string value. (optional) Additional numerical, boolean or string values.
min	Returns the smallest of 2 or more values.	A numerical, boolean or string value. Another numerical, boolean or string value. (optional) Additional numerical, boolean or string values.
pow	Returns the value of one number raised to the power of another number (a^b).	Any numerical value (a). Any numerical value (b).
round	Returns a number rounded to the nearest integer value.	A numerical value (a). (optional) Number of decimal places to round to (b). If omitted, rounding is to the nearest integer.
sin	Returns the sine of an angle in radians (in the range [-1,1]).	A numerical value representing an angle in radians.
sqrt	Returns the (positive) square root of a number.	A numerical value greater than 0.
tan	Returns the tangent of an angle (specified in radians).	A numerical value representing an angle in radians.

Bit Manipulation Functions

Function	Description	Parameter(s)
bit_and	Returns the bitwise AND of two integers. Each bit in the binary expansion of the result will only be set if both of the corresponding bits in the two input numbers are also set.	An integer value. Another integer value.
bit_not	Returns the bitwise complement of an integer. Each bit in the binary expansion of the result will be the opposite of the corresponding bit in the input number.	An integer value.
bit_or	Returns the bitwise OR of two integers. Each bit in the binary expansion of the result will be set if either of the corresponding bits in the two input numbers is set.	An integer value. Another integer value.
bit_shift	Returns an integer value computed by shifting the binary bits of the input value. Note: Positive values shift it to the left and negative values shift it to the right.	An integer value whose bits are to be shifted. An integer value specifying how far to shift the bits of the first parameter.
bit_xor	Returns the bitwise XOR of two integers. Each bit in the binary expansion of the result will be set if the corresponding bits in the two input numbers are different from one another.	An integer value. Another integer value.

String Functions

Function	Description	Parameter(s)
index_of	Searches in a string for occurrences of another string and returns the index of the first match found (where the first character is at index 0). Returns -1 if the string could not be found.	The string in which to search. The string to search for. (optional) The 0-based index in the first string to start the search from. If omitted, the search starts from the beginning of the first string.
jaro_winkler_similarity	Returns a double value representing the Jaro-Winkler similarity score between two words. If both strings are null or empty then they are considered an exact match.	The first word to compare. The second word to compare. (optional) Ignore case. If true (default), words are converted to upper case before comparison. (optional) Length of maximum common prefix in the range 0 to 4. If null default 4 is used. (optional) Scaling factor in the range 0 to 0.25 indicating how much the score is adjusted upwards for having common prefixes. If null, default 0.1 is used. (optional) Boost threshold to adjust the Jaro distance with the Winkler modification to give emphasis to common prefixes. If null default 0.7 is used.
length	Returns the length of a string (number of characters).	Any string.
levenshtein_distance	Returns an integer for the difference, 0 if identical.	The first string. The second string.
re_search	Performs a regular expression search for a Java-style regular expression inside a string. If a match is found, the matching string (a substring of the first string) is returned. Otherwise null is returned.	The string to search in. A string containing the regular expression to search for.
re_subs_all	Replaces all occurrences of patterns matching a Java-style regular expression in a string with the specified replacement string.	The string to search and replace in. A string containing the regular expression to search for. The replacement string, for each match found for the regular expression.
re_subs_first	Replaces the first occurrence of a pattern matching a Java-style regular expression in a string with the specified replacement string.	The string to search and replace in. A string containing the regular expression to search for. The replacement string, for the first match found for the regular expression.
soundex	Returns the soundex code for the word, or null if the word cannot be mapped to a soundex.	The word (string) to be tested.
substring	Returns substring of the input string between the specified character indexes (where the first character is at index 0).	The input string. The 0-based start index specifying where the substring should start. (optional) The 0-based end index specifying where the substring should end.
to_lowercase	Converts a string to lower case.	The input string.
to_uppercase	Converts a string to upper case (capital letters).	The input string.
trim	Returns a trimmed String, or null if a null object was passed in .	The input string.

Collection Functions

Function	Description	Parameter(s)
count	Returns the number of elements in a collection.	A collection or array.

Identity Functions

Function	Description	Parameter(s)
generate_uuid	Generates a (version 4) random UUID string in lower-case 8-4-4-4-12 hexadecimal format (e.g. 125d4167-c85b-43d4-b416-523625244020).	None
read_sequence	Returns the next value in the sequence (as an integer).	The database to read the sequence from, specified by a JNDI location (as a string). The sequence name (as a string). (optional) The schema name, if different from the default (as a string).

Lookup Functions

Function	Description	Parameter(s)
metadata_store_lookup	Looks up the value of a key in a specific table within in a metadata store. The query will match all keys in the table that equals the input value. If there are multiple matches, the first value found in the table is returned. Note: The returned value is the same as a Constant Value using the same metadata store, table and key. Note: This built-in function is the reverse of metadata_store_reverse_lookup.	The full path to the metadata store (without the DATASTORE:// prefix) e.g. TEST/CONSTANT_STORE. The name of the table in the metadata store. The key string. (optional) The default value to return if the query does not find any result.
metadata_store_reverse_lookup	Look up the key of a value in a specific table within in a metadata store. The query will match all values in the table that equals the input value. If there are multiple matches, the first key found in the table is returned. Note: This built-in function is the reverse of metadata_store_lookup.	The full path to the metadata store (without the DATASTORE:// prefix) e.g. TEST/CONSTANT_STORE. The name of the table in the metadata store. The value string. (optional) The default key to return if the query does not find any result.

Function

Description

Parameter(s)

metadata_store_lookup

Looks up the value of a key in a specific table within in a metadata store.

The query will match all keys in the table that equals the input value. If there are multiple matches, the first value found in the table is returned.

Note: The returned value is the same as a Constant Value using the same metadata store, table and key.

Note: This built-in function is the reverse of metadata_store_reverse_lookup.

The full path to the metadata store (without the DATASTORE:// prefix) e.g. TEST/CONSTANT_STORE.
The name of the table in the metadata store.
The key string.
(optional) The default value to return if the query does not find any result.

metadata_store_reverse_lookup

Look up the key of a value in a specific table within in a metadata store.

The query will match all values in the table that equals the input value. If there are multiple matches, the first key found in the table is returned.

Note: This built-in function is the reverse of metadata_store_lookup.

The full path to the metadata store (without the DATASTORE:// prefix) e.g. TEST/CONSTANT_STORE.
The name of the table in the metadata store.
The value string.
(optional) The default key to return if the query does not find any result.

Shifting Functions

Function	Description	Parameter(s)
shift_geometry	A shifted version of the geometry (see Positional Data Shifting). This will be a geometry of the same type as the input geometry with the same number of vertices. Note: Ensure that the name used for the register_shift_vector built-in operation is used here.	A name to identify a set of shift vectors. The geometry to be shifted, can be of any type

Function

Description

Parameter(s)

shift_geometry

A shifted version of the geometry (see Positional Data Shifting).

This will be a geometry of the same type as the input geometry with the same number of vertices.

Note: Ensure that the name used for the register_shift_vector built-in operation is used here.

A name to identify a set of shift vectors.
The geometry to be shifted, can be of any type

Sorting Functions

Note: The tsort_* functions are used to implement iterating through objects in dependency order. Please contact 1Spatial Support for further guidance on their use.

Function	Parameter(s)
tsort_blocked_objects	The name of the topological sort. If not provided, or null, the default topological sort will be used.
tsort_blocked_predecessors	The successor. The name of the topological sort. Note: If not provided, or null, the default topological sort will be used.
tsort_blocked_successors	The blocked predecessor. The name of the topological sort. Note: If not provided, or null, the default topological sort will be used.
tsort_ordered_objects	The name of the topological sort. Note: If not provided, or null, the default topological sort will be used.

Timestamp Functions

Function	Description	Parameter(s)
add_date	Adds a date and time in the TIMESTAMP date format yyyy-MM-dd HH:mm:ss.SSS. Note: Some data stores may not hold the same precision levels for time data as the TIMESTAMP. For example, if the TIMESTAMP value is exported to a data store with less accurate time, the TIMESTAMP value in will reflect that in the target data store.	The Timestamp to increment. The Timestamp is obtained from the following values: static value dynamic value get_current_date function The number of milliseconds to add to the Timestamp.
current_datetime	Returns the current date and time as a string.	(optional) A string describing the date format.
get_current_date	Returns the current date and time in the TIMESTAMP date format yyyy-MM-dd HH:mm:ss.SSS.	None
to_timestamp	Converts a date/time formatted string, or time in milliseconds, into a timestamp datatype. The default date/time format is "yyyy-MM-dd hh:mm:ss.SSS z". The default format allows just the date with no time to be specified. For example 2017-03-17 14:25:03 GMT or 2017-03-17. The time specified in milliseconds is from January 1, 1970, 00:00:00 GMT. Note: For more information about the format rules, refer to the Oracle documentation.	The date/time formatted (String), or time in milliseconds (Long). (optional) Format of the date/time string. If not specified the default format is used.

Topology Functions

Function	Description	Parameter(s)
is_structured	Tests if an object is topologically structured. Returns true if the object is structured and false otherwise.	The object to be tested

Function

Description

Parameter(s)

is_structured

Tests if an object is topologically structured.

Returns true if the object is structured and false otherwise.

The object to be tested