深度优先搜索

此功能在 Aura Graph Analytics Serverless 中不可用。

有向

无向

异构节点

异构关系

加权关系

词汇表

有向: 有向特性。该算法在有向图上定义良好。
有向: 有向特性。该算法忽略图的方向。
有向: 有向特性。该算法不在有向图上运行。
无向: 无向特性。该算法在无向图上定义良好。
无向: 无向特性。该算法忽略图的无向性。
异构节点: 异构节点完全支持。该算法能够区分不同类型的节点。
异构节点: 异构节点允许。该算法无论节点的标签如何，都以相似的方式处理所有选定的节点。
异构关系: 异构关系完全支持。该算法能够区分不同类型的关系。
异构关系: 异构关系允许。该算法无论关系的类型如何，都以相似的方式处理所有选定的关系。
加权关系: 加权特性。该算法支持将关系属性用作权重，通过relationshipWeightProperty配置参数指定。
加权关系: 加权特性。该算法将每个关系视为同等重要，忽略任何关系权重的值。

简介

深度优先搜索算法是一种图遍历算法，从给定节点开始，尽可能沿每条分支深入探索，然后回溯，请参阅https://en.wikipedia.org/wiki/Depth-first_search。一个相关算法是广度优先搜索算法，请参阅广度优先搜索。例如，当需要查找距离较远的目标节点且探索随机路径成功概率较高时，该算法可能优于广度优先搜索。遍历支持多种终止条件，例如达到一个或多个目标节点、达到最大深度、耗尽给定遍历关系成本预算，或者仅仅遍历整个图。该过程的输出包含有关哪些节点被访问以及访问顺序的信息。

语法

按模式划分的深度优先搜索语法

以流模式运行深度优先搜索

CALL gds.dfs.stream(
  graphName: String,
  configuration: Map
)
YIELD
  sourceNode: Integer,
  nodeIds: Integer,
  path: Path

表 1. 参数
名称	类型	默认值	可选	描述
graphName	字符串	`不适用`	否	存储在目录中的图的名称。
configuration	映射	`{}`	是	算法特定和/或图过滤的配置。

表 2. 配置
名称	类型	默认值	可选	描述
nodeLabels	字符串列表	`['*']`	是	使用给定节点标签过滤命名图。将包含具有任何给定标签的节点。
relationshipTypes	字符串列表	`['*']`	是	使用给定关系类型过滤命名图。将包含具有任何给定类型的关系。
concurrency	整数	`1`	是	该算法是单线程的，更改并发参数对运行时没有影响。
jobId	字符串	`内部生成`	是	可提供以更轻松地跟踪算法进度的 ID。
logProgress	布尔值	`true`	是	如果禁用，将不会记录进度百分比。
sourceNode	整数	`不适用`	否	开始遍历的节点的节点 ID。
targetNodes	整数列表	`空列表`	是	目标节点的 ID。当访问任何目标节点时，遍历终止。
maxDepth	整数	`-1`	是	从源节点开始访问节点的最大距离。

表 3. 结果
名称	类型	描述
sourceNode	整数	开始遍历的节点的节点 ID。
nodeIds	整数列表	遍历期间访问的所有节点的 ID。
path	路径	包含遍历期间访问的所有节点的路径。

以流模式运行深度优先搜索

CALL gds.dfs.mutate(
  graphName: string,
  configuration: map
)
YIELD
  relationshipsWritten: Integer,
  preProcessingMillis: Integer,
  computeMillis: Integer,
  postProcessingMillis: Integer,
  mutateMillis: Integer,
  configuration: Map

表 4. 参数
名称	类型	默认值	可选	描述
graphName	字符串	`不适用`	否	存储在目录中的图的名称。
configuration	映射	`{}`	是	算法特定和/或图过滤的配置。

表 5. 配置
名称	类型	默认值	可选	描述
nodeLabels	字符串列表	`['*']`	是	使用给定节点标签过滤命名图。将包含具有任何给定标签的节点。
relationshipTypes	字符串列表	`['*']`	是	使用给定关系类型过滤命名图。将包含具有任何给定类型的关系。
concurrency	整数	`1`	是	该算法是单线程的，更改并发参数对运行时没有影响。
jobId	字符串	`内部生成`	是	可提供以更轻松地跟踪算法进度的 ID。
logProgress	布尔值	`true`	是	如果禁用，将不会记录进度百分比。
sourceNode	整数	`不适用`	否	开始遍历的节点的节点 ID。
targetNodes	整数列表	`空列表`	是	目标节点的 ID。当访问任何目标节点时，遍历终止。
maxDepth	整数	`-1`	是	从源节点开始访问节点的最大距离。
mutateRelationshipType	字符串	`不适用`	否	用于写入投影图的新关系的关系类型。

