apoc.meta.relTypeProperties

此过程不被认为是多线程安全运行的。因此，并行运行时不支持它。更多信息，请参阅 Cypher 手册 → 并行运行时。

详情
语法	`apoc.meta.relTypeProperties([ 配置 ]) :: (relType, sourceNodeLabels, targetNodeLabels, propertyName, propertyTypes, mandatory, propertyObservations, totalObservations)`
描述	检查整个图并返回一个包含 `RELATIONSHIP` 值信息的元数据表。
输入参数	名称	类型	描述
输入参数	`config`	`MAP`	`{ includeLabels = [] :: LIST<STRING>, includeRels = [] :: LIST<STRING>, excludeLabels = [] :: LIST<STRING>, excludeRels = [] :: LIST<STRING>, sample = 1000 :: INTEGER, maxRels = 100 :: INTEGER }`。默认值为：`{}`。
返回参数	名称	类型	描述
	`relType`	`字符串`	关系的类型。
	`sourceNodeLabels`	`列表<字符串>`	起始节点所属的标签。
	`targetNodeLabels`	`列表<字符串>`	结束节点所属的标签。
	`propertyName`	`字符串`	属性的名称。
	`propertyTypes`	`列表<字符串>`	此属性拥有的类型。
	`mandatory`	`布尔值`	此属性是否在给定类型的所有节点上都存在。
	`propertyObservations`	`整数`	此属性被观测到的次数。
	`totalObservations`	`整数`	标签被看到的总次数。

配置参数

此过程支持以下配置参数

配置参数
名称	类型	默认	描述
`includeLabels`	`列表<字符串>`	[]	要包含的节点标签。默认是包含所有节点标签。
`includeRels`	`列表<字符串>`	[]	要包含的关系类型。默认是包含所有关系类型。
`excludeLabels`	`列表<字符串>`	[]	要排除的节点标签。默认是包含所有节点标签。
`excludeRels`	`列表<字符串>`	[]	要排除的关系类型。默认是包含所有关系类型。
`sample`	`整数`	1000	要采样的节点数量。将 `sample` 设置为 `-1` 将移除采样。
`maxRels`	`整数`	100	每个采样节点要读取的关系数量。

采样

指定 sample 参数（默认为 1000）以分析数据的子集。

采样以及每个标签的节点计数用于计算跳过值。由于此值是使用随机数生成器生成的，因此通过采样方法获得的结果在后续运行之间可能会有所不同。

示例 1. 计算数据采样的跳过计数

如果数据库包含 500 个带有 Foo 标签的节点，则该标签的跳过计数计算如下

每个节点标签的跳过计数是通过在 (totalNodesForLabel / sample) ± 0.1 之间生成一个随机数来确定的。

采样 10：skipCount = 500 / 10 = 50
最终的跳过计数将在 45 到 55 之间。

采样 50：skipCount = 500 / 50 = 10
最终的跳过计数将在 9 到 11 之间。

采样 100：skipCount = 500 / 100 = 5
最终的跳过计数将是 5。

跳过计数表示在检查一个节点之前跳过的节点数量。例如，跳过计数为 5 时，每第 5 个节点会被检查。因此，更高的采样数量会导致更多节点被采样。

要停止采样，请设置 sample: -1。

已弃用参数
名称	类型	默认	描述
`labels`	`列表<字符串>`	[]	已弃用，请使用 `includeLabels`。
`rels`	`列表<字符串>`	[]	已弃用，请使用 `includeRels`。
`excludes`	`列表<字符串>`	[]	已弃用，请使用 `excludeLabels`。

使用示例

本节中的示例基于以下示例图

CREATE (Keanu:Person {name:'Keanu Reeves', born:1964})
CREATE (TomH:Person {name:'Tom Hanks', born:1956})
CREATE (LillyW:Person {name:'Lilly Wachowski', born:1967})

