airflow.providers.neo4j.hooks.neo4j
This module allows to connect to a Neo4j database.
Module Contents
-
airflow.providers.neo4j.hooks.neo4j.DEFAULT_NEO4J_PORT = 7687[source]
-
class airflow.providers.neo4j.hooks.neo4j.Neo4jHook(conn_id=default_conn_name, *args, **kwargs)[source]
Bases: airflow.sdk.bases.hook.BaseHook
Interact with Neo4j.
Performs a connection to Neo4j and runs the query.
- Parameters:
neo4j_conn_id – Reference to Neo4j connection id.
-
conn_name_attr = 'neo4j_conn_id'[source]
-
default_conn_name = 'neo4j_default'[source]
-
conn_type = 'neo4j'[source]
-
hook_name = 'Neo4j'[source]
-
neo4j_conn_id = 'neo4j_default'[source]
-
connection[source]
-
client: neo4j.Driver | None = None[source]
-
get_conn()[source]
Initiate a new Neo4j connection with username, password and database schema.
-
get_uri(conn)[source]
Build the URI based on connection extras.
- Parameters:
conn (airflow.models.Connection) – Connection object.
- Returns:
Constructed URI string.
- Return type:
str
-
run(query, parameters=None)[source]
Execute a Neo4j query within a session.
- Parameters:
query (str) – Neo4j query string.
parameters (dict[str, Any] | None) – Optional parameters for the query.
- Returns:
List of result records.
- Return type:
list[Any]