表 6. 结果
名称	类型	描述
preProcessingMillis	整数	图预处理的毫秒数。
computeMillis	整数	运行算法的毫秒数。
postProcessingMillis	整数	未使用。
mutateMillis	整数	向投影图添加关系的毫秒数。
relationshipsWritten	整数	添加的关系数量。
configuration	映射	用于运行算法的配置。

示例

以下所有示例都应在空数据库中运行。

这些示例通常使用Cypher 投影。原生投影将在未来的版本中弃用。

在本节中，我们将展示在具体图上运行深度优先搜索算法的示例。目的是说明结果是什么样子，并提供如何在实际设置中使用该算法的指南。我们将在一个小型图上进行此操作，该图包含少量按特定模式连接的节点。示例图如下所示：

考虑以下 Cypher 语句投影的图：

CREATE
       (nA:Node {name: 'A'}),
       (nB:Node {name: 'B'}),
       (nC:Node {name: 'C'}),
       (nD:Node {name: 'D'}),
       (nE:Node {name: 'E'}),

       (nA)-[:REL]->(nB),
       (nA)-[:REL]->(nC),
       (nB)-[:REL]->(nE),
       (nC)-[:REL]->(nD)

以下语句将投影图并将其存储在图目录中。

MATCH (source:Node)-[r:REL]->(target:Node)
RETURN gds.graph.project(
  'myGraph',
  source,
  target
)

在以下示例中，我们将演示在此图上使用深度优先搜索算法。

内存估算

首先，我们将使用 estimate 过程估算运行算法的成本。这可以在任何执行模式下完成。在本例中，我们将使用 stream 模式。估算算法有助于了解在图上运行算法将产生的内存影响。当您稍后实际以某种执行模式运行算法时，系统将执行估算。如果估算显示执行超出其内存限制的可能性非常高，则禁止执行。要了解更多信息，请参阅自动估算和执行阻止。

有关 estimate 的更多详细信息，请参阅内存估算。

以下将估算在流模式下运行算法的内存要求

MATCH (source:Node {name: 'A'})
CALL gds.dfs.stream.estimate('myGraph', {
  sourceNode: source
})
YIELD nodeCount, relationshipCount, bytesMin, bytesMax, requiredMemory
RETURN nodeCount, relationshipCount, bytesMin, bytesMax, requiredMemory

表 7. 结果
nodeCount	relationshipCount	bytesMin	bytesMax	requiredMemory
5	4	352	352	"352 字节"

流

在 stream 执行模式下，算法以遍历顺序返回每个关系的路径。这允许我们直接检查结果或在 Cypher 中对其进行后处理，而不会产生任何副作用。

有关 stream 模式的更多详细信息，请参阅流。

运行深度优先搜索算法

MATCH (source:Node{name:'A'})
CALL gds.dfs.stream('myGraph', {
  sourceNode: source
})
YIELD path
RETURN path

如果我们不指定任何提前终止选项，算法将遍历整个图：在下图中，我们可以看到节点的遍历顺序，由关系类型 NEXT 标记

使用目标节点运行深度优先搜索算法

MATCH (source:Node{name:'A'}), (d:Node{name:'D'}), (e:Node{name:'E'})
WITH source, [d, e] AS targetNodes
CALL gds.dfs.stream('myGraph', {
  sourceNode: source,
  targetNodes: targetNodes
})
YIELD path
RETURN path

如果将节点 D 和 E 指定为目标节点，则由于深度优先遍历顺序（其中节点 D 在 B 之前到达），距离为 1 的所有节点将不会被访问。

使用 maxDepth 运行深度优先搜索算法

MATCH (source:Node{name:'A'})
CALL gds.dfs.stream('myGraph', {
  sourceNode: source,
  maxDepth: 1
})
YIELD path
RETURN path

在上述情况下，节点 D 和 E 未被访问，因为它们与节点 A 的距离为 2。

变异

mutate 执行模式使用新关系更新命名图。从深度优先搜索算法返回的路径是一个线图，其中节点按算法访问它们的顺序出现。关系类型必须使用 mutateRelationshipType 选项进行配置。

当多个算法协同使用时，mutate 模式特别有用。

有关 mutate 模式的更多详细信息，请参阅变异。

深度优先搜索 mutate 支持与 stream 模式相同的提前终止条件。

以下将以 mutate 模式运行算法

MATCH (source:Node{name:'A'})
CALL gds.dfs.mutate('myGraph', {
  sourceNode: source,
  mutateRelationshipType: 'DFS'
})
YIELD relationshipsWritten
RETURN relationshipsWritten

表 8. 结果
relationshipsWritten
4

执行上述查询后，内存图将使用类型为 DFS 的新关系进行更新。

生成的关系始终是有向的，即使输入图是无向的。