From 168f449d796ace37f5f7551f9d4189e8b1ecafd0 Mon Sep 17 00:00:00 2001 From: Giuseppe Villani Date: Tue, 10 Dec 2024 17:42:08 +0100 Subject: [PATCH] [NOID] Fixes #4253: Missing apache arrow/jsonParams documentation (#4255) * Fixes #4253: Missing apache arrow/jsonParams documentation * Added missing apache arrow/jsonParams documentation * fix typos * changes review --- docs/asciidoc/modules/ROOT/nav.adoc | 1 + .../modules/ROOT/pages/export/arrow.adoc | 104 +++++++++++++++ .../modules/ROOT/pages/export/index.adoc | 2 + .../modules/ROOT/pages/import/arrow.adoc | 121 ++++++++++++++++++ .../modules/ROOT/pages/import/index.adoc | 3 +- .../apoc.export/apoc.export.arrow.all.adoc | 56 ++++++++ .../apoc.export/apoc.export.arrow.graph.adoc | 57 +++++++++ .../apoc.export/apoc.export.arrow.query.adoc | 57 +++++++++ .../apoc.export.arrow.stream.all.adoc | 44 +++++++ .../apoc.export.arrow.stream.graph.adoc | 45 +++++++ .../apoc.export.arrow.stream.query.adoc | 45 +++++++ .../apoc.import/apoc.import.arrow.adoc | 4 +- .../overview/apoc.load/apoc.load.arrow.adoc | 31 +++++ .../apoc.load/apoc.load.arrow.stream.adoc | 31 +++++ 14 files changed, 598 insertions(+), 3 deletions(-) create mode 100644 docs/asciidoc/modules/ROOT/pages/export/arrow.adoc create mode 100644 docs/asciidoc/modules/ROOT/pages/import/arrow.adoc create mode 100644 docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.all.adoc create mode 100644 docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.graph.adoc create mode 100644 docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.query.adoc create mode 100644 docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.stream.all.adoc create mode 100644 docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.stream.graph.adoc create mode 100644 docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.stream.query.adoc create mode 100644 docs/asciidoc/modules/ROOT/pages/overview/apoc.load/apoc.load.arrow.adoc create mode 100644 docs/asciidoc/modules/ROOT/pages/overview/apoc.load/apoc.load.arrow.stream.adoc diff --git a/docs/asciidoc/modules/ROOT/nav.adoc b/docs/asciidoc/modules/ROOT/nav.adoc index 5ed19558f7..6128a5ddf5 100644 --- a/docs/asciidoc/modules/ROOT/nav.adoc +++ b/docs/asciidoc/modules/ROOT/nav.adoc @@ -30,6 +30,7 @@ include::partial$generated-documentation/nav.adoc[] ** xref::import/load-xml.adoc[] ** xref::import/load-html.adoc[] ** xref::import/import-csv.adoc[] + ** xref::import/arrow.adoc[] ** xref::import/import-graphml.adoc[] * xref:export/index.adoc[] diff --git a/docs/asciidoc/modules/ROOT/pages/export/arrow.adoc b/docs/asciidoc/modules/ROOT/pages/export/arrow.adoc new file mode 100644 index 0000000000..581e60299a --- /dev/null +++ b/docs/asciidoc/modules/ROOT/pages/export/arrow.adoc @@ -0,0 +1,104 @@ +[[export-arrow]] += Export to Apache Arrow +:description: This section describes procedures that can be used to export data in Apache Arrow format. + +These procedures export data into a format that's used by many Apache and non-Apache tools. + + +[[export-arrow-available-procedures]] +== Available Procedures + +The table below describes the available procedures: + +[separator=¦,opts=header,cols="5,1m"] +|=== +¦Qualified Name¦Type +¦xref::overview/apoc.export/apoc.export.arrow.all.adoc[apoc.export.arrow.all icon:book[]] + +`apoc.export.arrow.all(file STRING, config MAP)` - exports the full database as an arrow file. +¦label:procedure[] + +¦xref::overview/apoc.export/apoc.export.arrow.graph.adoc[apoc.export.arrow.graph.adoc icon:book[]] + +`apoc.export.arrow.graph(file STRING, graph ANY, config MAP)` - exports the given graph as an arrow file. +¦label:procedure[] + +¦xref::overview/apoc.export/apoc.export.arrow.query.adoc[apoc.export.arrow.query.adoc icon:book[]] + +`apoc.export.arrow.stream.all(config MAP)` - exports the full database as an arrow byte array. +¦label:procedure[] + +¦xref::overview/apoc.export/apoc.export.arrow.stream.all.adoc[apoc.export.arrow.stream.all icon:book[]] + +`apoc.export.arrow.all(file STRING, config MAP)` - exports the full database as an arrow file. +¦label:procedure[] + +¦xref::overview/apoc.export/apoc.export.arrow.stream.graph.adoc[apoc.export.arrow.stream.graph.adoc icon:book[]] + +`apoc.export.arrow.stream.graph(graph ANY, config MAP)` - exports the given graph as an arrow byte array. +¦label:procedure[] + +¦xref::overview/apoc.export/apoc.export.arrow.stream.query.adoc[apoc.export.arrow.stream.query.adoc icon:book[]] + +`apoc.export.arrow.stream.query(query ANY, config MAP)` - exports the given Cypher query as an arrow byte array. +¦label:procedure[] +|=== + + +[[export-arrow-file-export]] +== Exporting to a file + +include::partial$enableFileExport.adoc[] + + +[[export-arrow-examples]] +== Examples + + +[[export-cypher-query-arrow]] +=== Export results of Cypher query to Apache Arrow file + +[source,cypher] +---- +CALL apoc.export.arrow.query('query_test.arrow', + "RETURN 1 AS intData, 'a' AS stringData, + true AS boolData, + [1, 2, 3] AS intArray, + [1.1, 2.2, 3.3] AS doubleArray, + [true, false, true] AS boolArray, + [1, '2', true, null] AS mixedArray, + {foo: 'bar'} AS mapData, + localdatetime('2015-05-18T19:32:24') as dateData, + [[0]] AS arrayArray, + 1.1 AS doubleData" +) YIELD file +---- + +.Results +[opts="header"] +|=== +| file | source | format | nodes | relationships | properties | time | rows | batchSize | batches | done | data +| "query_test.arrow" | "statement: cols(11)" | "arrow" | 0 | 0 | 11 | 468 | 11 | 2000 | 1 | true | +|=== + + + +[[export-cypher-query-arrow-stream]] +=== Export results of Cypher query to Apache Arrow binary output + +[source,cypher] +---- +CALL apoc.export.arrow.stream.query('query_test.arrow', + "RETURN 1 AS intData, 'a' AS stringData, + true AS boolData, + [1, 2, 3] AS intArray, + [1.1, 2.2, 3.3] AS doubleArray, + [true, false, true] AS boolArray, + [1, '2', true, null] AS mixedArray, + {foo: 'bar'} AS mapData, + localdatetime('2015-05-18T19:32:24') as dateData, + [[0]] AS arrayArray, + 1.1 AS doubleData" +) YIELD value +---- + +.Results +[opts="header"] +|=== +| value +| +|=== \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/pages/export/index.adoc b/docs/asciidoc/modules/ROOT/pages/export/index.adoc index 69d7f49e20..73f1156628 100644 --- a/docs/asciidoc/modules/ROOT/pages/export/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/export/index.adoc @@ -20,3 +20,5 @@ For more information on how to use these procedures, see: * xref::export/graphml.adoc[] * xref::export/gephi.adoc[] * xref::export/xls.adoc[] +* xref::export/arrow.adoc[] + diff --git a/docs/asciidoc/modules/ROOT/pages/import/arrow.adoc b/docs/asciidoc/modules/ROOT/pages/import/arrow.adoc new file mode 100644 index 0000000000..69cfa9bbd0 --- /dev/null +++ b/docs/asciidoc/modules/ROOT/pages/import/arrow.adoc @@ -0,0 +1,121 @@ +[[load-arrow]] += Load and Import Arrow +:description: This section describes procedures that can be used to import Apache Arrow data from web APIs or files. + + + +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 Apache Arrow files that have not been created via the export procedures. + +[[load-arrow-available-procedures]] +== Procedure and Function Overview + +The table below describes the available procedures and functions: + +[separator=¦,opts=header,cols="5,1m"] +|=== +¦Qualified Name¦Type +¦xref::overview/apoc.load/apoc.load.arrow.adoc[apoc.load.arrow icon:book[]] + +`apoc.load.arrow(file STRING, config MAP)` - loads values from the provided Arrow file. +¦label:procedure[] + +¦xref::overview/apoc.load/apoc.load.arrow.stream.adoc[apoc.load.arrow.stream.adoc icon:book[]] + +`apoc.load.arrow.stream(source LIST, config MAP)` - loads values from the provided Arrow byte array. +¦label:procedure[] + +¦xref::overview/apoc.import/apoc.import.arrow.adoc[apoc.import.arrow icon:book[]] + +`apoc.import.arrow(urlOrBinaryFile ANY, config MAP)` - imports entities from the provided Arrow file or byte array +¦label:procedure[] +|=== + + + +[[load-arrow-available-procedures-apoc.load.arrow]] +=== `apoc.load.arrow` + + +This procedure takes a file or HTTP URL and parses the Apache Arrow into a map data structure. + +[separator=¦,opts=header,cols="1m"] +|=== +¦signature +¦apoc.load.arrow(file :: STRING, config = {} :: MAP) :: (value :: MAP) +|=== + + +Currently, this procedure does not support any config parameters. + +include::includes/enableFileImport.adoc[] + +[[load-arrow-available-procedures-apoc.load.arrow.stream]] +=== `apoc.load.arrow.stream` + + +This procedure takes a byte[] source and parses the Apache Arrow into a map data structure. + +[separator=¦,opts=header,cols="1m"] +|=== +¦signature +¦apoc.load.arrow.stream(source :: LIST, config = {} :: MAP) :: (value :: MAP) +|=== + +Currently, this procedure does not support any config parameters. + + +[[load-arrow-examples]] +== Examples + +The following section contains examples showing how to import data from various Apache Arrow sources. + +[[load-arrow-examples-local-file]] +=== Import from local file + +Taking the output xref::export/arrow.adoc#export-cypher-query-arrow[of this case]: + +.The following query processes a `test.arrow` file and returns the content as Cypher data structures +[source,cypher] +---- +CALL apoc.load.arrow('test.arrow') +YIELD value +RETURN value +---- + +.Results +[options="header"] +|=== +| value +| {arrayArray -> ["[0]"], dateData -> 2015-05-18T19:32:24Z, boolArray -> [true,false,true], intArray -> [1,2,3], mapData -> "{"foo":"bar"}", boolData -> true, intData -> 1, mixedArray -> ["1","2","true",], doubleArray -> [1.1,2.2,3.3], doubleData -> 1.1, stringData -> "a"} +|=== + + +[[load-arrow-examples-binary-source]] +=== Import from binary source + +Taking the output xref::export/arrow.adoc#export-cypher-query-arrow-stream[of this case]: + +.The following query processes a `test.arrow` file and returns the content as Cypher data structures +[source,cypher] +---- +CALL apoc.load.arrow.stream('') +YIELD value +RETURN value +---- + +.Results +[options="header"] +|=== +| value +| {arrayArray -> ["[0]"], dateData -> 2015-05-18T19:32:24Z, boolArray -> [true,false,true], intArray -> [1,2,3], mapData -> "{"foo":"bar"}", boolData -> true, intData -> 1, mixedArray -> ["1","2","true",], doubleArray -> [1.1,2.2,3.3], doubleData -> 1.1, stringData -> "a"} +|=== + + +[[import-arrow]] +=== Import Arrow file created by Export Arrow procedures + +The `apoc.import.arrow` procedure can be used to import Apache Arrow files created by the xref::export/arrow.adoc[apoc.export.arrow.*] procedures. + +This procedure should not be confused with the `apoc.load.arrow*` procedures, +which just loads the values of the Arrow file, and does not create entities in the database. + +See xref::overview/apoc.import/apoc.import.arrow.adoc[this page] for more info. + diff --git a/docs/asciidoc/modules/ROOT/pages/import/index.adoc b/docs/asciidoc/modules/ROOT/pages/import/index.adoc index 0d3bebf013..07560c3881 100644 --- a/docs/asciidoc/modules/ROOT/pages/import/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/import/index.adoc @@ -19,4 +19,5 @@ For more information on these procedures, see: * xref::import/load-xml.adoc[] * xref::import/load-html.adoc[] * xref::import/import-csv.adoc[] -* xref::import/import-graphml.adoc[] \ No newline at end of file +* xref::import/import-graphml.adoc[] +* xref::import/arrow.adoc[] \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.all.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.all.adoc new file mode 100644 index 0000000000..cb51c90887 --- /dev/null +++ b/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.all.adoc @@ -0,0 +1,56 @@ += apoc.export.arrow.all +:description: This section contains reference documentation for the apoc.export.arrow.all procedure. + +label:procedure[] + +[.emphasis] +`apoc.export.arrow.all(file STRING, config MAP)` - exports the full database as an arrow file. + +[NOTE] +==== +It is considered unsafe to run this procedure using multiple threads. +It is therefore not supported by the parallel runtime (introduced in Neo4j 5.13). +For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/planning-and-tuning/runtimes/concepts#runtimes-parallel-runtime[Cypher Manual -> Parallel runtime]. +==== + +== Signature + +[source] +---- +apoc.export.arrow.all(file :: STRING, config = {} :: MAP) :: (file :: STRING, source :: STRING, format :: STRING, nodes :: INTEGER, relationships :: INTEGER, properties :: INTEGER, time :: INTEGER, rows :: INTEGER, batchSize :: INTEGER, batches :: INTEGER, done :: BOOLEAN, data :: ANY) +---- + +== Input parameters +[.procedures, opts=header] +|=== +| Name | Type | Default +|file|STRING|null +|config|MAP|null +|=== + +== Output parameters +[.procedures, opts=header] +|=== +| Name | Type +|file|STRING +|source|STRING +|format|STRING +|nodes|INTEGER +|relationships|INTEGER +|properties|INTEGER +|time|INTEGER +|rows|INTEGER +|batchSize|INTEGER +|batches|INTEGER +|done|BOOLEAN +|data|STRING +|=== + +== Config parameters +include::partial$usage/config/apoc.export.arrow.all.adoc[] + +[[usage-apoc.export.arrow.all]] +== Usage Examples +include::partial$usage/apoc.export.arrow.all.adoc[] + +xref::export/arrow.adoc[More documentation of apoc.export.arrow.all,role=more information] \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.graph.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.graph.adoc new file mode 100644 index 0000000000..48d2a2560a --- /dev/null +++ b/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.graph.adoc @@ -0,0 +1,57 @@ += apoc.export.arrow.graph +:description: This section contains reference documentation for the apoc.export.arrow.graph procedure. + +label:procedure[] + +[.emphasis] +`apoc.export.arrow.graph(file STRING, graph ANY, config MAP)` - exports the given graph as an arrow file. + +[NOTE] +==== +It is considered unsafe to run this procedure using multiple threads. +It is therefore not supported by the parallel runtime (introduced in Neo4j 5.13). +For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/planning-and-tuning/runtimes/concepts#runtimes-parallel-runtime[Cypher Manual -> Parallel runtime]. +==== + +== Signature + +[source] +---- +apoc.export.arrow.graph(file :: STRING, graph :: ANY, config = {} :: MAP) :: (file :: STRING, source :: STRING, format :: STRING, nodes :: INTEGER, relationships :: INTEGER, properties :: INTEGER, time :: INTEGER, rows :: INTEGER, batchSize :: INTEGER, batches :: INTEGER, done :: BOOLEAN, data :: ANY) +---- + +== Input parameters +[.procedures, opts=header] +|=== +| Name | Type | Default +|file|STRING|null +|graph|ANY|null +|config|MAP|null +|=== + +== Output parameters +[.procedures, opts=header] +|=== +| Name | Type +|file|STRING +|source|STRING +|format|STRING +|nodes|INTEGER +|relationships|INTEGER +|properties|INTEGER +|time|INTEGER +|rows|INTEGER +|batchSize|INTEGER +|batches|INTEGER +|done|BOOLEAN +|data|STRING +|=== + +== Config parameters +include::partial$usage/config/apoc.export.arrow.graph.adoc[] + +[[usage-apoc.export.arrow.graph]] +== Usage Examples +include::partial$usage/apoc.export.arrow.graph.adoc[] + +xref::export/arrow.adoc[More documentation of apoc.export.arrow.graph,role=more information] \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.query.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.query.adoc new file mode 100644 index 0000000000..7bcc3bb20e --- /dev/null +++ b/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.query.adoc @@ -0,0 +1,57 @@ += apoc.export.arrow.query +:description: This section contains reference documentation for the apoc.export.arrow.query procedure. + +label:procedure[] + +[.emphasis] +`apoc.export.arrow.query(file STRING, query STRING, config MAP)` - exports the results from the given Cypher query as an arrow file. + +[NOTE] +==== +It is considered unsafe to run this procedure using multiple threads. +It is therefore not supported by the parallel runtime (introduced in Neo4j 5.13). +For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/planning-and-tuning/runtimes/concepts#runtimes-parallel-runtime[Cypher Manual -> Parallel runtime]. +==== + +== Signature + +[source] +---- +apoc.export.arrow.query(file :: STRING, query :: STRING, config = {} :: MAP) :: (file :: STRING, source :: STRING, format :: STRING, nodes :: INTEGER, relationships :: INTEGER, properties :: INTEGER, time :: INTEGER, rows :: INTEGER, batchSize :: INTEGER, batches :: INTEGER, done :: BOOLEAN, data :: ANY) +---- + +== Input parameters +[.procedures, opts=header] +|=== +| Name | Type | Default +|file|STRING|null +|query|STRING|null +|config|MAP|null +|=== + +== Output parameters +[.procedures, opts=header] +|=== +| Name | Type +|file|STRING +|source|STRING +|format|STRING +|nodes|INTEGER +|relationships|INTEGER +|properties|INTEGER +|time|INTEGER +|rows|INTEGER +|batchSize|INTEGER +|batches|INTEGER +|done|BOOLEAN +|data|STRING +|=== + +== Config parameters +include::partial$usage/config/apoc.export.arrow.query.adoc[] + +[[usage-apoc.export.arrow.query]] +== Usage Examples +include::partial$usage/apoc.export.arrow.query.adoc[] + +xref::export/arrow.adoc[More documentation of apoc.export.arrow.query,role=more information] \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.stream.all.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.stream.all.adoc new file mode 100644 index 0000000000..15612e29a4 --- /dev/null +++ b/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.stream.all.adoc @@ -0,0 +1,44 @@ += apoc.export.arrow.stream.all +:description: This section contains reference documentation for the apoc.export.arrow.stream.all procedure. + +label:procedure[] + +[.emphasis] +`apoc.export.arrow.stream.all(config MAP)` - exports the full database as an arrow byte array. + +[NOTE] +==== +It is considered unsafe to run this procedure using multiple threads. +It is therefore not supported by the parallel runtime (introduced in Neo4j 5.13). +For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/planning-and-tuning/runtimes/concepts#runtimes-parallel-runtime[Cypher Manual -> Parallel runtime]. +==== + +== Signature + +[source] +---- +apoc.export.arrow.stream.all(config = {} :: MAP) :: (value :: LIST) +---- + +== Input parameters +[.procedures, opts=header] +|=== +| Name | Type | Default +|config|MAP|null +|=== + +== Output parameters +[.procedures, opts=header] +|=== +| Name | Type +|value|LIST +|=== + +== Config parameters +include::partial$usage/config/apoc.export.arrow.stream.all.adoc[] + +[[usage-apoc.export.arrow.stream.all]] +== Usage Examples +include::partial$usage/apoc.export.arrow.stream.all.adoc[] + +xref::export/arrow.adoc[More documentation of apoc.export.arrow.stream.all,role=more information] \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.stream.graph.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.stream.graph.adoc new file mode 100644 index 0000000000..2418bf3306 --- /dev/null +++ b/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.stream.graph.adoc @@ -0,0 +1,45 @@ += apoc.export.arrow.stream.graph +:description: This section contains reference documentation for the apoc.export.arrow.stream.graph procedure. + +label:procedure[] + +[.emphasis] +`apoc.export.arrow.stream.graph(graph ANY, config MAP)` - exports the given graph as an arrow byte array. + +[NOTE] +==== +It is considered unsafe to run this procedure using multiple threads. +It is therefore not supported by the parallel runtime (introduced in Neo4j 5.13). +For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/planning-and-tuning/runtimes/concepts#runtimes-parallel-runtime[Cypher Manual -> Parallel runtime]. +==== +s +== Signature + +[source] +---- +apoc.export.arrow.stream.graph(graph :: ANY, config = {} :: MAP) :: (value :: LIST) +---- + +== Input parameters +[.procedures, opts=header] +|=== +| Name | Type | Default +|graph|ANY|null +|config|MAP|null +|=== + +== Output parameters +[.procedures, opts=header] +|=== +| Name | Type +|value|LIST +|=== + +== Config parameters +include::partial$usage/config/apoc.export.arrow.stream.graph.adoc[] + +[[usage-apoc.export.arrow.stream.graph]] +== Usage Examples +include::partial$usage/apoc.export.arrow.stream.graph.adoc[] + +xref::export/arrow.adoc[More documentation of apoc.export.arrow.stream.graph,role=more information] \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.stream.query.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.stream.query.adoc new file mode 100644 index 0000000000..8b245d3c95 --- /dev/null +++ b/docs/asciidoc/modules/ROOT/pages/overview/apoc.export/apoc.export.arrow.stream.query.adoc @@ -0,0 +1,45 @@ += apoc.export.arrow.stream.query +:description: This section contains reference documentation for the apoc.export.arrow.stream.query procedure. + +label:procedure[] + +[.emphasis] +`apoc.export.arrow.stream.query(query ANY, config MAP)` - exports the given Cypher query as an arrow byte array. + +[NOTE] +==== +It is considered unsafe to run this procedure using multiple threads. +It is therefore not supported by the parallel runtime (introduced in Neo4j 5.13). +For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/{page-version}/planning-and-tuning/runtimes/concepts#runtimes-parallel-runtime[Cypher Manual -> Parallel runtime]. +==== + +== Signature + +[source] +---- +apoc.export.arrow.stream.query(query :: ANY, config = {} :: MAP) :: (value :: LIST) +---- + +== Input parameters +[.procedures, opts=header] +|=== +| Name | Type | Default +|query|ANY|null +|config|MAP|null +|=== + +== Output parameters +[.procedures, opts=header] +|=== +| Name | Type +|value|LIST +|=== + +== Config parameters +include::partial$usage/config/apoc.export.arrow.stream.query.adoc[] + +[[usage-apoc.export.arrow.stream.query]] +== Usage Examples +include::partial$usage/apoc.export.arrow.stream.query.adoc[] + +xref::export/arrow.adoc[More documentation of apoc.export.arrow.stream.query,role=more information] \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.import/apoc.import.arrow.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.import/apoc.import.arrow.adoc index bd3ab296a3..ead6dc703a 100644 --- a/docs/asciidoc/modules/ROOT/pages/overview/apoc.import/apoc.import.arrow.adoc +++ b/docs/asciidoc/modules/ROOT/pages/overview/apoc.import/apoc.import.arrow.adoc @@ -4,7 +4,7 @@ label:procedure[] label:apoc-full[] [.emphasis] -apoc.import.arrow(input, $config) - Imports arrow from the provided arrow file or byte array +apoc.import.arrow(input, $config) - Imports entities from the provided Arrow file or byte array == Signature @@ -92,7 +92,7 @@ CALL apoc.load.arrow(fileOrBinary, {mapping: {durationProp: 'Duration'}}) Or with the import procedure: [source,cypher] ---- -CALL apoc.import.parquet(fileOrBinary, {mapping: {durationProp: 'Duration'}}) +CALL apoc.import.arrow(fileOrBinary, {mapping: {durationProp: 'Duration'}}) ---- The mapping value types can be one of the following: diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.load/apoc.load.arrow.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.load/apoc.load.arrow.adoc new file mode 100644 index 0000000000..e47f2359f7 --- /dev/null +++ b/docs/asciidoc/modules/ROOT/pages/overview/apoc.load/apoc.load.arrow.adoc @@ -0,0 +1,31 @@ += apoc.load.arrow +:description: This section contains reference documentation for the apoc.load.arrow procedure. + +label:procedure[] + +[.emphasis] +`apoc.load.arrow(file STRING, config MAP)` - imports values from the provided Arrow file. + +== Signature + +[source] +---- +apoc.load.arrow(file :: STRING, config = {} :: MAP) :: (value :: MAP) +---- + +== Input parameters +[.procedures, opts=header] +|=== +| Name | Type | Default +|file|STRING|null +|config|MAP|null +|=== + +== Output parameters +[.procedures, opts=header] +|=== +| Name | Type +|value|MAP +|=== + +xref:import/arrow.adoc[More documentation about apoc.load.arrow,role=more information] diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.load/apoc.load.arrow.stream.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.load/apoc.load.arrow.stream.adoc new file mode 100644 index 0000000000..46ead4b39b --- /dev/null +++ b/docs/asciidoc/modules/ROOT/pages/overview/apoc.load/apoc.load.arrow.stream.adoc @@ -0,0 +1,31 @@ += apoc.load.arrow.stream +:description: This section contains reference documentation for the apoc.load.arrow.stream procedure. + +label:procedure[] + +[.emphasis] +`apoc.load.arrow.stream(source LIST, config MAP)` - imports values from the provided Arrow byte array. + +== Signature + +[source] +---- +apoc.load.arrow.stream(source :: LIST, config = {} :: MAP) :: (value :: MAP) +---- + +== Input parameters +[.procedures, opts=header] +|=== +| Name | Type | Default +|source|LIST|null +|config|MAP|null +|=== + +== Output parameters +[.procedures, opts=header] +|=== +| Name | Type +|value|MAP +|=== + +xref:import/arrow.adoc[More documentation about apoc.load.arrow,role=more information]