apoc.json.path

Function

apoc.json.path(json STRING, path STRING, pathOptions LIST<STRING>) - returns the given JSON path.

Signature

apoc.json.path(json :: STRING, path = $ :: STRING, pathOptions = null :: LIST<STRING>) :: ANY

Input parameters

Name	Type	Default
json	STRING	null
path	STRING	$
pathOptions	LIST<STRING>	[]

Name

Type

Default

json

STRING

null

path

STRING

pathOptions

LIST<STRING>

[]

Usage Examples

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

CREATE (:Person {json:'{a:[1,2,3]}'});

MATCH (p:Person)
RETURN apoc.json.path(p.json, "$.a") AS output;

Table 1. Results
Output
[1, 2, 3]

Moreover, we can customize the Json path options, adding as third parameter (pathOptions) a list of strings, where the strings are based on Enum<Option>. The default value is ["SUPPRESS_EXCEPTIONS", "DEFAULT_PATH_LEAF_TO_NULL"]. Note that we can also insert [], that is "without options". So we can execute (with default pathOptions):

RETURN apoc.json.path('{ "columns": {
      "col2": {
        "_id": "772col2"
      }
    }
}', '$..columns') AS output;

Table 2. Results
Output
[ {"col2": { "_id": "772col2" }}, null, null ]

or, with custom path options:

RETURN apoc.json.path('{ "columns": {
      "col2": {
        "_id": "772col2"
      }
    }
}', '$..columns', ['ALWAYS_RETURN_LIST']) AS output;

Table 3. Results
Output
[ {"col2": { "_id": "772col2" }} ]