什么是nGQL

nGQL（Nebula Graph Query Language）是Nebula Graph使用的的声明式图查询语言，支持灵活高效的图模式，而且nGQL是为开发和运维人员设计的类SQL查询语言，易于学习。

nGQL是一个进行中的项目，会持续发布新特性和优化，因此可能会出现语法和实际操作不一致的问题，如果遇到此类问题，请提交issue通知Nebula Graph团队。Nebula Graph 2.0及更新版本正在支持openCypher 9。

nGQL可以做什么

  • 支持图遍历

  • 支持模式匹配

  • 支持聚合

  • 支持修改图

  • 支持访问控制

  • 支持聚合查询

  • 支持索引

  • 支持大部分openCypher 9图查询语法（不支持修改和控制语法）

示例数据 Basketballplayer

用户可以下载Nebula Graph示例数据basketballplayer文件，然后使用Nebula Graph Console，使用选项-f执行脚本。

占位标识符和占位符值

Nebula Graph查询语言nGQL参照以下标准设计：

  • (Draft) ISO/IEC JTC1 N14279 SC 32 - Database_Languages - GQL

  • (Draft) ISO/IEC JTC1 SC32 N3228 - SQL_Property_Graph_Queries - SQLPGQ

  • OpenCypher 9

在模板代码中，任何非关键字、字面值或标点符号的标记都是占位符标识符或占位符值。

本文中 nGQL 语法符号的说明如下。

符号含义
< >语法元素的名称。
::=定义元素的公式。
[ ]可选元素。
{ }显式的指定元素。
|所有可选的元素。
…可以重复多次。

例如创建点或边的nGQL语法：

  1. CREATE {TAG | EDGE} {<tag_name> | <edge_type>}(<property_name> <data_type>
  2. [, <property_name> <data_type> ...]);

示例语句：

  1. nebula> CREATE TAG player(name string, age int);

关于openCypher兼容性

原生 nGQL 和 openCypher 的关系

原生 nGQL 是由 Nebula Graph 自行创造和实现的图查询语言。OpenCypher 是由 openCypher Implementers Group 组织所开源和维护的图查询语言，

最新版本为 openCypher 9。由于 nGQL 语言部分兼容了 openCypher，这个部分在本文中称为 openCypher 兼容语句。

Note

nGQL 语言 = 原生 nGQL 语句 + openCypher 兼容语句

行为未定义

不要在同一个复合语句中，同时使用原生 nGQL 语句和openCypher 兼容语句，其行为是未定义的。

nGQL 完全兼容 openCypher 9吗？

不。

nGQL 部分兼容 openCypher 9 的 DQL

nGQL 设计目标为兼容部分 DQL（match）。不计划兼容任何 DDL，DML，DCL。

在Nebula Graph Issues中已经列出已知的多处不兼容项。如果发现这种类型的新问题，请提交问题并附带incompatible标签。在本文搜索”compatibility”或者“兼容性”查看具体不兼容细节。

nGQL 和 openCypher 9的 主要差异有哪些？

类别openCypher 9nGQL
Schema弱Schema强Schema
相等运算符===
数学求幂^使用pow(x, y)替代^。
边Rank无此概念用@rank设置。
语句-不支持 openCypher 9 的所有 DML 语句（如CREATE、MERGE等），不支持所有的 DCL， 和支持部分 MATCH 语法和函数（不支持OPTIONAL MATCH，不支持多MATCH，不支持 WHERE 中使用图 pattern）。
语句文本换行换行符\ + 换行符
Label与Tag是不同的概念Label用于寻找点（点的索引）。Tag用于定义点的一种类型及相应的属性，无索引功能。
预编译与参数化查询支持不支持

Compatibility

请注意openCypher 9和Cypher在语法和许可上有不同:

  1. Cypher要求所有Cypher语句必须“显式地在一个事务中”执行，而openCypher没有这样的要求。另外，nGQL 没有事务及隔离性。

  2. Cypher 企业版功能有多种的约束（constraints），包括 Unique node property constraints、Node property existence constraints、Relationship property existence constraints、Node key constraints。 OpenCypher 标准中没有约束。 而 nGQL 是强 Schema 系统，前述的约束大多通过 Schema 定义可实现（包括 NOT NULL），唯一不能支持的功能是“属性值唯一性”（UNIQUE constraint）。

  3. Cypher 有 APoC，openCypher 9 没有 APoC。Cypher 有 Blot 协议支持要求， openCypher 9 没有。

哪里可以找到更多nGQL的示例？

用户可以在Nebula Graph GitHub的features目录内查看超过2500条nGQL示例。

features目录内包含很多.features格式的文件，每个文件都记录了使用nGQL的场景和示例。例如：

  1. Feature: Basic match
  3.   Background:
  4.     Given a graph with space named "basketballplayer"
  6.   Scenario: Single node
  7.     When executing query:
  8.       """
  9.       MATCH (v:player {name: "Yao Ming"}) RETURN v;
  10.       """
  11.     Then the result should be, in any order, with relax comparison:
  12.       | v                                                |
  13.       | ("player133" :player{age: 38, name: "Yao Ming"}) |
  15.   Scenario: One step
  16.     When executing query:
  17.       """
  18.       MATCH (v1:player{name: "LeBron James"}) -[r]-> (v2)
  19.       RETURN type(r) AS Type, v2.name AS Name
  20.       """
  21.     Then the result should be, in any order:
  23.       | Type     | Name        |
  24.       | "follow" | "Ray Allen" |
  25.       | "serve"  | "Lakers"    |
  26.       | "serve"  | "Heat"      |
  27.       | "serve"  | "Cavaliers" |
  29. Feature:  Comparison of where clause
  31.   Background:
  32.     Given a graph with space named "basketballplayer"
  34.     Scenario: push edge props filter down
  35.       When profiling query:
  36.         """
  37.         GO FROM "player100" OVER follow 
  38.         WHERE properties(edge).degree IN [v IN [95,99] WHERE v > 0] 
  39.         YIELD dst(edge), properties(edge).degree
  40.         """
  41.       Then the result should be, in any order:
  42.         | follow._dst | follow.degree |
  43.         | "player101" | 95            |
  44.         | "player125" | 95            |
  45.       And the execution plan should be:
  46.         | id | name         | dependencies | operator info                                                         |
  47.         | 0  | Project      | 1            |                                                                       |
  48.         | 1  | GetNeighbors | 2            | {"filter": "(properties(edge).degree IN [v IN [95,99] WHERE (v>0)])"} |
  49.         | 2  | Start        |              |                                                                       |

示例中的关键字说明如下。

关键字说明
Feature描述当前文档的主题。
Background描述当前文档的背景信息。
Given描述执行示例语句的前提条件。
Scenario描述具体场景。如果场景之前有@skip标识，表示这个场景下示例语句可能无法正常工作，请不要在生产环境中使用该示例语句。
When描述要执行的nGQL示例语句。可以是executing query或profiling query。
Then描述执行When内语句的预期返回结果。如果返回结果和文档不同，请提交issue通知Nebula Graph团队。
And描述执行When内语句的副作用或执行计划。
@skip跳过这个示例。通常表示测试代码还没有准备好。

欢迎增加更多 tck case，在 CI/CD 中自动回归所使用的语句。

是否支持TinkerPop Gremlin？

不支持。也没有计划。

是否支持 W3C 的RDF（SPARQL） 或 GraphQL 等？

不支持。也没有计划。

Nebula Graph的数据模型是属性图，是一个强Schema系统，不支持RDF标准。

nGQL 也不支持 SPARQL 和 GraphQL。

最后更新: October 22, 2021