nGQL命令汇总

• 字符串函数

  函数	说明
  int strcasecmp(string a, string b)	比较两个字符串（不区分大小写）。当a=b时，返回0，当a>b是，返回大于0的数，当a<b时，返回小于0的数。
  string lower(string a)	返回小写形式的字符串。
  string toLower(string a)	和lower()相同。
  string upper(string a)	返回大写形式的字符串。
  string toUpper(string a)	和upper()相同。
  int length(string a)	以字节为单位，返回给定字符串的长度。
  string trim(string a)	删除字符串头部和尾部的空格。
  string ltrim(string a)	删除字符串头部的空格。
  string rtrim(string a)	删除字符串尾部的空格。
  string left(string a, int count)	返回字符串左侧count个字符组成的子字符串。如果count超过字符串a的长度，则返回字符串a。
  string right(string a, int count)	返回字符串右侧count个字符组成的子字符串。如果count超过字符串a的长度，则返回字符串a。
  string lpad(string a, int size, string letters)	在字符串a的左侧填充letters字符串，并返回size长度的字符串。
  string rpad(string a, int size, string letters)	在字符串a的右侧填充letters字符串，并返回size长度的字符串。
  string substr(string a, int pos, int count)	从字符串a的指定位置pos开始（不包括pos位置的字符），提取右侧的count个字符，组成新的字符串并返回。
  string substring(string a, int pos, int count)	和substr()相同。
  string reverse(string)	逆序返回字符串。
  string replace(string a, string b, string c)	将字符串a中的子字符串b替换为字符串c。
  list split(string a, string b)	在子字符串b处拆分字符串a，返回一个字符串列表。
  string toString()	将任意数据类型转换为字符串类型。
  int hash()	获取任意对象的哈希值。

• 函数	说明
  int now()	根据当前系统返回当前时区的时间戳。
  timestamp timestamp()	根据当前系统返回当前时区的时间戳。
  date date()	根据当前系统返回当前日期（UTC时间）。
  time time()	根据当前系统返回当前时间（UTC时间）。
  datetime datetime()	根据当前系统返回当前日期和时间（UTC时间）。

• 列表函数

  函数	说明
  keys(expr)	返回一个列表，包含字符串形式的点、边或映射的所有属性。
  labels(vertex)	返回点的Tag列表。
  nodes(path)	返回路径中所有点的列表。
  range(start, end [, step])	返回[start,end]范围内固定步长的列表，默认步长step为1。
  relationships(path)	返回路径中所有关系的列表。
  reverse(list)	返回将原列表逆序排列的新列表。
  tail(list)	返回不包含原列表第一个元素的新列表.
  head(list)	返回列表的第一个元素。
  last(list)	返回列表的最后一个元素。
  coalesce(list)	返回列表中第一个非空元素。
  reduce()	请参见。

• count函数

  函数	说明
  count()	语法：count({expr | *}) 。 count()返回总行数（包括NULL）。 count(expr)返回满足表达式的非空值的总数。 count()和size()是不同的。

• 函数	说明
  collect()	collect()函数返回一个符合表达式返回结果的列表。该函数可以将多条记录或值合并进一个列表，实现数据聚合。

