Element Functions
Example Graph
GQLINSERT (p1:Paper {_id:'P1', title:'Efficient Graph Search', score:6, author:'Alex'}), (p2:Paper {_id:'P2', title:'Optimizing Queries', score:9, author:'Alex'}), (p3:Paper {_id:'P3', title:'Path Patterns', score:7, author:'Zack'}), (p1)-[:Cites {weight:2}]->(p2), (p2)-[:Cites {weight:1}]->(p3)
id()
Gets the unique identifier _id of a graph element. element_id() is a synonym.
| Syntax | id(<elemVar>) or id(<elemVar>) | ||
| Arguments | Name | Type | Description |
<elemVar> | NODE, EDGE | Element variable reference | |
| Return Type | STRING | ||
GQLMATCH (n)-[e]->() RETURN id(n), id(e)
Result:
| element_id | id |
|---|---|
| P2 | e:2 |
| P1 | e:1 |
labels()
Gets the labels of a graph element.
| Syntax | labels(<elemVar>) | ||
| Arguments | Name | Type | Description |
<elemVar> | NODE, EDGE | Element variable reference | |
| Return Type | LIST<STRING> | ||
GQLMATCH (n)-[e]->() RETURN labels(n), labels(e)
Result:
| labels(n) | labels(e) |
|---|---|
| ["Paper"] | ["Cites"] |
| ["Paper"] | ["Cites"] |
type()
Gets the label of an edge. Equivalent to labels() for edges.
| Syntax | type(<edgeVar>) | ||
| Arguments | Name | Type | Description |
<edgeVar> | EDGE | Edge variable reference | |
| Return Type | STRING | ||
GQLMATCH ()-[e]->() RETURN type(e)
Result:
| type |
|---|
| "Cites" |
| "Cites" |
keys()
Returns the property names of a node, edge, or key names of a record.
| Syntax | keys(<expr>) | ||
| Arguments | Name | Type | Description |
<expr> | NODE, EDGE, RECORD | The input expression | |
| Return Type | LIST<STRING> | ||
GQLMATCH (n:Paper) RETURN keys(n)
Result:
| keys |
|---|
| ["score", "author", "title"] |
| ["score", "author", "title"] |
| ["score", "author", "title"] |
GQLLET myRecord = {x: 1, y: 3, z: 34} RETURN keys(myRecord)
Result:
| keys |
|---|
| ["x", "y", "z"] |
values()
Returns the property values of a node, edge, or values of a record.
| Syntax | values(<expr>) | ||
| Arguments | Name | Type | Description |
<expr> | NODE, EDGE, RECORD | The input expression | |
| Return Type | LIST | ||
GQLLET myRecord = {x: 1, y: 3, z: 34} RETURN values(myRecord)
Result:
| values |
|---|
| [1, 3, 34] |
properties()
Returns the properties of a node or edge as a record.
| Syntax | properties(<elemVar>) | ||
| Arguments | Name | Type | Description |
<elemVar> | NODE, EDGE | Element variable reference | |
| Return Type | RECORD | ||
GQLMATCH (n:Paper) RETURN properties(n)
Result:
| properties |
|---|
| {"score": 7, "author": "Zack", "title": "Path Patterns"} |
| {"score": 9, "author": "Alex", "title": "Optimizing Queries"} |
| {"score": 6, "author": "Alex", "title": "Efficient Graph Search"} |
property_exists()
Checks whether a property exists on a node or edge.
| Syntax | property_exists(<elemVar>, <propertyName>) | ||
| Arguments | Name | Type | Description |
<elemVar> | NODE, EDGE | Element variable reference | |
<propertyName> | STRING | The property name to check | |
| Return Type | BOOL | ||
GQLMATCH (n:Paper) RETURN n._id, property_exists(n, "score"), property_exists(n, "rating")
Result:
| n._id | property_exists(n, "score") | property_exists(n, "rating") |
|---|---|---|
| P1 | true | false |
| P2 | true | false |
| P3 | true | false |