函数
本节包含 Cypher® 中所有函数的摘要。
要列出所有函数,请运行以下查询
SHOW FUNCTIONS
有关此命令的更多信息,请参阅 SHOW FUNCTIONS。
接受 |
聚合函数
这些函数接受多个值作为参数,并从中计算并返回聚合值。
函数 | 签名 | 描述 |
---|---|---|
|
返回一组 |
|
|
返回一个包含表达式返回值的列表。 |
|
|
返回值的数量或行数。 |
|
|
返回一组值中的最大值。 |
|
|
返回一组值中的最小值。 |
|
|
使用线性插值返回组中值的百分位数。 |
|
|
使用舍入方法返回组中给定百分位数最接近的 |
|
|
返回给定值在一组人口样本中的标准差。 |
|
|
返回给定值在整个人口组中的标准差。 |
|
|
返回一组 |
数据库函数
数据库函数提供有关数据库的信息。
函数 | 签名 | 描述 |
---|---|---|
|
从给定元素 ID 解析数据库名称。 |
GenAI 函数
函数 | 签名 | 描述 |
---|---|---|
|
使用指定的提供程序将给定资源编码为向量。 |
图函数
图函数提供有关复合数据库中构成图的信息。
函数 | 签名 | 描述 |
---|---|---|
|
解析给定元素 ID 所属的构成图。 在 5.13 中引入 |
|
|
按名称解析构成图。 |
|
|
返回一个列表,其中包含当前复合数据库中所有图的名称。 |
|
|
返回一个包含与给定图关联的属性的映射。 |
列表函数
这些函数返回其他值的列表。有关列表的更多详细信息和示例,请参阅 列表。
函数 | 签名 | 描述 |
---|---|---|
|
返回一个 |
|
|
返回一个 |
|
|
返回一个 |
|
|
返回一个 |
|
|
对 |
|
|
返回一个 |
|
|
返回一个 |
|
|
返回 |
|
|
将 |
|
|
将 |
|
|
将 |
|
|
将 |
LOAD CSV 函数
LOAD CSV 函数可用于获取 LOAD CSV
处理的文件信息。
函数 | 签名 | 描述 |
---|---|---|
|
返回 LOAD CSV 正在使用的文件的绝对路径。 |
|
|
返回 LOAD CSV 当前正在使用的行号。 |
对数函数
这些函数仅对数值表达式进行操作,如果用于任何其他值,将返回错误。
函数 | 签名 | 描述 |
---|---|---|
|
返回自然对数的底 e。 |
|
|
返回 en,其中 e 是自然对数的底,n 是参数表达式的值。 |
|
|
返回 |
|
|
返回 |
|
|
返回 |
数值函数
这些函数仅对数值表达式进行操作,如果用于任何其他值,将返回错误。
函数 | 签名 | 描述 |
---|---|---|
|
返回 |
|
|
返回大于或等于一个数且等于 |
|
|
返回小于或等于一个数且等于 |
|
|
如果浮点数为 |
|
|
返回一个介于 0(包含)到 1(不包含)之间的随机 |
|
|
返回一个数字四舍五入到最近的 |
|
|
返回 |
三角函数
这些函数仅对数值表达式进行操作,如果用于任何其他值,将返回错误。
所有三角函数都以弧度为单位,除非另有说明。
函数 | 签名 | 描述 |
---|---|---|
|
返回 |
|
|
返回 |
|
|
返回 |
|
|
返回一组坐标的反切值(弧度)。 |
|
|
返回 |
|
|
返回 |
|
|
将弧度转换为角度。 |
|
|
返回一个数的半正矢。 |
|
|
返回数学常数 pi。 |
|
|
将角度转换为弧度。 |
|
|
返回 |
|
|
返回 |
谓词函数
这些函数为给定参数返回 true 或 false。
函数 | 签名 | 描述 |
---|---|---|
|
如果谓词对给定 |
|
|
如果谓词对给定 |
|
|
如果图中存在与模式匹配的内容,则返回 |
|
|
检查给定 |
|
|
如果谓词对给定 |
|
|
如果谓词对给定 |
标量函数
这些函数返回单个值。
函数 | 签名 | 描述 |
---|---|---|
|
返回 |
|
|
返回 |
|
|
返回表达式列表中第一个非 null 值。 |
|
|
返回在特定事务和 DBMS 中唯一的节点或关系标识符。 |
|
|
返回 |
|
|
返回 |
|
|
已弃用 返回 |
|
|
返回 |
|
|
返回 |
|
|
如果两个给定参数相等,则返回 |
|
|
返回一个 |
|
|
生成一个随机 UUID。 |
|
|
返回 |
|
|
返回 |
|
|
返回当前时间与 1970 年 1 月 1 日午夜 UTC 之间以毫秒为单位的差值。 |
|
|
将 |
|
|
将值转换为 |
|
|
将 |
|
|
将值转换为 |
|
|
将 |
|
|
将值转换为 |
|
|
返回 |
|
|
返回给定表达式计算出的最精确值类型的 |
字符串函数
这些函数用于操作 STRING
值或创建另一个值的 STRING
表示。
函数 | 签名 | 描述 |
---|---|---|
|
返回去除前导和尾随空格的给定 |
|
|
返回一个 |
|
|
返回给定 |
|
|
返回去除前导空格的给定 |
|
|
标准化 |
|
|
返回一个 |
|
|
返回一个 |
|
|
返回一个 |
|
|
返回去除尾随空格的给定 |
|
|
返回一个 |
|
|
返回给定 |
|
|
返回给定 |
|
|
将 |
|
|
将 |
|
|
返回给定 |
|
|
返回去除前导和/或尾随 |
|
|
返回给定 |
空间函数
这些函数用于在地理或笛卡尔坐标参考系中指定 2D 或 3D 点,并计算两点之间的测地距离。
函数 | 签名 | 描述 |
---|---|---|
|
给定笛卡尔坐标系或 WGS 84 地理坐标系中的两个或三个坐标值,返回 2D 或 3D 点对象。 |
|
|
返回一个 |
|
|
如果提供的点位于由 |
时间持续时间函数
可以使用以下函数创建和操作 时间类型 的 DURATION
值
函数 | 签名 | 描述 |
---|---|---|
|
构造一个 |
|
|
计算 |
|
|
计算 |
|
|
计算 |
|
|
计算 |
时间瞬时类型函数
可以使用以下函数创建和操作 时间类型 的值——DATE
、ZONED TIME
、LOCAL TIME
、ZONED DATETIME
和 LOCAL DATETIME
函数 | 签名 | 描述 |
---|---|---|
|
创建 |
|
|
使用实时时钟返回当前 |
|
|
使用语句时钟返回当前 |
|
|
使用事务时钟返回当前 |
|
|
使用指定单位将给定时间值截断为 |
|
|
创建 |
|
|
给定自纪元开始以来的秒数和纳秒数,创建 |
|
|
给定自纪元开始以来的毫秒数,创建 |
|
|
使用实时时钟返回当前 |
|
|
使用语句时钟返回当前 |
|
|
使用事务时钟返回当前 |
|
|
使用指定单位将给定时间值截断为 |
|
|
创建 |
|
|
使用实时时钟返回当前 |
|
|
使用语句时钟返回当前 |
|
|
使用事务时钟返回当前 |
|
|
使用指定单位将给定时间值截断为 |
|
|
创建 |
|
|
使用实时时钟返回当前 |
|
|
使用语句时钟返回当前 |
|
|
使用事务时钟返回当前 |
|
|
使用指定单位将给定时间值截断为 |
|
|
创建 |
|
|
使用实时时钟返回当前 |
|
|
使用语句时钟返回当前 |
|
|
使用事务时钟返回当前 |
|
|
使用指定单位将给定时间值截断为 |
用户定义函数
用户定义函数用 Java 编写,部署到数据库中,并以与任何其他 Cypher 函数相同的方式调用。可以开发和使用两种主要类型的函数
类型 | 描述 | 用法 | 开发 |
---|---|---|---|
标量 |
对于每一行,函数接受参数并返回结果。 |
||
聚合 |
消耗多行并产生聚合结果。 |