apoc.meta.nodes.count

Function APOC Core

apoc.meta.nodes.count([labels], $config) - Returns the sum of the nodes with a label present in the list.

Signature

apoc.meta.nodes.count(nodes = [] :: LIST? OF STRING?, config = {} :: MAP?) :: (INTEGER?)

Input parameters

Name	Type	Default
nodes	LIST? OF STRING?	[]
config	MAP?	{}

Name

Type

Default

nodes

LIST? OF STRING?

[]

config

MAP?

{}

Config parameters

This procedure supports the following config parameters:

Table 1. Config parameters
Name	Type	Default	Description
includeRels	List<String>	[]	Relationship types to include. Default is to include all relationship types. Add the suffix `>` or `<` to the relationship type name to indicate an outgoing or incoming relationship.

Table 2. Deprecated parameters
Name	Type	Default	Description
rels	List<String>	[]	deprecated, use `includeRels`

Usage Examples

The examples in this section are based on the following sample graph:

CREATE (n:MyCountLabel {id: 1}), (:MyCountLabel {id: 2}), (m:ThirdLabel {id: 3})
WITH n,m
CREATE (n)-[:MY_COUNT_REL]->(m), (n)-[:ANOTHER_MY_COUNT_REL]->(m), (n)<-[:ANOTHER_MY_COUNT_REL]-(m)

We can return all nodes with a label MyCountLabel or a label ThirdLabel

RETURN apoc.meta.nodes.count(['MyCountLabel', 'ThirdLabel']) AS count;

Table 3. Results
count	relationships

We can return all nodes with a label MyCountLabel and a relationship MY_COUNT_REL through the config param includeRels

RETURN apoc.meta.nodes.count(['MyCountLabel'], {includeRels: ['MY_COUNT_REL']}) AS count;

Table 4. Results
count	relationships

Moreover, we can return all nodes with a outcome relationship MY_COUNT_REL (with the suffix >):

RETURN apoc.meta.nodes.count(['MyCountLabel'], {includeRels: ['MY_COUNT_REL>']}) AS count;

Table 5. Results
count	relationships

otherwise with an incoming relationship MY_COUNT_REL (with the suffix <):

RETURN apoc.meta.nodes.count(['MyCountLabel'], {includeRels: ['MY_COUNT_REL<']}) AS count;

Table 6. Results
count	relationships