Fixes #4253: Missing apache arrow/jsonParams documentation #4255
Conversation
| = Export to Apache Arrow | ||
| :description: This section describes procedures that can be used to export data in Apache Arrow format. | ||
|
|
||
| The export Apache Arrow procedures export data into a format that's used by many Apache tools and non. |
There was a problem hiding this comment.
These procedures export data into a format that's used by many Apache and non-Apache tools.
|
|
||
|
|
||
| The following procedures allow you to read an Apache Arrow file exported via xref::export/arrow.adoc[apoc.export.arrow.* procedures]. | ||
| It could also potentially read other arrow files not created via the export procedures. |
There was a problem hiding this comment.
It could also potentially read other Apache Arrow files that have not been created via the export procedures.
|
|
||
| [NOTE] | ||
| ==== | ||
| This procedure is not considered safe to run from multiple threads. |
There was a problem hiding this comment.
It is considered not safe to run this procedure using multiple threads.
|
|
||
| [NOTE] | ||
| ==== | ||
| This procedure is not considered safe to run from multiple threads. |
There was a problem hiding this comment.
It is considered not safe to run this procedure using multiple threads.
|
|
||
| [NOTE] | ||
| ==== | ||
| This procedure is not considered safe to run from multiple threads. |
There was a problem hiding this comment.
It is considered not safe to run this procedure using multiple threads.
|
|
||
| [NOTE] | ||
| ==== | ||
| This procedure is not considered safe to run from multiple threads. |
There was a problem hiding this comment.
It is considered not safe to run this procedure using multiple threads.
|
|
||
| [NOTE] | ||
| ==== | ||
| This procedure is not considered safe to run from multiple threads. |
There was a problem hiding this comment.
It is considered not safe to run this procedure using multiple threads.
|
|
||
| [NOTE] | ||
| ==== | ||
| This procedure is not considered safe to run from multiple threads. |
There was a problem hiding this comment.
It is considered not safe to run this procedure using multiple threads.
| label:procedure[] label:apoc-core[] | ||
|
|
||
| [.emphasis] | ||
| apoc.load.jsonParams('urlOrKeyOrBinary',{header:value},payload, config) YIELD value - load from JSON URL (e.g. web-api) while sending headers / payload to import JSON as stream of values if the JSON was an array or a single value if it was a map |
There was a problem hiding this comment.
It loads from JSON URL, a RestAPI endpoint URL, or from a binary source.
The headers and the payload parameters can be used to execute a RestAPI.
The procedure will return multiple values if the starting JSON is a list of JSON or a single result in case it is a single JSON.
Fixes #4253