本节总结了UQL支持的所有函数。
函数命名约定
对于驼峰式命名的函数（例如pedgeUuids()），必须完全按照定义使用名称，保留原始大小写。
对于不遵循驼峰式命名的函数，在引用它们时可以使用全大写或全小写（例如length()或LENGTH()）。
路径函数
函数 |
描述 |
|---|---|
| length() | 返回路径中的总边数 |
| pedges() | 将路径中的所有边放入一个列表 |
| pedgeUuids() | 将路径中所有边的_uuid值放入一个列表 |
| pnodes() | 将路径中的所有点放入一个列表 |
| pnodeIds() | 将路径中所有点的_id放入一个列表 |
聚合函数
函数 |
描述 |
|---|---|
| avg() | 计算一组数值的平均值 |
| collect() | 将一组值放入一个列表 |
| count() | 返回输入中的总行数 |
| max() | 返回一组值的最大值 |
| min() | 返回一组值的最小值 |
| stddev_pop() | 计算一组数值的总体标准差 |
| stddev_samp() | 计算一组数值的样本标准差 |
| sum() | 计算一组数值的总和 |
数学函数
函数 |
描述 |
|---|---|
| abs() | 返回给定数字的绝对值 |
| ceil() | 将给定数字向上取整至最近的整数 |
| floor() | 将给定数字向下取整至最近的整数 |
| pi() | 返回数学常数π（圆周率） |
| pow() | 对给定的底数和指数进行指数运算 |
| round() | 将给定数字四舍五入到给定的位数 |
| sqrt() | 计算给定数字的平方根 |
三角函数
函数 |
描述 |
|---|---|
| acos() | 计算给定余弦值的弧度 |
| asin() | 计算给定正弦值的弧度 |
| atan() | 计算给定正切值的弧度 |
| cos() | 计算弧度的余弦值 |
| cot() | 计算弧度的余切值 |
| sin() | 计算弧度的正弦值 |
| tan() | 计算弧度的正切值 |
字符串函数
函数 |
描述 |
|---|---|
| btrim() | 从给定字符串的两端移除字符，直至遇到不包含在指定字符集中的字符为止 |
| endsWith() | 判断字符串是否以指定的子字符串结尾 |
| length() | 返回字符串中的总字符数 |
| lower() | 将给定字符串中的所有字母转换成小写字母 |
| ltrim() | 从给定字符串的开头移除字符，直至遇到不包含在指定字符集中的字符为止 |
| rtrim() | 从给定字符串的结尾移除字符，直至遇到不包含在指定字符集中的字符为止 |
| split() | 使用指定的分隔符将字符串拆分成子字符串列表 |
| startsWith() | 判断字符串是否以指定的子字符串开头 |
| upper() | 将给定字符串中的所有字母转换成大写字母 |
列表函数
函数 |
描述 |
|---|---|
| append() | 向列表末尾添加元素并返回新列表 |
| difference() | 返回两个列表之间的差异 |
| head() | 返回列表中的第一个元素 |
| intersection() | 返回两个列表的共有元素 |
| listContains() | 判断列表中是否包含指定元素 |
| listUnion() | 返回两个列表的并集 |
| reduce() | 对列表中的每个元素执行迭代计算 |
| size() | 返回列表中的元素总数 |
日期时间函数
函数 |
描述 |
|---|---|
| date() | 返回DATE类型的值 |
| local_datetime() | 返回LOCAL DATETIME类型的值 |
| local_time() | 返回LOCAL TIME类型的值 |
| now() | 返回协调世界时（UTC）下当前日期和时间 |
| zoned_datetime() | 返回ZONED DATETIME类型的值 |
| zoned_time() | 返回ZONED TIME类型的值 |
| dateAdd() | 向给定日期添加指定的时间间隔 |
| dateDiff() | 计算两个日期间的时间间隔，并以指定时间单位返回结果 |
| dateFormat() | 根据指定格式打印给定日期 |
| day() | 提取给定日期的日部分，即在当月的第几天 |
| dayOfWeek() | 返回一个数字，表示给定日期对应的星期几 |
| month() | 提取给定日期的月份数 |
| year() | 提取给定日期的年份数 |
空间函数
函数 |
描述 |
|---|---|
| distance() | 计算两个坐标点之间的直线距离 |
| point() | 构建一个二维地理坐标 |
| point() | 构建一个三维笛卡尔坐标 |
表函数
函数 |
描述 |
|---|---|
| table() | 构建输出表 |
Null函数
函数 |
描述 |
|---|---|
| coalesce() | 返回给定列表中的首个非null值 |
类型转换函数
函数 |
描述 |
|---|---|
| toDouble() | 将值转换成双精度浮点数 |
| toFloat() | 将值转换成单精度浮点数 |
| toInteger() | 将值转换成64位整数 |
| toString() | 将值转换成字符串 |