Skip to content

Commit

Permalink
typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
vga91 committed Dec 6, 2024
1 parent c0d6029 commit 9400a8d
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 17 deletions.
20 changes: 9 additions & 11 deletions docs/asciidoc/modules/ROOT/pages/import/arrow.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[load-arrow]]
= 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.


Expand All @@ -16,27 +16,25 @@ The table below describes the available procedures and functions:
|===
¦Qualified Name¦Type
¦xref::overview/apoc.load/apoc.load.arrow.adoc[apoc.load.arrow icon:book[]] +
`apoc.load.arrow(file STRING, config MAP<STRING, ANY>)` - imports `NODE` and `RELATIONSHIP` values from the provided arrow file.
`apoc.load.arrow(file STRING, config MAP<STRING, ANY>)` - 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<INTEGER>, config MAP<STRING, ANY>)` - imports `NODE` and `RELATIONSHIP` values from the provided arrow byte array.
`apoc.load.arrow.stream(source LIST<INTEGER>, config MAP<STRING, ANY>)` - loads values from the provided Arrow byte array.
¦label:procedure[]

¦xref::overview/apoc.import/apoc.import.arrow.adoc[apoc.import.json icon:book[]] +
`apoc.import.json(urlOrBinaryFile ANY, config MAP<STRING, ANY>)` - imports a graph from the provided JSON file.
¦xref::overview/apoc.import/apoc.import.arrow.adoc[apoc.import.arrow icon:book[]] +
`apoc.import.arrow(urlOrBinaryFile ANY, config MAP<STRING, ANY>)` - imports entities from the provided Arrow file or byte array
¦label:procedure[]
|===


NOTE: The import procedure, i.e. `apoc.import.parquet` is currently located in the link:https://neo4j.com/labs/apoc/5/[APOC Extended library].


[[load-arrow-available-procedures-apoc.load.arrow]]
=== `apoc.load.arrow`


This procedure takes a file or HTTP URL and parses the Apache Parquet into a map data structure.
This procedure takes a file or HTTP URL and parses the Apache Arrow into a map data structure.

[separator=¦,opts=header,cols="1m"]
|===
Expand All @@ -53,7 +51,7 @@ include::includes/enableFileImport.adoc[]
=== `apoc.load.arrow.stream`


This procedure takes a byte[] source and parses the Apache Parquet into a map data structure.
This procedure takes a byte[] source and parses the Apache Arrow into a map data structure.

[separator=¦,opts=header,cols="1m"]
|===
Expand All @@ -72,7 +70,7 @@ The following section contains examples showing how to import data from various
[[load-arrow-examples-local-file]]
=== Import from local file

Taking the output xref::export/arrow.adoc#export-cypher-query-arrow[of this case]:
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]
Expand Down Expand Up @@ -114,7 +112,7 @@ RETURN value
[[import-arrow]]
=== Import Arrow file created by Export Arrow procedures

The `apoc.import.arrow` procedure can be used to import JSON files created by the `apoc.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.
Expand Down
1 change: 1 addition & 0 deletions docs/asciidoc/modules/ROOT/pages/import/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ For more information on these procedures, see:
* xref::import/parquet.adoc[]
* xref::import/gexf.adoc[]
* xref::import/load-json.adoc[]
* xref::import/arrow.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
label:procedure[] label:apoc-extended[]

[.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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
label:procedure[]

[.emphasis]
`apoc.load.arrow(file STRING, config MAP<STRING, ANY>)` - imports `NODE` and `RELATIONSHIP` values from the provided arrow file.
`apoc.load.arrow(file STRING, config MAP<STRING, ANY>)` - imports values from the provided Arrow file.

== Signature

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
label:procedure[]

[.emphasis]
`apoc.load.arrow.stream(source LIST<INTEGER>, config MAP<STRING, ANY>)` - imports `NODE` and `RELATIONSHIP` values from the provided arrow byte array.
`apoc.load.arrow.stream(source LIST<INTEGER>, config MAP<STRING, ANY>)` - imports values from the provided Arrow byte array.

== Signature

Expand Down
2 changes: 1 addition & 1 deletion extended/src/main/java/apoc/export/arrow/ImportArrow.java
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public class ImportArrow {


@Procedure(name = "apoc.import.arrow", mode = Mode.WRITE)
@Description("Imports arrow from the provided arrow file or byte array")
@Description("Imports entities from the provided Arrow file or byte array")
public Stream<ImportProgressInfo> importFile(@Name("input") Object input, @Name(value = "config", defaultValue = "{}") Map<String, Object> config) throws Exception {

ImportProgressInfo result =
Expand Down
4 changes: 2 additions & 2 deletions extended/src/main/java/apoc/load/LoadArrow.java
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public synchronized boolean tryAdvance(Consumer<? super LoadDataMapResult> actio
@Procedure(name = "apoc.load.arrow.stream", deprecatedBy = "This procedure is being moved to APOC Extended.")
@Deprecated
@QueryLanguageScope(scope = {QueryLanguage.CYPHER_25})
@Description("Imports `NODE` and `RELATIONSHIP` values from the provided arrow byte array.")
@Description("Imports values from the provided Arrow byte array.")
public Stream<LoadDataMapResult> stream(
@Name(value = "source", description = "The data to load.") byte[] source,
@Name(value = "config", defaultValue = "{}", description = "This value is never used.")
Expand All @@ -126,7 +126,7 @@ public Stream<LoadDataMapResult> stream(
@Procedure(name = "apoc.load.arrow", deprecatedBy = "This procedure is being moved to APOC Extended.")
@Deprecated
@QueryLanguageScope(scope = {QueryLanguage.CYPHER_25})
@Description("Imports `NODE` and `RELATIONSHIP` values from the provided arrow file.")
@Description("Imports values from the provided Arrow file.")
public Stream<LoadDataMapResult> file(
@Name(value = "file", description = "The name of the file to import data from.") String fileName,
@Name(value = "config", defaultValue = "{}", description = "This value is never used.")
Expand Down

0 comments on commit 9400a8d

Please sign in to comment.