You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hop.apache.org by gi...@apache.org on 2021/04/04 13:15:25 UTC
[incubator-hop-docs] branch asf-site updated: Documentation updated
to 65e6357
This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-hop-docs.git
The following commit(s) were added to refs/heads/asf-site by this push:
new ad4be45 Documentation updated to 65e6357
ad4be45 is described below
commit ad4be45aad0db926e532c35f13e6f461c81b0096
Author: jenkins <bu...@apache.org>
AuthorDate: Sun Apr 4 13:15:22 2021 +0000
Documentation updated to 65e6357
---
.../cassandra/cassandra-connection.adoc | 18 +---------------
.../metadata-types/neo4j/neo4j-connection.adoc | 6 +-----
.../metadata-types/neo4j/neo4j-graphmodel.adoc | 25 ++--------------------
.../ROOT/pages/vfs/azure-blob-storage-vfs.adoc | 12 ++++++++++-
.../ROOT/pages/vfs/google-cloud-storage-vfs.adoc | 6 +++++-
.../modules/ROOT/pages/vfs/google-drive-vfs.adoc | 9 +++++++-
.../workflow/actions/deleteresultfilenames.adoc | 6 +++---
7 files changed, 31 insertions(+), 51 deletions(-)
diff --git a/hop-user-manual/modules/ROOT/pages/metadata-types/cassandra/cassandra-connection.adoc b/hop-user-manual/modules/ROOT/pages/metadata-types/cassandra/cassandra-connection.adoc
index 7eea352..edcf895 100644
--- a/hop-user-manual/modules/ROOT/pages/metadata-types/cassandra/cassandra-connection.adoc
+++ b/hop-user-manual/modules/ROOT/pages/metadata-types/cassandra/cassandra-connection.adoc
@@ -16,29 +16,19 @@ under the License.
////
:documentationPath: /metadata-types/cassandra/
:language: en_US
-:imagesdir: ../../assets/images/
-:page-pagination:
= Cassandra Connection
== Description
-image:icons/Cassandra_logo.svg[height="24px"]
-
Connections can be created and edited using the logo (click on it to edit), and the drop down menu (arrow down) which you can find on the right of every connection line on the various Cassandra action or transform dialogs.
They can also be managed with the metadata perspective in the Hop GUI. Finally, please note that Cassandra Connections are serialized as JSON in the Hop metadata folder under
`metadata/cassandra-connection/`
-== Related Plugins
-
-* xref:pipeline/transforms/cassandra-input.adoc[Cassandra Input]
-* xref:pipeline/transforms/cassandra-output.adoc[Cassandra Output]
-
-== Options
+== The Options
-[options="header"]
|===
|Option |Description
@@ -72,9 +62,3 @@ WITH replication = {'class':'SimpleStrategy', 'replication_factor' : 3} ;`
|Select if you want the text of each BATCH INSERT statement compressed (with GZIP) before transmitting it to the node.
|===
-
-== Samples (Integration Tests)
-
-* integration-tests/cassandra/tests/cassandra-input-output/cassandra-input-validation.hpl
-* integration-tests/cassandra/tests/cassandra-input-output/cassandra-output-to-table.hpl
-
diff --git a/hop-user-manual/modules/ROOT/pages/metadata-types/neo4j/neo4j-connection.adoc b/hop-user-manual/modules/ROOT/pages/metadata-types/neo4j/neo4j-connection.adoc
index 37d2567..ed2beaa 100644
--- a/hop-user-manual/modules/ROOT/pages/metadata-types/neo4j/neo4j-connection.adoc
+++ b/hop-user-manual/modules/ROOT/pages/metadata-types/neo4j/neo4j-connection.adoc
@@ -16,14 +16,11 @@ under the License.
////
:documentationPath: /metadata-types/neo4j/
:language: en_US
-:page-pagination:
= Neo4j Connection
== Description
-image:icons/NEO4J.svg[width="24px"]
-
Connections can be created and edited using the logo (click on it to edit), and the drop down menu (arrow down) which you can find on the right of every connection line on the various Neo4j dialogs.
They can also be managed with the metadata perspective in the Hop GUI. Finally, please note that Neo4j Connections are serialized as JSON in the Hop metadata folder under
@@ -34,9 +31,8 @@ They can also be managed with the metadata perspective in the Hop GUI. Finally,
**DON'T PANIC**: most of the options in the interface you don't need (...and most likely will never will need).
-== Options
+== The Options
-[options="header"]
|===
|Option |Description
diff --git a/hop-user-manual/modules/ROOT/pages/metadata-types/neo4j/neo4j-graphmodel.adoc b/hop-user-manual/modules/ROOT/pages/metadata-types/neo4j/neo4j-graphmodel.adoc
index 9b9d9df..3ceeb4d 100644
--- a/hop-user-manual/modules/ROOT/pages/metadata-types/neo4j/neo4j-graphmodel.adoc
+++ b/hop-user-manual/modules/ROOT/pages/metadata-types/neo4j/neo4j-graphmodel.adoc
@@ -14,34 +14,13 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
-:documentationPath: /metadata-types/
+:documentationPath: /metadata-types/neo4j/
:language: en_US
-:page-pagination:
= Neo4j Graph Model
== Description
-image:icons/NEO4J.svg[width="24px"]
-
A graph model describes (part of) a graph by allowing you to define nodes with their properties, and the relationships that connect these nodes.
+You can then use such a Graph Model to map input fields to properties in the link:../../pipelines/transforms/neo4j-graphoutput.html[Neo4j Graph Output] transform.
-== Related Plugins
-
-* xref:pipeline/transforms/neo4j-graphoutput.adoc[Neo4j Graph Output]
-
-== Options
-
-[options="header"]
-|===
-|Option |Description
-|Model name|the name to be used for this model
-|Description|the description to be used for this model
-|Import graph from JSON|import this graph from a JSON file
-|Export graph to JSON|export this graph to a JSON file
-|Import Cypher Workbench model|Import a model from the Neo4j Cypher Workbench tool (not (yet) publicly available)
-|===
-
-== Samples (Integration Tests)
-
-* ./integration-tests/neo4j/tests/neo4j-graph-output/neo4j-cypher-build-graph.hpl
\ No newline at end of file
diff --git a/hop-user-manual/modules/ROOT/pages/vfs/azure-blob-storage-vfs.adoc b/hop-user-manual/modules/ROOT/pages/vfs/azure-blob-storage-vfs.adoc
index d9296f8..c3cb865 100644
--- a/hop-user-manual/modules/ROOT/pages/vfs/azure-blob-storage-vfs.adoc
+++ b/hop-user-manual/modules/ROOT/pages/vfs/azure-blob-storage-vfs.adoc
@@ -39,7 +39,17 @@ You can find both in the Storage Accounts section of your Azure portal.
All 3 options can be set in either the Hop GUI options dialog (Menu: Tools / Options) or using the following Hop Conf (`hop-conf.sh` or `hop-conf.bat`) command line options:
-include::../hop-tools/hop-conf/hop-conf-cloud-azure-blob-storage.adoc[]
+[source,shell script]
+----
+ -aza, --azure-account=<account>
+ The account to use for the Azure VFS
+ -azi, --azure-block-increment=<blockIncrement>
+ The block increment size for new files on Azure,
+ multiples of 512 only.
+ -azk, --azure-key=<key>
+ The key to use for the Azure VFS
+
+----
Once done you will see an `azure` entry in the central `hop-config.json` file:
diff --git a/hop-user-manual/modules/ROOT/pages/vfs/google-cloud-storage-vfs.adoc b/hop-user-manual/modules/ROOT/pages/vfs/google-cloud-storage-vfs.adoc
index 79f5f0b..13d79f2 100644
--- a/hop-user-manual/modules/ROOT/pages/vfs/google-cloud-storage-vfs.adoc
+++ b/hop-user-manual/modules/ROOT/pages/vfs/google-cloud-storage-vfs.adoc
@@ -30,7 +30,11 @@ The scheme you can use to access your files in Google Cloud Storage is
You need to generate a key file for a service account to make it work. Go to the Google Cloud console to do this. Once you have a key file for your service account, with permissions to access your GCP storage, point to it with either a system environment variable called `GOOGLE_APPLICATION_CREDENTIALS` (standard Google way of doing this) or in the Options dialog in the 'Google Cloud' tab. You can also use `hop-conf`:
-include::../hop-tools/hop-conf/hop-conf-cloud-google-cloud-storage.adoc[]
+[source,shell script]
+----
+ -gck, --google-cloud-service-account-key-file=<serviceAccountKeyFile>
+ Configure the path to a Google Cloud service account JSON key file
+----
Once done you will see a `googleCloud` entry in the central `hop-config.json` file:
diff --git a/hop-user-manual/modules/ROOT/pages/vfs/google-drive-vfs.adoc b/hop-user-manual/modules/ROOT/pages/vfs/google-drive-vfs.adoc
index 926ce07..be70d3d 100644
--- a/hop-user-manual/modules/ROOT/pages/vfs/google-drive-vfs.adoc
+++ b/hop-user-manual/modules/ROOT/pages/vfs/google-drive-vfs.adoc
@@ -30,7 +30,14 @@ The scheme you can use to access your files in Google Drive is
You need to generate a credentials file to make it work. Follow the Google documentation to see how that is done. You also need to specify a folder in which security tokens are going to be saved. You can specify both in the Hop system configuration options. This can be done in the Hop GUI: go to the "Google Drive" tab in the Options dialog (from the Tools menu). You can also use the `hop-conf` script with the following options:
-include::../hop-tools/hop-conf/hop-conf-cloud-google-drive.adoc[]
+[source,shell script]
+----
+ -gdc, --google-drive-credentials-file=<credentialsFile>
+ Configure the path to a Google Drive credentials JSON
+ file
+ -gdt, --google-drive-tokens-folder=<tokensFolder>
+ Configure the path to a Google Drive tokens folder
+----
Once done you will see a `googleDrive` entry in the central `hop-config.json` file:
diff --git a/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc b/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
index 748ab56..1998da3 100644
--- a/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
+++ b/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
@@ -28,8 +28,8 @@ Use this action to delete all the filenames that are in the result files list of
[width="90%", options="header"]
|===
|Option|Description
-|Workflow action name|The name of the workflow action. *Note*: This name has to be unique in a single workflow. A workflow action can be placed several times on the canvas, however it will be the same workflow action.
-|Limit action to| Enable this feature if you want to limit the deletion to certain filenames in the result file list.
+|Workflow action name|The name of the workflow action.
+|Limit action to|Enable this feature if you want to limit the deletion to certain filenames in the result file list.
|Wildcard|The regular expression to limit the files to delete
-|Exclude wildcard|The regular expression to exclude certain files from being deleted.
+|Exclude wildcard|The regular expression to exclude certain files from being deleted.
|===
\ No newline at end of file