The following are all the functions and keywords available in SoQL. Some only work on the the latest version of our API endpoints, while some work on legacy versions as well. You can filter them by endpoint version and datatype using the filters below.
For a list of valid operators, see the Datatypes documentation.
Keyword Name | Description | Availability |
---|---|---|
distinct |
Returns distinct set of records | 2.1 |
Function Name | Description | Availability |
---|---|---|
avg(...) |
Returns the average of a given set of numbers | 2.0 and 2.1 |
between ... and ... |
Returns TRUE for values in a given range | 2.1 |
case(...) |
Returns different values based on the evaluation of boolean comparisons | 2.1 |
convex_hull(...) |
Returns the minimum convex geometry that encloses all of another geometry | 2.1 |
count(...) |
Returns a count of a given set of records | 2.0 and 2.1 |
date_extract_d(...) |
Extracts the day from the date as an integer. | 2.1 |
date_extract_dow(...) |
Extracts the day of the week as an integer between 0 and 6 (inclusive). | 2.1 |
date_extract_hh(...) |
Extracts the hour of the day as an integer between 0 and 23 (inclusive). | 2.1 |
date_extract_m(...) |
Extracts the month as an integer. | 2.1 |
date_extract_mm(...) |
Extracts the minute from the time as an integer. | 2.1 |
date_extract_ss(...) |
Extracts the second from the time as an integer. | 2.1 |
date_extract_woy(...) |
Extracts the week of the year as an integer between 0 and 51 (inclusive). | 2.1 |
date_extract_y(...) |
Extracts the year as an integer. | 2.1 |
date_trunc_y(...) |
Truncates a calendar date at the year threshold | 2.0 and 2.1 |
date_trunc_ym(...) |
Truncates a calendar date at the year/month threshold | 2.0 and 2.1 |
date_trunc_ymd(...) |
Truncates a calendar date at the year/month/date threshold | 2.0 and 2.1 |
distance_in_meters(...) |
Returns the distance between two Points in meters | 2.1 |
extent(...) |
Returns a bounding box that encloses a set of geometries | 2.1 |
greatest(...) |
Returns the largest value among its arguments, ignoring NULLs. | 2.1 |
in(...) |
Matches values in a given set of options | 2.1 |
intersects(...) |
Allows you to compare two geospatial types to see if they intersect or overlap each other | 2.1 |
least(...) |
Returns the smallest value among its arguments, ignoring NULLs. | 2.1 |
like '...' |
Allows for substring searches in text strings | 2.1 |
ln(...) |
Returns the natural log of a number | 2.1 |
lower(...) |
Returns the lowercase equivalent of a string of text | 2.1 |
max(...) |
Returns the maximum of a given set of numbers | 2.1 |
min(...) |
Returns the minimum of a given set of numbers | 2.1 |
not between ... and ... |
Returns TRUE for values not in a given range | 2.1 |
not in(...) |
Matches values not in a given set of options | 2.1 |
not like '...' |
Allows for matching text fields that do not contain a substring | 2.1 |
num_points(...) |
Returns the number of vertices in a geospatial data record | 2.1 |
regr_intercept(...) |
Returns the y-intercept of the linear least squares fit | 2.1 |
regr_r2(...) |
Returns the square of the correlation coefficient (r²) | 2.1 |
regr_slope(...) |
Returns the slope of the linear least squares fit | 2.1 |
simplify(...) |
Reduces the number of vertices in a line or polygon | 2.1 |
simplify_preserve_topology(...) |
Reduces the number of vertices in a line or polygon, preserving topology | 2.1 |
starts_with(...) |
Matches on text strings that start with a given substring | 2.1 |
stddev_pop(...) |
Returns the population standard deviation of a given set of numbers | 2.1 |
stddev_samp(...) |
Returns a sampled standard deviation of a given set of numbers | 2.1 |
sum(...) |
Returns the sum of a given set of numbers | 2.1 |
upper(...) |
Returns the uppercase equivalent of a string of text | 2.1 |
within_box(...) |
Returns the rows that have geodata within the specified box, defined by latitude, longitude corners | 2.0 and 2.1 |
within_circle(...) |
Returns the rows that have locations within a specified circle, measured in meters | 2.0 and 2.1 |
within_polygon(...) |
Returns the rows that have locations within the specified box, defined by latitude, longitude corners | 2.1 |