Azure Cosmos DB for Gremlin 图形支持并兼容 TinkerPop 功能

适用对象： Gremlin

Azure Cosmos DB 支持 Apache Tinkerpop 的图形遍历语言（称为 Gremlin）。 可以使用 Gremlin 语言创建图形实体（顶点和边缘）、修改这些实体内部的属性、执行查询和遍历，以及删除实体。

Azure Cosmos DB Graph 引擎严格遵循 Apache TinkerPop 遍历步骤规范，但在实现中存在特定于 Azure Cosmos DB 的差异。 本文提供 Gremlin 的快速演练，并列举了 API for Gremlin 支持的 Gremlin 功能。

兼容的客户端库

下表显示可以对 Azure Cosmos DB 使用的常用 Gremlin 驱动程序：

支持的图对象

TinkerPop 是涵盖多种图形技术的标准。 因此，它使用标准的术语来描述图形提供程序提供的功能。 Azure Cosmos DB 提供一个可跨多个服务器或群集分区的持久性、高并发性、可写的图形数据库。

下表列出了 Azure Cosmos DB 实现的 TinkerPop 功能：

Gremlin 网络格式

从 Gremlin 操作返回结果时，Azure Cosmos DB 使用 JSON 格式。 Azure Cosmos DB 目前支持 JSON 格式。 例如，以下代码片段显示了从 Azure Cosmos DB 返回到客户端的某个顶点的 JSON 表示形式。

  {
    "id": "a7111ba7-0ea1-43c9-b6b2-efc5e3aea4c0",
    "label": "person",
    "type": "vertex",
    "outE": {
      "knows": [
        {
          "id": "3ee53a60-c561-4c5e-9a9f-9c7924bc9aef",
          "inV": "04779300-1c8e-489d-9493-50fd1325a658"
        },
        {
          "id": "21984248-ee9e-43a8-a7f6-30642bc14609",
          "inV": "a8e3e741-2ef7-4c01-b7c8-199f8e43e3bc"
        }
      ]
    },
    "properties": {
      "firstName": [
        {
          "value": "Thomas"
        }
      ],
      "lastName": [
        {
          "value": "Andersen"
        }
      ],
      "age": [
        {
          "value": 45
        }
      ]
    }
  }

下面介绍了顶点的 JSON 格式使用的属性：

每个属性可在一个数组中存储多个值。

边缘包含以下信息，以方便导航到图形的其他部件。

Gremlin 的步骤

现在，让我们了解 Azure Cosmos DB 支持的 Gremlin 步骤。 有关 Gremlin 的完整参考信息，请参阅 TinkerPop 参考。

Azure Cosmos DB 提供的写入优化引擎默认支持自动对顶点和边缘中的所有属性编制索引。 因此，使用筛选器、范围查询、排序或聚合对任何属性执行的查询将从索引处理，并可有效完成。 有关 Azure Cosmos DB 中索引编制的工作原理的详细信息，请参阅有关架构不可知的索引编制的文章。

行为差异

• Azure Cosmos DB Graph 引擎运行“广度优先”遍历，而 TinkerPop Gremlin 则是深度优先。 这种行为在像 Azure Cosmos DB 这样的水平缩放系统中可实现更好的性能。

不支持的功能

• Gremlin 字节码是与编程语言无关的图遍历规范。 Azure Cosmos DB Graph 尚不支持它。 请使用 GremlinClient.SubmitAsync() 并以文本字符串的形式传递遍历。

• property(set, 'xyz', 1) 目前不支持集基数。 请改用 property(list, 'xyz', 1)。 若要了解详细信息，请参阅 TinkerPop 的顶点属性。

• match() 步骤当前不可用。 此步骤提供声明性查询功能。

• 在顶点或边缘，不支持对象作为属性。 属性只能是基元类型或数组。

• 不支持按数组属性排序 order().by(<array property>)。 只支持按基元类型排序。

• 不支持非基元 JSON 类型。 使用 string、number 或 true/false 类型。 不支持 null 值。

• 当前不支持 GraphSONv3 序列化程序。 在连接配置中使用 GraphSONv2 Serializer、Reader 和 Writer 类。 Azure Cosmos DB for Gremlin 返回的结果的格式与 GraphSON 格式不同。

• 目前不支持 Lambda 表达式和函数。 这包括 .map{<expression>}、.by{<expression>} 和 .filter{<expression>} 函数。 若要了解详细信息，并了解如何使用 Gremlin 步骤重写这些函数，请参阅关于 Lambda 的说明。

• 由于系统的分布式特性，因此事务不受支持。 在 Gremlin 帐户上配置适当的一致性模型以“读取自己的写入”，并使用乐观并发解决冲突的写入。

已知的限制

• 使用中间遍历 .V() 步骤的 Gremlin 查询的索引利用：目前，只有遍历的第一次 .V() 调用将使用索引来解析附加到它的任何筛选器或谓词。 后续调用将不会访问索引，因为这可能会增加查询的延迟和成本。

假设使用默认索引，以 .V() 步骤开始的典型读取 Gremlin 查询将在其附加的筛选步骤中使用参数，例如 .has() 或 .where()，以优化查询的成本和性能。 例如：

g.V().has('category', 'A')

但是，当 Gremlin 查询中包含多个 .V() 步骤时，查询的数据解析可能达不到最优效果。 以下列查询为例：

g.V().has('category', 'A').as('a').V().has('category', 'B').as('b').select('a', 'b')

此查询将根据名为 category 的属性返回两组顶点。 在这种情况下，只有第一次调用 g.V().has('category', 'A') 将使用索引根据其属性值解析顶点。

对于此查询，一个解决方法是使用 .map() 和 union() 等子遍历步骤。 下面来举例说明：

// Query workaround using .map()
g.V().has('category', 'A').as('a').map(__.V().has('category', 'B')).as('b').select('a','b')

// Query workaround using .union()
g.V().has('category', 'A').fold().union(unfold(), __.V().has('category', 'B'))

可以使用 Gremlin executionProfile() 步骤查看查询的性能。

后续步骤

• 开始使用我们的 SDK 构建图形应用程序
• 详细了解 Azure Cosmos DB 中的图形支持