CREATE (TheMatrix:Movie {title:'The Matrix', released:1999, tagline:'Welcome to the Real World'})
CREATE (TheMatrixReloaded:Movie {title:'The Matrix Reloaded', released:2003, tagline:'Free your mind'})
CREATE (TheMatrixRevolutions:Movie {title:'The Matrix Revolutions', released:2003, tagline:'Everything that has a beginning has an end'})
CREATE (SomethingsGottaGive:Movie {title:"Something's Gotta Give", released:2003})
CREATE (TheDevilsAdvocate:Movie {title:"The Devil's Advocate", released:1997, tagline:'Evil has its winning ways'})

CREATE (YouveGotMail:Movie {title:"You've Got Mail", released:1998, tagline:'At odds in life... in love on-line.'})
CREATE (SleeplessInSeattle:Movie {title:'Sleepless in Seattle', released:1993, tagline:'What if someone you never met, someone you never saw, someone you never knew was the only someone for you?'})
CREATE (ThatThingYouDo:Movie {title:'That Thing You Do', released:1996, tagline:'In every life there comes a time when that thing you dream becomes that thing you do'})
CREATE (CloudAtlas:Movie {title:'Cloud Atlas', released:2012, tagline:'Everything is connected'})

CREATE (Keanu)-[:ACTED_IN {roles:['Neo']}]->(TheMatrix)
CREATE (Keanu)-[:ACTED_IN {roles:['Neo']}]->(TheMatrixReloaded)
CREATE (Keanu)-[:ACTED_IN {roles:['Neo']}]->(TheMatrixRevolutions)
CREATE (Keanu)-[:ACTED_IN {roles:['Julian Mercer']}]->(SomethingsGottaGive)
CREATE (Keanu)-[:ACTED_IN {roles:['Kevin Lomax']}]->(TheDevilsAdvocate)

CREATE (TomH)-[:ACTED_IN {roles:['Joe Fox']}]->(YouveGotMail)
CREATE (TomH)-[:ACTED_IN {roles:['Sam Baldwin']}]->(SleeplessInSeattle)
CREATE (TomH)-[:ACTED_IN {roles:['Mr. White']}]->(ThatThingYouDo)
CREATE (TomH)-[:ACTED_IN {roles:['Zachry', 'Dr. Henry Goose', 'Isaac Sachs', 'Dermot Hoggins']}]->(CloudAtlas)

CREATE (LillyW)-[:DIRECTED]->(TheMatrix);

我们可以通过运行以下查询，从数据库内容的样本中返回数据库的元数据

CALL apoc.meta.relTypeProperties();

结果
relType	sourceNodeLabels	targetNodeLabels	propertyName	propertyTypes	mandatory	propertyObservations	totalObservations
":`ACTED_IN`"	["Person"]	["Movie"]	"roles"	["StringArray"]	FALSE	9	9
":`DIRECTED`"	["Person"]	["Movie"]	NULL	NULL	FALSE	0	1

我们可以通过指定 rels 配置参数来返回关系类型的子集的元数据。以下返回 ACTED_IN 标签的元数据

CALL apoc.meta.relTypeProperties({rels: ["ACTED_IN"]});

结果
relType	sourceNodeLabels	targetNodeLabels	propertyName	propertyTypes	mandatory	propertyObservations	totalObservations
":`ACTED_IN`"	["Person"]	["Movie"]	"roles"	["StringArray"]	FALSE	9	9

我们可以通过指定 maxRels 参数来控制采样的关系数量。以下返回基于每种关系类型最多采样 3 个关系的元数据

CALL apoc.meta.relTypeProperties({maxRels: 3});

结果
relType	sourceNodeLabels	targetNodeLabels	propertyName	propertyTypes	mandatory	propertyObservations	totalObservations
":`ACTED_IN`"	["Person"]	["Movie"]	"roles"	["StringArray"]	FALSE	3	9
":`DIRECTED`"	["Person"]	["Movie"]	NULL	NULL	FALSE	0	1