airflow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [airflow] tfindlay-tw commented on a change in pull request #6604: [AIRFLOW-5920] *DRAFT* Neo4j operator and hook
Date Mon, 25 Nov 2019 02:10:54 GMT
tfindlay-tw commented on a change in pull request #6604: [AIRFLOW-5920] *DRAFT* Neo4j operator
and hook
URL: https://github.com/apache/airflow/pull/6604#discussion_r349969435
 
 

 ##########
 File path: docs/howto/operator/neo4j.rst
 ##########
 @@ -0,0 +1,72 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+
+Neo4j Operator
+==================
+
+This operator enables Airflow DAGs to execute cypher queries against a Neo4j (or ONgDB) graph
database.
+
+The results of the query execution will be written to a CSV file on disk. Please consider
available space
+on the Airflow worker if your query can return a large result.
+
+This operator can be used in conjunction with the S3 operator or email operator to process
the results.
+
+See the :ref:`Operators Concepts <concepts-operators>` documentation and the :doc:`Operators
API Reference <../../_api/index>` for more information.
+
+Prerequisite Tasks
+^^^^^^^^^^^^^^^^^^
+To use this operator you must define a connection to your Neo4J/ONgDB database via:
+
+  *Admin* -> *Connections* -> *Create*
+
+The connection must set the following properties:
+
+- login
+- password
+- host
+- port
+
+The connection name is then used in the DAG to reference this definition.
+
+Basic Usage
+^^^^^^^^^^^
+Use the :class:`~airflow/contrib/operators/neo4j_operator.Neo4JOperator` to execute cyhpher
query:
+
+.. exampleinclude:: ../../../airflow/contrib/example_dags/example_neo4j_operator.py
+    :language: python
+    :dedent: 4
+    :start-after: [START howto_operator_dingding]
+    :end-before: [END howto_operator_dingding]
 
 Review comment:
   Opps, this should be fixed now.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message