• reduce函数

  函数	语法	说明
  reduce()	reduce(<accumulator> = <initial>, <variable> IN <list>	reduce()将表达式逐个应用于列表中的元素，然后和累加器中的当前结果累加，最后返回完整结果。

• 函数	说明
  hash()	hash()函数返回参数的哈希值。其参数可以是数字、字符串、列表、布尔值、NULL等类型的值，或者计算结果为这些类型的表达式。hash()函数采用MurmurHash2算法，种子（seed）为0xc70f6907UL。用户可以在MurmurHash2.h中查看其源代码。

• 函数	说明
  concat()	concat()函数至少需要两个或以上字符串参数，并将所有参数连接成一个字符串。 语法：concat(string1,string2,…)

• 函数	说明
  concat_ws()	concat_ws()函数将两个或以上字符串参数与预定义的分隔符（separator）相连接。

• 谓词函数

  谓词函数只返回true或false，通常用于WHERE子句中。

• CASE表达式使用条件来过滤nGQL查询语句的结果，常用于YIELD和RETURN子句中。CASE表达式会遍历所有条件，并在满足第一个条件时停止读取后续条件，然后返回结果。如果不满足任何条件，将通过ELSE子句返回结果。如果没有ELSE子句且不满足任何条件，则返回NULL。

  语法：

  CASE <comparer>
  WHEN <value> THEN <result>
  [WHEN ...]
  [ELSE <default>]
  END

  参数	说明
  comparer	用于与value进行比较的值或者有效表达式。
  value	和comparer进行比较，如果匹配，则满足此条件。
  result	如果value匹配comparer，则返回该result。
  default	如果没有条件匹配，则返回该default。

通用查询语句

• 模式	示例	说明
  匹配点	(v)	用户可以在一对括号中使用自定义变量来表示模式中的点。例如(v)。
  匹配Tag	MATCH (v:player) RETURN v	用户可以在点的右侧用:<tag_name>表示模式中的Tag。
  匹配点的属性	MATCH (v:player{name:”Tim Duncan”}) RETURN v	用户可以在Tag的右侧用{<prop_name>: <prop_value>}表示模式中点的属性。
  匹配单点ID	MATCH (v) WHERE id(v) == ‘player101’ RETURN v	用户可以使用点ID去匹配点。id()函数可以检索点的ID。
  匹配多点ID	MATCH (v:player { name: ‘Tim Duncan’ })—(v2) WHERE id(v2) IN [“player101”, “player102”] RETURN v2	要匹配多个点的ID，可以用WHERE id(v) IN [vid_list]。
  匹配连接的点	MATCH (v:player{name:”Tim Duncan”})—(v2) RETURN v2.name AS Name	用户可以使用—符号表示两个方向的边，并匹配这些边连接的点。用户可以在—符号上增加<或>符号指定边的方向。
  匹配路径	MATCH p=(v:player{name:”Tim Duncan”})—>(v2) RETURN p	连接起来的点和边构成了路径。用户可以使用自定义变量命名路径。
  匹配边	MATCH (v:player{name:”Tim Duncan”})-[e]-(v2) RETURN e	除了用—、—>、<—表示未命名的边之外，用户还可以在方括号中使用自定义变量命名边。例如-[e]-。
  匹配Edge type	MATCH ()-[e:follow]-() RETURN e	和点一样，用户可以用:<edge_type>表示模式中的Edge type，例如-[e:follow]-。
  匹配边的属性	MATCH (v:player{name:”Tim Duncan”})-[e:follow{degree:95}]->(v2) RETURN e	用户可以用{<prop_name>: <prop_value>}表示模式中Edge type的属性，例如[e:follow{likeness:95}]。
  匹配多个Edge type	MATCH (v:player{name:”Tim Duncan”})-[e:follow | :serve]->(v2) RETURN e	使用|可以匹配多个Edge type，例如[e:follow | :serve]。第一个Edge type前的英文冒号（:）不可省略，后续Edge type前的英文冒号可以省略，例如[e:follow | serve]。
  匹配多条边	MATCH (v:player{name:”Tim Duncan”})-[]->(v2)<-[e:serve]-(v3) RETURN v2, v3	用户可以扩展模式，匹配路径中的多条边。
  匹配定长路径	MATCH p=(v:player{name:”Tim Duncan”})-[e:follow2]->(v2) RETURN DISTINCT v2 AS Friends	用户可以在模式中使用:<edge_type><hop>匹配定长路径。hop必须是一个非负整数。
  匹配变长路径	MATCH p=(v:player{name:”Tim Duncan”})-[e:follow1..3]->(v2) RETURN v2 AS Friends	minHop：可选项。表示路径的最小长度。minHop必须是一个非负整数，默认值为1。 maxHop：必选项。表示路径的最大长度。maxHop必须是一个非负整数，没有默认值。
  匹配多个Edge type的变长路径	MATCH p=(v:player{name:”Tim Duncan”})-[e:follow | serve2]->(v2) RETURN DISTINCT v2	用户可以在变长或定长模式中指定多个Edge type。hop、minHop和maxHop对所有Edge type都生效。
  检索点或边的信息	MATCH (v:player{name:”Tim Duncan”}) RETURN v MATCH (v:player{name:”Tim Duncan”})-[e]->(v2) RETURN e	使用RETURN {<vertex_name> | <edge_name>}检索点或边的所有信息。
  检索点ID	MATCH (v:player{name:”Tim Duncan”}) RETURN id(v)	使用id()函数检索点ID。
  检索Tag		使用labels()函数检索点上的Tag列表。 检索列表labels(v)中的第N个元素，可以使用labels(v)[n-1]。
  检索点或边的单个属性	MATCH (v:player{name:”Tim Duncan”}) RETURN v.age	使用RETURN {<vertex_name> | <edge_name>}.<property>检索单个属性。 使用AS设置属性的别名。
  检索点或边的所有属性	MATCH p=(v:player{name:”Tim Duncan”})-[]->(v2) RETURN properties(v2)	使用properties()函数检索点或边的所有属性。
  检索Edge type	MATCH p=(v:player{name:”Tim Duncan”})-[e]->() RETURN DISTINCT type(e)	使用type()函数检索匹配的Edge type。
  检索路径	MATCH p=(v:player{name:”Tim Duncan”})-[3]->() RETURN p	使用RETURN <path_name>检索匹配路径的所有信息。
  检索路径中的点	MATCH p=(v:player{name:”Tim Duncan”})-[]->(v2) RETURN nodes(p)	使用nodes()函数检索路径中的所有点。
  检索路径中的边	MATCH p=(v:player{name:”Tim Duncan”})-[]->(v2) RETURN relationships(p)	使用relationships()函数检索路径中的所有边。
  检索路径长度	MATCH p=(v:player{name:”Tim Duncan”>})-[..2]->(v2) RETURN p AS Paths, length(p) AS Length	使用length()函数检索路径的长度。

• 示例	说明
  GO FROM “player102” OVER serve	返回player102所属队伍。
  GO 2 STEPS FROM “player102” OVER follow	返回距离player102两跳的朋友。
  GO FROM “player100”, “player102” OVER serve WHERE properties(edge).start_year > 1995 YIELD DISTINCT properties($$).name AS team_name, properties(edge).start_year AS start_year, properties($^).name AS player_name	添加过滤条件。
  GO FROM “player100” OVER follow, serve YIELD properties(edge).degree, properties(edge).start_year	遍历多个Edge type。属性没有值时，会显示UNKNOWN_PROP。
  GO FROM “player100” OVER follow REVERSELY YIELD src(edge) AS destination	返回player100入方向的邻居点。
  GO FROM “player100” OVER follow REVERSELY YIELD src(edge) AS id | GO FROM $-.id OVER serve WHERE properties($^).age > 20 YIELD properties($^).name AS FriendOf, properties($$).name AS Team	查询player100的朋友和朋友所属队伍。
  GO FROM “player102” OVER follow YIELD dst(edge) AS both	返回player102所有邻居点。
  GO 2 STEPS FROM “player100” OVER follow YIELD src(edge) AS src, dst(edge) AS dst, properties($$).age AS age | GROUP BY $-.dst YIELD $-.dst AS dst, collect_set($-.src) AS src, collect($-.age) AS age	根据年龄分组。

• FETCH

  FETCH PROP ON {<tag_name>[, tag_name ...] | *} 
  <vid> [, vid ...] 
  [YIELD <return_list> [AS <alias>]]

  示例	说明
  FETCH PROP ON player “player100”	在FETCH语句中指定Tag获取对应点的属性值。
  FETCH PROP ON player “player100” YIELD player.name AS name	使用YIELD子句指定返回的属性。
  FETCH PROP ON player “player101”, “player102”, “player103”	指定多个点ID获取多个点的属性值，点之间用英文逗号（,）分隔。
  FETCH PROP ON player, t1 “player100”, “player103”	在FETCH语句中指定多个Tag获取属性值。Tag之间用英文逗号（,）分隔。
  FETCH PROP ON “player100”, “player106”, “team200”	在FETCH语句中使用获取当前图空间所有标签里，点的属性值。
  FETCH PROP ON serve “player102” -> “player106” YIELD dst(edge)	语法：FETCH PROP ON <edge_type> <src_vid> -> <dst_vid>[@<rank>] [, <src_vid> -> <dst_vid> …] [YIELD <output>]
  FETCH PROP ON serve “player100” -> “team204”	获取连接player100和team204的边serve的所有属性值。
  FETCH PROP ON serve “player100” -> “team204” YIELD serve.start_year	使用YIELD子句指定返回的属性。
  FETCH PROP ON serve “player100” -> “team204”, “player133” -> “team202”	指定多个边模式(<src_vid> -> <dst_vid>[@<rank>])获取多个边的属性值。模式之间用英文逗号（,）分隔。
  FETCH PROP ON serve “player100” -> “team204”@1	要获取rank不为0的边，请在FETCH语句中设置rank。
  GO FROM “player101” OVER follow YIELD follow._src AS s, follow._dst AS d | FETCH PROP ON follow $-.s -> $-.d YIELD follow.degree	返回从点player101开始的follow边的degree值。
  $var = GO FROM “player101” OVER follow YIELD follow._src AS s, follow._dst AS d; FETCH PROP ON follow $var.s -> $var.d YIELD follow.degree	自定义变量构建查询。

• 示例	说明
  UNWIND [1,2,3] AS n RETURN n	拆分列表。
  WITH [1,1,2,2,3,3] AS n UNWIND n AS r WITH DISTINCT r AS r ORDER BY r RETURN collect(r)	1. 拆分列表[1,1,2,2,3,3]。 2. 删除重复行。 3. 排序行。 4. 将行转换为列表。
  MATCH p=(v:player{name:”Tim Duncan”})—(v2) WITH nodes(p) AS n UNWIND n AS r WITH DISTINCT r AS r RETURN collect(r)	1. 将匹配路径上的顶点输出到列表中。 2. 拆分列表。 3. 删除重复行。 4. 将行转换为列表。

• SHOW

  语句	语法	示例	说明
  SHOW CHARSET	SHOW CHARSET	SHOW CHARSET	显示当前的字符集。
  	SHOW COLLATION	SHOW COLLATION	显示当前的排序规则。
  SHOW CREATE SPACE	SHOW CREATE SPACE <space_name>	SHOW CREATE SPACE basketballplayer	显示指定图空间的创建语句。
  	SHOW CREATE {TAG <tag_name> | EDGE <edge_name>}	SHOW CREATE TAG player	显示指定Tag/Edge type的基本信息。
  SHOW HOSTS	SHOW HOSTS [GRAPH | STORAGE | META]	SHOW HOSTS SHOW HOSTS GRAPH	显示Graph、Storage、Meta服务主机信息、版本信息。
  	SHOW {TAG | EDGE} INDEX STATUS	SHOW TAG INDEX STATUS	重建原生索引的作业状态，以便确定重建索引是否成功。
  SHOW INDEXES	SHOW {TAG | EDGE} INDEXES	SHOW TAG INDEXES	列出当前图空间内的所有Tag和Edge type（包括属性）的索引。
  	SHOW PARTS [<part_id>]	SHOW PARTS	显示图空间中指定分片或所有分片的信息。
  SHOW ROLES	SHOW ROLES IN <space_name>	SHOW ROLES in basketballplayer	显示分配给用户的角色信息。
  	SHOW SNAPSHOTS	SHOW SNAPSHOTS	显示所有快照信息。
  SHOW SPACES	SHOW SPACES	SHOW SPACES	显示现存的图空间。
  	SHOW STATS	SHOW STATS	显示最近STATS作业收集的图空间统计信息。
  SHOW TAGS/EDGES	SHOW TAGS | EDGES	SHOW TAGS、SHOW EDGES	显示当前图空间内的所有Tag/Edge type。
  	SHOW USERS	SHOW USERS	显示用户信息。
  SHOW SESSIONS	SHOW SESSIONS	SHOW SESSIONS	显示所有会话信息。
  	SHOW SESSION <Session_Id>	SHOW SESSION 1623304491050858	指定会话ID进行查看。
  SHOW QUERIES	SHOW [ALL] QUERIES	SHOW QUERIES	查看当前Session中正在执行的查询请求信息。
  	SHOW META LEADER	SHOW META LEADER	显示当前Meta集群的leader信息。

子句和选项

图空间语句

Edge type语句

点语句

边语句

• 原生索引

  语句	语法	示例	说明
  CREATE INDEX	CREATE {TAG | EDGE} INDEX [IF NOT EXISTS] <index_name> ON {<tag_name> | <edge_name>} ([<prop_name_list>]) [COMMENT = ‘<comment>’]	CREATE TAG INDEX player_index on player()	对Tag、EdgeType或其属性创建原生索引。
  	SHOW CREATE {TAG | EDGE} INDEX <index_name>	show create tag index index_2	创建Tag或者Edge type时使用的nGQL语句，其中包含索引的详细信息，例如其关联的属性。
  SHOW INDEXES	SHOW {TAG | EDGE} INDEXES	SHOW TAG INDEXES	列出当前图空间内的所有Tag和Edge type（包括属性）的索引。
  	DESCRIBE {TAG | EDGE} INDEX <index_name>	DESCRIBE TAG INDEX player_index_0	查看指定索引的信息，包括索引的属性名称（Field）和数据类型（Type）。
  REBUILD INDEX	REBUILD {TAG | EDGE} INDEX [<index_name_list>]	REBUILD TAG INDEX single_person_index	重建索引。索引功能不会自动对其创建之前已存在的存量数据生效。
  	SHOW {TAG | EDGE} INDEX STATUS	SHOW TAG INDEX STATUS	查看索引名称和对应的状态。
  DROP INDEX	DROP {TAG | EDGE} INDEX [IF EXISTS] <index_name>	DROP TAG INDEX player_index_0	删除当前图空间中已存在的索引。

• 语法	示例	说明
  SIGN IN TEXT SERVICE [(<elastic_ip:port> [,<username>, <password>]), (<elastic_ip:port>), …]	SIGN IN TEXT SERVICE (127.0.0.1:9200)	Nebula Graph的全文索引是基于Elasticsearch实现，部署Elasticsearch集群之后，可以使用SIGN IN语句登录Elasticsearch客户端。
  SHOW TEXT SEARCH CLIENTS	SHOW TEXT SEARCH CLIENTS	列出文本搜索客户端。
  SIGN OUT TEXT SERVICE	SIGN OUT TEXT SERVICE	退出所有文本搜索客户端。
  CREATE FULLTEXT {TAG | EDGE} INDEX <index_name> ON {<tag_name> | <edge_name>} ([<prop_name_list>])	CREATE FULLTEXT TAG INDEX nebula_index_1 ON player(name)	创建全文索引。
  SHOW FULLTEXT INDEXES	SHOW FULLTEXT INDEXES	显示全文索引。
  REBUILD FULLTEXT INDEX	REBUILD FULLTEXT INDEX	重建全文索引。
  DROP FULLTEXT INDEX <index_name>	DROP FULLTEXT INDEX nebula_index_1	删除全文索引。
  LOOKUP ON {<tag> | <edge_type>} WHERE <expression> [YIELD <return_list>]	LOOKUP ON player WHERE FUZZY(player.name, “Tim Dunncan”, AUTO, OR) YIELD player.name	使用查询选项。

子图和路径

查询调优

运维

• BALANCE

  语法	说明
  BALANCE DATA	启动任务均衡分布Nebula Graph集群里的所有分片。该命令会返回任务ID（balance_id）。
  BALANCE DATA <balance_id>	显示BALANCE DATA任务的状态。
  BALANCE DATA STOP	停止BALANCE DATA任务。
  BALANCE DATA REMOVE <host_list>	在Nebula Graph集群中扫描并解绑指定的Storage主机。
  BALANCE LEADER	在Nebula Graph集群中均衡分布leader。

• 语法	说明
  SUBMIT JOB COMPACT	触发RocksDB的长耗时compact操作。
  SUBMIT JOB FLUSH	将内存中的RocksDB memfile写入硬盘。
  SUBMIT JOB STATS	启动一个作业，该作业对当前图空间进行统计。作业完成后，用户可以使用SHOW STATS语句列出统计结果。
  SHOW JOB <job_id>	显示当前图空间内指定作业和相关任务的信息。Meta服务将SUBMIT JOB请求解析为多个任务，然后分配给进程nebula-storaged。
  SHOW JOBS	列出当前图空间内所有未过期的作业。
  STOP JOB	停止当前图空间内未完成的作业。
  RECOVER JOB	重新执行当前图空间内失败的作业，并返回已恢复的作业数量。

• 语法	示例	说明
  KILL QUERY (session=<session_id>, plan=<plan_id>)	KILL QUERY(SESSION=1625553545984255,PLAN=163)	在一个会话中执行命令终止另一个会话中的查询。

最后更新: November 4, 2021