Apply a UDF
Jump to the Code block for a combined complete example.
UDFs that execute on a single record are Record UDFs. The record may or may not exist in the database, and the UDF may create, read, and/or update a record.
Setup
The following examples will use the setup below to illustrate applying a record UDF.
The record structure:
Occurred: Integer
Reported: Integer
Posted: Integer
Report: Map
{
shape: List,
summary: String,
city: String,
state: String,
duration: String
}
Location: GeoJSON
Single record transactions
Single argument
This example uses the setRecent
function in the module example.lua
.
See Manage UDFs for example.lua
code and information on registering the UDF.
This compares the posted
bin to a supplied value and writes true
/false
to a recent
bin based on the result.
Multiple argument
This example uses the getDaysBetween
function in the module example.lua
.
See Manage UDFs for example.lua
code and information on registering the UDF.
This compares two dates, provived by passing the bin names with the date values, and returns the days between. The following example will return the days between the sighting occurence and posting to the site.
Batch operation with a UDF
Server version 6.0 and above is required for batch UDF operations
This example will use the multi-argument example from above, and apply it to a batch of records.
Background query with a UDF
This example will use the single argument example from above, and apply it to all records that match a Filter Expression through a background query.