Skip to content

Commit

Permalink
S3 docs small fixes (neo4j-contrib#2963) (neo4j-contrib#2973)
Browse files Browse the repository at this point in the history
Co-authored-by: Giuseppe Villani <[email protected]>
  • Loading branch information
2 people authored and gem-neo4j committed Jun 13, 2022
1 parent fa8271a commit 61c3fac
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 36 deletions.
18 changes: 1 addition & 17 deletions docs/asciidoc/modules/ROOT/pages/import/web-apis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,7 @@ apoc.load.csv("pathToCompressedFile/file.zip!pathToCsvFileInZip/fileName.csv")
apoc.load.json("https://github.com/neo4j-contrib/neo4j-apoc-procedures/tree/3.4/src/test/resources/testload.tgz?raw=true!person.json");
----

== Using S3 protocol

When using the S3 protocol we need to download and copy the following jars into the plugins directory:

* aws-java-sdk-core-1.12.136.jar (https://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk-core/1.12.136)
* aws-java-sdk-s3-1.12.136.jar (https://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk-s3/1.12.136)
* httpclient-4.5.13.jar (https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient/4.5.13)
* httpcore-4.4.15.jar (https://mvnrepository.com/artifact/org.apache.httpcomponents/httpcore/4.4.15)
* joda-time-2.10.13.jar (https://mvnrepository.com/artifact/joda-time/joda-time/2.10.13)

Once those files have been copied we'll need to restart the database.

The S3 URL must be in the following format:

* `s3://accessKey:secretKey@endpoint:port/bucket/key`
or
* `s3://endpoint:port/bucket/key?accessKey=accessKey&secretKey=secretKey`
include::partial$s3-protocol.adoc[]

== Using hdfs protocol

Expand Down
20 changes: 1 addition & 19 deletions docs/asciidoc/modules/ROOT/partials/enableS3Export.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,8 @@ Otherwise, if you are running in a cloud environment without filesystem access,
Note that the stream mode cannot be used with the apoc.export.xls.* procedures.
|===

== Using S3 protocol

When using the S3 protocol we need to download and copy the following jars into the plugins directory:

* aws-java-sdk-core-1.11.250.jar (https://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk-core/1.11.250)
* aws-java-sdk-s3-1.11.250.jar (https://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk-s3/1.11.250)
* httpclient-4.4.8.jar (https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient/4.5.4)
* httpcore-4.5.4.jar (https://mvnrepository.com/artifact/org.apache.httpcomponents/httpcore/4.4.8)
* joda-time-2.9.9.jar (https://mvnrepository.com/artifact/joda-time/joda-time/2.9.9)

Once those files have been copied we'll need to restart the database.

Exporting to S3 can be done by simply replacing the file output with an S3 endpoint. The S3 URL must be in the following format:

* `s3://accessKey:secretKey[:sessionToken]@endpoint:port/bucket/key`
(where the sessionToken is optional) or
* `s3://endpoint:port/bucket/key?accessKey=accessKey&secretKey=secretKey[&sessionToken=sessionToken]`
(where the sessionToken is optional) or
* `s3://endpoint:port/bucket/key`
if the accessKey, secretKey, and the optional sessionToken are provided in the environment variables
include::partial$s3-protocol.adoc[]

== Memory Requirements

Expand Down
20 changes: 20 additions & 0 deletions docs/asciidoc/modules/ROOT/partials/s3-protocol.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
== Using S3 protocol

When using the S3 protocol we need to download and copy the following jars into the plugins directory:

* aws-java-sdk-core-1.12.136.jar (https://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk-core/1.12.136)
* aws-java-sdk-s3-1.12.136.jar (https://mvnrepository.com/artifact/com.amazonaws/aws-java-sdk-s3/1.12.136)
* httpclient-4.5.13.jar (https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient/4.5.13)
* httpcore-4.4.15.jar (https://mvnrepository.com/artifact/org.apache.httpcomponents/httpcore/4.4.15)
* joda-time-2.10.13.jar (https://mvnrepository.com/artifact/joda-time/joda-time/2.10.13)
Once those files have been copied we'll need to restart the database.

The S3 URL must be in the following format:

* `s3://accessKey:secretKey[:sessionToken]@endpoint:port/bucket/key`
(where the sessionToken is optional) or
* `s3://endpoint:port/bucket/key?accessKey=accessKey&secretKey=secretKey[&sessionToken=sessionToken]`
(where the sessionToken is optional) or
* `s3://endpoint:port/bucket/key`
if the accessKey, secretKey, and the optional sessionToken are provided in the environment variables

0 comments on commit 61c3fac

Please sign in to comment.