广度优先搜索

词汇表

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

介绍

广度优先搜索算法是一种图遍历算法，给定一个起始节点，它按递增距离的顺序访问节点，请参阅 https://en.wikipedia.org/wiki/Breadth-first_search。一个相关的算法是深度优先搜索算法，深度优先搜索。此算法在搜索时非常有用，因为搜索到的节点的可能性随着距离的增加而降低。遍历支持多种终止条件，基于到达多个目标节点之一、到达最大深度、耗尽给定遍历关系成本的预算，或者仅仅遍历整个图。该过程的输出包含有关哪些节点被访问以及访问顺序的信息。

语法

每个模式的广度优先搜索语法

在流模式下运行广度优先搜索

CALL gds.bfs.stream(
  graphName: string,
  configuration: map
)
YIELD
  sourceNode: int,
  nodeIds: int,
  path: Path

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

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

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

在流模式下运行广度优先搜索

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

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

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

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

在统计模式下运行广度优先搜索

CALL gds.bfs.stats(
  graphName: string,
  configuration: map
)
YIELD
  preProcessingMillis: Integer,
  computeMillis: Integer,
  postProcessingMillis: Integer,
  configuration: Map

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

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

表 9. 结果
名称	类型	描述
preProcessingMillis	整数	预处理图所用的毫秒数。
computeMillis	整数	运行算法所用的毫秒数。
postProcessingMillis	整数	未使用。
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.bfs.stream.estimate('myGraph', {
    sourceNode: source
})
YIELD nodeCount, relationshipCount, bytesMin, bytesMax, requiredMemory
RETURN nodeCount, relationshipCount, bytesMin, bytesMax, requiredMemory

表 10. 结果
nodeCount	relationshipCount	bytesMin	bytesMax	requiredMemory
5	4	536	536	"536 字节"

流

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

有关 stream 模式的一般信息，请参阅流。

以下将运行算法并流式传输结果

MATCH (source:Node{name:'A'})
CALL gds.bfs.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.bfs.stream('myGraph', {
  sourceNode: source,
  targetNodes: targetNodes
})
YIELD path
RETURN path

在下图中，我们可以看到节点的遍历顺序，由关系类型 NEXT 标记。值得注意的是，D 节点未出现在图片中，这是因为算法首先到达了目标节点 E 并终止了执行，导致 D 未被访问。

运行带 maxDepth 的广度优先搜索算法

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

在下图中，我们可以看到节点的遍历顺序，由关系类型 NEXT 标记。节点 D 和 E 未被访问，因为它们与节点 A 的距离为 2。

变异

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

mutate 模式在多个算法结合使用时特别有用。

有关 mutate 模式的一般信息，请参阅变异。

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

以下将以 mutate 模式运行算法

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

表 11. 结果
relationshipsWritten
4

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

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