RETURN

概述

使用语句RETURN可以指定需包含在最终输出中的项。各项由一个表达式定义，可以包括别名、属性、函数、常量等。

所有UQL查询，除图集管理、数据修改和其他特定用途的查询外，必须以RETURN语句结尾。只有LIMIT语句可以跟在RETURN语句之后，为各返回项保留指定数量的记录，并舍弃其余记录。

语法

RETURN <item1> as <alias1?>, <item2?> as <alias2?>, ...

详情

• RETURN语句必须包含至少一个项目。
• 各返回项的默认别名是返回项表达式本身。可使用别名重命名返回项。
• 在每个返回项表达式中，可以引用前面的语句中声明的别名。更多细节请参阅在RETURN中引用别名。
• 每个返回项对应以下结果类型的一种：
  • RESULT_TYPE_NODE
  • RESULT_TYPE_EDGE
  • RESULT_TYPE_PATH
  • RESULT_TYPE_ATTR
  • RESULT_TYPE_TABLE

示例图集

在一个空图集中，逐行运行以下语句，创建示例图集：

create().node_schema("Student").node_schema("Course").edge_schema("Take")
create().node_property(@Student,"name").node_property(@Student,"gender").node_property(@Course,"name").node_property(@Course,"credit",int32).edge_property(@Take, "year", int32).edge_property(@Take, "term")
insert().into(@Student).nodes([{_id:"s1", name:"Alex", gender:"male"}, {_id:"s2", name:"Susan", gender:"female"}])
insert().into(@Course).nodes([{_id:"c1", name:"Art", credit:13}, {_id:"c2", name:"Literature", credit:15}])
insert().into(@Take).edges([{_from:"s1", _to:"c1", year: 2024, term: "Spring"}, {_from:"s2", _to:"c1", year: 2023, term: "Fall"}, {_from:"s2", _to:"c2", year: 2023, term: "Spring"}])

返回点

返回每个点的schema和所有属性：

find().nodes({@Course}) as n
return n{*} 

结果：n

返回每个点的schema和系统属性：

find().nodes({@Course}) as n
return n

结果：n

返回边

返回每条边的schema和所有属性：

find().edges() as e
return e{*}

结果：e

返回每条边的schema和所有系统属性：

find().edges() as e
return e

结果：e

返回路径

返回每条路径中的点和边（包括点和边的schema和属性信息），以及路径长度：

n().re({@Take.term == "Spring"}).n() as p
return p{*}

结果：

返回每条路径中的点和边（包括点和边的schema和系统属性信息），以及路径长度：

n().re({@Take.term == "Spring"}).n() as p
return p

结果：

返回schema

n({_id == "s2"}).e(as e).n(as n)
return e.@, n.@

结果：

返回属性

使用英文句号.，可以从代表点或边的别名中提取指定属性值。如果未发现点或边的指定属性，则返回null值。

n({@Student.name == "Susan"}).re().n({@Course} as c)
return c.name, c.credit, c.type

结果：

可使用一组花括号{}从点、边或路径中提取多个属性信息。更多信息请参阅在RETURN中引用别名。

n({@Student.name == "Susan"}).re().n({@Course} as c)
return c{name, credit}

结果：c

返回表

可使用table()函数，指定返回项作为列，构建输出表。

n({@Student} as s).re().n({@Course} as c)
return table(s.name, c.name)

结果：

返回各项别名

n({@Student} as s).re(as t).n({@Course} as c)
return s.name as Student, c.name as Course, t.year as TakenIn

结果：

返回去重记录

可使用DISTINCT运算符对记录去重。

n().e(as e).n()
return distinct e.year

结果：

返回聚合结果

聚合函数，如sum()和max()，可以直接应用于RETURN语句。

n({@Student.name == "Susan"}).re().n({@Course} as c)
return sum(c.credit)

结果：

根据CASE返回结果

CASE函数可以直接应用于RETURN语句。

n({@Course} as n)
return n.name as Course, case when n.credit > 14 then "Y" else "N" end as Recommended

结果：

返回指定条记录

可使用LIMIT语句限制返回的记录条数：

find().nodes({@Course}) as n
return n.name limit 1

结果：

返回有序记录

可使用ORDER BY语句，根据指定值对记录排序。查询中，ORDER BY必须出现在RETURN statement之前。

n({@Course} as n)
order by n.credit desc
return n{*}

结果：n

返回异源数据

如果RETURN语句中引用的别名是异源的，则会生成笛卡尔积。更多详情请参阅异源数据。

find().nodes({@Course}) as c
find().nodes({@Student}) as s
return c.name, s.name

结果：

在RETURN中引用别名

NODE类型

find().nodes({@city}) as n
return n

别名n是NODE类型，以下示例为RETURN语句引用别名时的情况：

EDGE类型

find().edges({@transfers}) as e
return e

别名e是EDGE类型，以下示例为RETURN语句引用别名时的情况：

PATH类型

n().e()[:5].n() as p
return p

别名p是PATH类型，以下示例为RETURN语句引用别名时的情况：

List类型

uncollect [[1,2,3,4,5], [4,5,6,7,8]] as lists
return lists

别名lists代表的每条记录都是list类型，以下示例为RETURN语句引用别名时的情况：

Point类型

find().nodes({@city}) as n
with n.location as points
return points

属性location为point类型，别名points用来代表属性location，以下示例为RETURN语句引用别名时的情况：

其他原子类型

原子类型，又称基础数据类型，如整数、小数和字符串，均无法拆分成更小成分。原子类型的别名只能被直接引用，因为无法从其表示的数据中进一步提取信息。

find().nodes({@city}) as n
with n.name as names
return upper(names)