Airflow Summit 2026 is coming August 31 - September 2 in Austin, TX. Register now to secure your spot!

airflow.providers.neo4j.operators.neo4j

Classes

Neo4jOperator

Executes a Cypher query in a specific Neo4j database.

Module Contents

class airflow.providers.neo4j.operators.neo4j.Neo4jOperator(*, cypher=None, sql=None, neo4j_conn_id='neo4j_default', parameters=None, **kwargs)[source]

Bases: airflow.providers.common.compat.sdk.BaseOperator

Executes a Cypher query in a specific Neo4j database.

See also

For more information on how to use this operator, take a look at the guide: Neo4jOperator

Parameters:
  • cypher (str | None) – the Cypher query to be executed. Can receive a str representing a Cypher statement.

  • sql (str | None) – (Deprecated) the Cypher query to be executed. Use cypher instead.

  • neo4j_conn_id (str) – Reference to Neo4j connection id.

  • parameters (dict[str, Any] | None) – the parameters to send to Neo4j driver session

template_fields: collections.abc.Sequence[str] = ('cypher', 'parameters')[source]
template_fields_renderers[source]
neo4j_conn_id = 'neo4j_default'[source]
cypher = None[source]
parameters = None[source]
execute(context)[source]

Derive when creating an operator.

The main method to execute the task. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?