diff --git a/docs/asciidoc/modules/ROOT/pages/export/index.adoc b/docs/asciidoc/modules/ROOT/pages/export/index.adoc index 85c05c8878..69d7f49e20 100644 --- a/docs/asciidoc/modules/ROOT/pages/export/index.adoc +++ b/docs/asciidoc/modules/ROOT/pages/export/index.adoc @@ -13,6 +13,7 @@ In addition to exporting data in these formats, we can choose to export the whol For more information on how to use these procedures, see: +* xref::export/web-apis.adoc[] * xref::export/csv.adoc[] * xref::export/json.adoc[] * xref::export/cypher.adoc[] diff --git a/docs/asciidoc/modules/ROOT/pages/export/web-apis.adoc b/docs/asciidoc/modules/ROOT/pages/export/web-apis.adoc index b6dd618e67..868b1db52e 100644 --- a/docs/asciidoc/modules/ROOT/pages/export/web-apis.adoc +++ b/docs/asciidoc/modules/ROOT/pages/export/web-apis.adoc @@ -2,8 +2,7 @@ = Export data to S3 :description: This section gives an overview on how exporting procedures can be used with S3. -To export to S3, https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-aws-dependencies-{apoc-release}.jar[apoc-aws-dependencies-{apoc-release}.jar] -needs to be downloaded and copied into the plugins directory _/plugins_. +To export to S3, the https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/{apoc-release}/apoc-aws-dependencies-{apoc-release}.jar[APOC AWS dependency jar] needs to be downloaded and copied into the plugins directory, _/plugins_. After copying the jars into the plugins directory, the database will need to be restarted. diff --git a/docs/asciidoc/modules/ROOT/pages/import/web-apis.adoc b/docs/asciidoc/modules/ROOT/pages/import/web-apis.adoc index ef98121973..d26ba3cbab 100644 --- a/docs/asciidoc/modules/ROOT/pages/import/web-apis.adoc +++ b/docs/asciidoc/modules/ROOT/pages/import/web-apis.adoc @@ -12,15 +12,17 @@ As `apoc.import.file.use_neo4j_config` is enabled, the procedures check whether reading the two configuration parameters `dbms.security.allow_csv_import_from_file_urls` and `dbms.directories.import` respectively. If you want to remove these constraints please set `apoc.import.file.use_neo4j_config=false` -[cols="5m,5"] +[options="header",cols="5m,5"] |=== +| Procedure | Description | CALL apoc.load.json('http://example.com/map.json', [path], [config]) YIELD value as person | load JSON from URL | CALL apoc.load.xml('http://example.com/test.xml', ['xPath'], [config]) YIELD value as doc | load XML from URL | CALL apoc.load.csv('url',{sep:";"}) YIELD lineNo, list, strings, map, stringMap | load CSV fom URL | CALL apoc.load.xls('url','Sheet'/'Sheet!A2:B5',\{config}) YIELD lineNo, list, map | load XLS fom URL |=== -Adding `failOnError:false` (by default `true`) to the config map when using any of the procedures in the above table will make them not fail in case of an error and just return zero rows. Example: +Adding `failOnError:false` (by default `true`) to the config map when using any of the procedures in the above table will make them not fail in case of an error. +The procedure will instead return zero rows. For example: ---- CALL apoc.load.json('http://example.com/test.json', null, {failOnError:false}) @@ -91,11 +93,11 @@ Google Cloud Storage urls have the following shape: `gs:///` -The authorization type can be specified via an additional `authenticationType` query parameter: +The authorization type can be specified by an additional `authenticationType` query parameter: * `NONE`: for public buckets (this is the default behavior if the parameter is not specified) * `GCP_ENVIRONMENT`: for passive authentication as a service account when Neo4j is running in the Google Cloud -* `PRIVATE_KEY`: for using private keys generated for service accounts (requires setting `GOOGLE_APPLICATION_CREDENTIALS` environment variable pointing to a private key json file as described here: https://cloud.google.com/docs/authentication#strategies) +* `PRIVATE_KEY`: for using private keys generated for service accounts (requires setting `GOOGLE_APPLICATION_CREDENTIALS` environment variable pointing to a private key JSON file as described by https://cloud.google.com/docs/authentication#strategies[the official Google documentation].) Example: