Skip to main content

gqlalchemy.query_builders.declarative_base

WhereConditionPartialQuery Objects

class WhereConditionPartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Constructs a where partial query.

NodePartialQuery Objects

class NodePartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Constructs a node partial query.

RelationshipPartialQuery Objects

class RelationshipPartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Constructs a relationship partial query.

UnwindPartialQuery Objects

class UnwindPartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Constructs an unwind partial query.

dict_to_alias_statement

def dict_to_alias_statement(alias_dict: Dict[str, str]) -> str

Creates a string expression of alias statements from a dictionary of expression, variable name dictionary.

_ResultPartialQuery Objects

class _ResultPartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Creates a RETURN/YIELD/WITH statement Cypher partial query.

UnionPartialQuery Objects

class UnionPartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Creates a UNION statement Cypher partial query.

DeletePartialQuery Objects

class DeletePartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Creates a DELETE statement Cypher partial query.

RemovePartialQuery Objects

class RemovePartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Creates a REMOVE statement Cypher partial query.

OrderByPartialQuery Objects

class OrderByPartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Creates a ORDER BY statement Cypher partial query.

LimitPartialQuery Objects

class LimitPartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Creates a LIMIT statement Cypher partial query.

SkipPartialQuery Objects

class SkipPartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Creates a SKIP statement Cypher partial query.

ForeachPartialQuery Objects

class ForeachPartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Creates a FOREACH statement Cypher partial query.

SetPartialQuery Objects

class SetPartialQuery(PartialQuery)

construct_query

def construct_query() -> str

Constructs a set partial query.

DeclarativeBase Objects

class DeclarativeBase(ABC)

match

def match(optional: bool = False) -> "DeclarativeBase"

Obtain data from the database by matching it to a given pattern.

Arguments:

  • optional - A bool indicating if missing parts of the pattern will be filled with null values.

Returns:

A DeclarativeBase instance for constructing queries.

Examples:

Get all nodes with a certain label:

  • Python - match().node(labels='Country', variable='c').return_(results='c').execute()

  • Cypher - MATCH (c:Country) RETURN c;

    Get a relationship of a certain type that connects two nodes with certain label:

  • Python - match().node(labels='Town', variable='t').to(relationship_type='BELONGS_TO', variable='b').node(labels='Country', variable='c').return_(results='b').execute()

  • Cypher - MATCH (t:Town)-[b:BELONGS_TO]->(c:Country) RETURN b;

merge

def merge() -> "DeclarativeBase"

Ensure that a pattern you are looking for exists in the database. This means that if the pattern is not found, it will be created. In a way, this clause is like a combination of MATCH and CREATE.

Returns:

A DeclarativeBase instance for constructing queries.

Example:

Merge node with properties:

  • Python - merge().node(variable='city').where(item='city.name', operator=Operator.EQUAL, literal='London').return_(results='city').execute()
  • Cypher - MERGE (city) WHERE city.name = 'London' RETURN city;

create

def create() -> "DeclarativeBase"

Create nodes and relationships in a graph.

Returns:

A DeclarativeBase instance for constructing queries.

Example:

Create a single node:

  • Python - create().node(labels='Person', variable='p').return_(results='p').execute()
  • Cypher - CREATE (p:Person) RETURN p;

call

def call(procedure: str, arguments: Optional[Union[str, Tuple[Union[str, int, float]]]] = None) -> "DeclarativeBase"

Call a query module procedure.

Arguments:

  • procedure - A string representing the name of the procedure in the format query_module.procedure.
  • arguments - A string representing the arguments of the procedure in text format.

Returns:

A DeclarativeBase instance for constructing queries.

Examples:

Call procedure with no arguments:

  • Python - call('pagerank.get').yield_().return_().execute()

  • Cypher - CALL pagerank.get() YIELD * RETURN *;

    Call procedure with arguments:

  • Python - `call('jsonutil.load_from_url', 'https://some-url.com').yield('objects').return_(results='objects').execute()

  • Cypher - CALL json_util.load_from_url(https://some-url.com) YIELD objects RETURN objects;

node

def node(labels: Union[str, List[str], None] = "", variable: Optional[str] = None, node: Optional["Node"] = None, **kwargs, ,) -> "DeclarativeBase"

Add a node pattern to the query.

Arguments:

  • labels - A string or list of strings representing the labels of the node.
  • variable - A string representing the name of the variable for storing results of the node pattern.
  • node - A Node object to construct the pattern from.
  • **kwargs - Arguments representing the properties of the node.

Returns:

A DeclarativeBase instance for constructing queries.

Example:

Create a node and return it:

  • Python - create().node(labels='Person', variable='n', first_name='Kate').return_(results='n').execute()
  • Cypher - CREATE (n:Person {first_name: 'Kate'}) RETURN n;

to

def to(relationship_type: Optional[str] = "", directed: Optional[bool] = True, variable: Optional[str] = None, relationship: Optional["Relationship"] = None, algorithm: Optional[IntegratedAlgorithm] = None, **kwargs, ,) -> "DeclarativeBase"

Add a relationship pattern to the query.

Arguments:

  • relationship_type - A string representing the type of the relationship.
  • directed - A bool indicating if the relationship is directed.
  • variable - A string representing the name of the variable for storing results of the relationship pattern.
  • relationship - A Relationship object to construct the pattern from.
  • algorithm - algorithm object to use over graph data.
  • **kwargs - Arguments representing the properties of the relationship.

Returns:

A DeclarativeBase instance for constructing queries.

Example:

Match and return a relationship:

  • Python - match().node(labels='Town', variable='t').to(relationship_type='BELONGS_TO', variable='b').node(labels='Country', variable='c').return_(results='b').execute()
  • Cypher - MATCH (t:Town)-[b:BELONGS_TO]->(c:Country) RETURN b;

from_

def from_(relationship_type: Optional[str] = "", directed: Optional[bool] = True, variable: Optional[str] = None, relationship: Optional["Relationship"] = None, algorithm: Optional[IntegratedAlgorithm] = None, **kwargs, ,) -> "Match"

Add a relationship pattern to the query.

Arguments:

  • relationship_type - A string representing the type of the relationship.
  • directed - A bool indicating if the relationship is directed.
  • variable - A string representing the name of the variable for storing results of the relationship pattern.
  • relationship - A Relationship object to construct the pattern from.
  • **kwargs - Arguments representing the properties of the relationship.

Returns:

A DeclarativeBase instance for constructing queries.

Example:

Match and return a relationship:

  • Python - match().node(labels='Country', variable='c').from_(relationship_type='BELONGS_TO', variable='b').node(labels='Town', variable='t').return_(results='b').execute()
  • Cypher - MATCH (c:Country)<-[b:BELONGS_TO]-(t:Town) RETURN b;

where

def where(item: str, operator: Operator, **kwargs) -> "DeclarativeBase"

Creates a WHERE statement Cypher partial query.

Arguments:

  • item - A string representing variable or property.

  • operator - A string representing the operator.

    Kwargs:

  • literal - A value that will be converted to Cypher value, such as int, float, string, etc.

  • expression - A node label or property that won't be converted to Cypher value (no additional quotes will be added).

Raises:

  • GQLAlchemyLiteralAndExpressionMissingInWhere - Raises an error when neither literal nor expression keyword arguments were provided.
  • GQLAlchemyExtraKeywordArgumentsInWhere - Raises an error when both literal and expression keyword arguments were provided.

Returns:

  • self - A partial Cypher query built from the given parameters.

Examples:

Filtering query results by the equality of name properties of two connected nodes.

  • Python - match().node(variable='n').to().node(variable='m').where(item='n.name', operator=Operator.EQUAL, expression='m.name').return_()

  • Cypher - MATCH (n)-[]->(m) WHERE n.name = m.name RETURN *;

    Filtering query results by the node label.

  • Python - match().node(variable='n').where(item='n', operator=Operator.LABEL_FILTER, expression='User').return_()

  • Cypher - MATCH (n) WHERE n:User RETURN *;

    Filtering query results by the comparison of node property and literal.

  • Python - match().node(variable='n').where(item='n.age', operator=Operator.GREATER_THAN, literal=18).return_()

  • Cypher - MATCH (n) WHERE n.age > 18 RETURN *;

where_not

def where_not(item: str, operator: Operator, **kwargs) -> "DeclarativeBase"

Creates a WHERE NOT statement Cypher partial query.

Arguments:

  • item - A string representing variable or property.

  • operator - A string representing the operator.

    Kwargs:

  • literal - A value that will be converted to Cypher value, such as int, float, string, etc.

  • expression - A node label or property that won't be converted to Cypher value (no additional quotes will be added).

Raises:

  • GQLAlchemyLiteralAndExpressionMissingInWhere - Raises an error when neither literal nor expression keyword arguments were provided.
  • GQLAlchemyExtraKeywordArgumentsInWhere - Raises an error when both literal and expression keyword arguments were provided.

Returns:

  • self - A partial Cypher query built from the given parameters.

Examples:

Filtering query results by the equality of name properties of two connected nodes.

  • Python - match().node(variable='n').to().node(variable='m').where_not(item='n.name', operator='=', expression='m.name').return_()
  • Cypher - MATCH (n)-[]->(m) WHERE NOT n.name = m.name RETURN *;

and_where

def and_where(item: str, operator: Operator, **kwargs) -> "DeclarativeBase"

Creates an AND statement as a part of WHERE Cypher partial query.

Arguments:

  • item - A string representing variable or property.

  • operator - A string representing the operator.

    Kwargs:

  • literal - A value that will be converted to Cypher value, such as int, float, string, etc.

  • expression - A node label or property that won't be converted to Cypher value (no additional quotes will be added).

Returns:

  • self - A partial Cypher query built from the given parameters.

Examples:

Filtering query results by node label or the comparison of node property and literal.

  • Python - match().node(variable='n').where(item='n', operator=Operator.LABEL_FILTER, expression='User').and_where(item='n.age', operator=Operator.GREATER_THAN, literal=18).return_()
  • Cypher - MATCH (n) WHERE n:User AND n.age > 18 RETURN *;

and_not_where

def and_not_where(item: str, operator: Operator, **kwargs) -> "DeclarativeBase"

Creates an AND NOT statement as a part of WHERE Cypher partial query.

Arguments:

  • item - A string representing variable or property.

  • operator - A string representing the operator.

    Kwargs:

  • literal - A value that will be converted to Cypher value, such as int, float, string, etc.

  • expression - A node label or property that won't be converted to Cypher value (no additional quotes will be added).

Returns:

  • self - A partial Cypher query built from the given parameters.

Examples:

Filtering query results by node label or the comparison of node property and literal.

  • Python - match().node(variable='n').where(item='n', operator=Operator.LABEL_FILTER, expression='User').and_not_where(item='n.age', operator=Operator.GREATER_THAN, literal=18).return_()
  • Cypher - MATCH (n) WHERE n:User AND NOT n.age > 18 RETURN *;

or_where

def or_where(item: str, operator: Operator, **kwargs) -> "DeclarativeBase"

Creates an OR statement as a part of WHERE Cypher partial query.

Arguments:

  • item - A string representing variable or property.

  • operator - A string representing the operator.

    Kwargs:

  • literal - A value that will be converted to Cypher value, such as int, float, string, etc.

  • expression - A node label or property that won't be converted to Cypher value (no additional quotes will be added).

Returns:

  • self - A partial Cypher query built from the given parameters.

Examples:

Filtering query results by node label or the comparison of node property and literal.

  • Python - match().node(variable='n').where(item='n', operator=Operator.LABEL_FILTER, expression='User').or_where(item='n.age', operator=Operator.GREATER_THAN, literal=18).return_()
  • Cypher - MATCH (n) WHERE n:User OR n.age > 18 RETURN *;

or_not_where

def or_not_where(item: str, operator: Operator, **kwargs) -> "DeclarativeBase"

Creates an OR NOT statement as a part of WHERE Cypher partial query.

Arguments:

  • item - A string representing variable or property.

  • operator - A string representing the operator.

    Kwargs:

  • literal - A value that will be converted to Cypher value, such as int, float, string, etc.

  • expression - A node label or property that won't be converted to Cypher value (no additional quotes will be added).

Returns:

  • self - A partial Cypher query built from the given parameters.

Examples:

Filtering query results by node label or the comparison of node property and literal.

  • Python - match().node(variable='n').where(item='n', operator=Operator.LABEL_FILTER, expression='User').or_not_where(item='n.age', operator=Operator.GREATER_THAN, literal=18).return_()
  • Cypher - MATCH (n) WHERE n:User OR NOT n.age > 18 RETURN *;

xor_where

def xor_where(item: str, operator: Operator, **kwargs) -> "DeclarativeBase"

Creates an XOR statement as a part of WHERE Cypher partial query.

Arguments:

  • item - A string representing variable or property.

  • operator - A string representing the operator.

    Kwargs:

  • literal - A value that will be converted to Cypher value, such as int, float, string, etc.

  • expression - A node label or property that won't be converted to Cypher value (no additional quotes will be added).

Returns:

  • self - A partial Cypher query built from the given parameters.

Examples:

Filtering query results by node label or the comparison of node property and literal.

  • Python - match().node(variable='n').where(item='n', operator=Operator.LABEL_FILTER, expression='User').xor_where(item='n.age', operator=Operator.GREATER_THAN, literal=18).return_()
  • Cypher - MATCH (n) WHERE n:User XOR n.age > 18 RETURN *;

xor_not_where

def xor_not_where(item: str, operator: Operator, **kwargs) -> "DeclarativeBase"

Creates an XOR NOT statement as a part of WHERE Cypher partial query.

Arguments:

  • item - A string representing variable or property.

  • operator - A string representing the operator.

    Kwargs:

  • literal - A value that will be converted to Cypher value, such as int, float, string, etc.

  • expression - A node label or property that won't be converted to Cypher value (no additional quotes will be added).

Returns:

  • self - A partial Cypher query built from the given parameters.

Examples:

Filtering query results by node label or the comparison of node property and literal.

  • Python - match().node(variable='n').where(item='n', operator=Operator.LABEL_FILTER, expression='User').xor_not_where(item='n.age', operator=Operator.GREATER_THAN, literal=18).return_()
  • Cypher - MATCH (n) WHERE n:User XOR NOT n.age > 18 RETURN *;

unwind

def unwind(list_expression: str, variable: str) -> "DeclarativeBase"

Unwind a list of values as individual rows.

Arguments:

  • list_expression - A list of strings representing the list of values.
  • variable - A string representing the variable name for unwinding results.

Returns:

A DeclarativeBase instance for constructing queries.

Example:

  • Python - unwind(list_expression="[1, 2, 3, null]", variable="x").return_(results=["x", ("'val'", "y")]).execute()
  • Cypher - UNWIND [1, 2, 3, null] AS x RETURN x, 'val' AS y;

with_

def with_(results: Optional[Union[str, Tuple[str, str], Iterable[Union[str, Tuple[str, str]]]]] = None) -> "DeclarativeBase"

Chain together parts of a query, piping the results from one to be used as starting points or criteria in the next.

Arguments:

  • results - A dictionary mapping variables in the first query with aliases in the second query.

Raises:

  • GQLAlchemyResultQueryTypeError - Raises an error when the provided argument is of wrong type.
  • GQLAlchemyTooLargeTupleInResultQuery - Raises an error when the given tuple has length larger than 2.

Returns:

A DeclarativeBase instance for constructing queries.

Example:

Pipe the result from first part of the query for the futher use:

  • Python - match().node(variable='n').with('n').execute()
  • Cypher - `MATCH (n) WITH n;

union

def union(include_duplicates: Optional[bool] = True) -> "DeclarativeBase"

Combine the result of multiple queries.

Arguments:

  • include_duplicates - A bool indicating if duplicates should be included.

Returns:

A DeclarativeBase instance for constructing queries.

Examples:

Combine querties and retain duplicates:

  • Python - match().node(variable="c", labels="Country").return_(results=("c.name", "columnName")).union().match().node(variable="p", labels="Person").return_(results=("p.name", "columnName")).execute()

  • Cypher - MATCH (c:Country) RETURN c.name AS columnName UNION ALL MATCH (p:Person) RETURN p.name AS columnName;

    Combine queries and remove duplicates:

  • Python - match().node(variable="c", labels="Country").return_(results=("c.name", "columnName")).union(include_duplicates=False).match().node(variable="p", labels="Person").return_(results=("p.name", "columnName")).execute()

  • Cypher - MATCH (c:Country) RETURN c.name AS columnName UNION MATCH (p:Person) RETURN p.name AS columnName;

delete

def delete(variable_expressions: Union[str, List[str]], detach: Optional[bool] = False) -> "DeclarativeBase"

Delete nodes and relationships from the database.

Arguments:

  • variable_expressions - A string or list of strings indicating which node(s) and/or relationship(s) should be removed.
  • detach - A bool indicating if relationships should be deleted along with a node.

Returns:

A DeclarativeBase instance for constructing queries.

Example:

Delete a node:

  • Python - match().node(labels='Node1', variable='n1').delete(variable_expressions='n1').execute()
  • Cypher - MATCH (n1:Node1) DELETE n1;

remove

def remove(items: Union[str, List[str]]) -> "DeclarativeBase"

Remove labels and properties from nodes and relationships.

Arguments:

  • items - A string or list of strings indicating which label(s) and/or properties should be removed.

Returns:

A DeclarativeBase instance for constructing queries.

Example:

Remove a property from a node:

  • Python - match().node(labels='Country', variable='n', name='United Kingdom').remove(items='n.name').return_(results='n').execute()
  • Cypher - MATCH (n:Country {name: 'United Kingdom'}) REMOVE n.name RETURN n;

yield_

def yield_(results: Optional[Union[str, Tuple[str, str], Iterable[Union[str, Tuple[str, str]]]]] = None) -> "DeclarativeBase"

Yield data from the query.

Arguments:

  • results - A dictionary mapping items that are returned with alias names.

Raises:

  • GQLAlchemyResultQueryTypeError - Raises an error when the provided argument is of wrong type.
  • GQLAlchemyTooLargeTupleInResultQuery - Raises an error when the given tuple has length larger than 2.

Returns:

A DeclarativeBase instance for constructing queries.

Examples:

Yield all data from a query:

  • Python - call(procedure='pagerank.get').yield_().return_().execute()

  • Cypher - CALL pagerank.get() YIELD * RETURN *;

    Yield some data from a query:

  • Python - .call(procedure='pagerank.get').yield_(results=['node', 'rank']).return_(results=['node','rank']).execute()

  • Cypher - CALL pagerank.get() YIELD node, rank RETURN node, rank;

return_

def return_(results: Optional[Union[str, Tuple[str, str], Iterable[Union[str, Tuple[str, str]]]]] = None) -> "DeclarativeBase"

Return data from the query.

Arguments:

  • results - An optional string, tuple or iterable of strings and tuples for alias names.

Raises:

  • GQLAlchemyResultQueryTypeError - Raises an error when the provided argument is of wrong type.
  • GQLAlchemyTooLargeTupleInResultQuery - Raises an error when the given tuple has length larger than 2.

Returns:

A DeclarativeBase instance for constructing queries.

Examples:

Return all variables from a query:

  • Python - match().node(labels='Person', variable='p').return_().execute()

  • Cypher - MATCH (p:Person) RETURN *;

    Return specific variables from a query:

  • Python - match().node(labels='Person', variable='p1').to().node(labels='Person', variable='p2').return_(results=[('p1','first'), 'p2']).execute()

  • Cypher - MATCH (p1:Person)-[]->(p2:Person) RETURN p1 AS first, p2;

order_by

def order_by(properties: Union[str, Tuple[str, Order], List[Union[str, Tuple[str, Order]]]]) -> "DeclarativeBase"

Creates an ORDER BY statement Cypher partial query.

Arguments:

  • properties - Properties and order (DESC/DESCENDING/ASC/ASCENDING) by which the query results will be ordered.

Raises:

  • GQLAlchemyOrderByTypeError - Raises an error when the given ordering is of the wrong type.
  • GQLAlchemyMissingOrder - Raises an error when the given property is neither string nor tuple.

Returns:

A DeclarativeBase instance for constructing queries.

Examples:

Ordering query results by the property n.name in ascending order and by the property n.last_name in descending order:

  • Python - match().node(variable='n').return_().order_by(properties=['n.name', ('n.last_name', Order.DESC)]).execute()
  • Cypher - MATCH (n) RETURN * ORDER BY n.name, n.last_name DESC;

limit

def limit(integer_expression: Union[str, int]) -> "DeclarativeBase"

Limit the number of records when returning results.

Arguments:

  • integer_expression - An integer indicating how many records to limit the results to.

Returns:

A DeclarativeBase instance for constructing queries.

Example:

Limit the number of returned results:

  • Python - match().node(labels='Person', variable='p').return_().limit(integer_expression='10').execute()
  • Cypher - MATCH (p:Person) RETURN * LIMIT 10;

skip

def skip(integer_expression: Union[str, int]) -> "DeclarativeBase"

Skip a number of records when returning results.

Arguments:

  • integer_expression - An integer indicating how many records to skip in the results.

Returns:

A DeclarativeBase instance for constructing queries.

Example:

Skip the first result:

  • Python - match().node(variable='n').return_(results='n').skip(integer_expression='1').execute()
  • Cypher - MATCH (n) RETURN n SKIP 1;

add_custom_cypher

def add_custom_cypher(custom_cypher: str) -> "DeclarativeBase"

Inject custom Cypher code into the query.

Arguments:

  • custom_cypher - A string representing the Cypher code to be injected into the query.

Returns:

A DeclarativeBase instance for constructing queries.

get_single

def get_single(retrieve: str) -> Any

Returns a single result with a retrieve variable name.

Arguments:

  • retrieve - A string representing the results variable to be returned.

Returns:

An iterator of dictionaries containing the results of the query.

foreach

def foreach(variable: str, expression: str, update_clause: Union[str, List[str], Set[str]]) -> "DeclarativeBase"

Iterate over a list of elements and for every iteration run every update clause.

Arguments:

  • variable - The variable name that stores each element.
  • expression - Any expression that results in a list.
  • update_clauses - One or more Cypher update clauses: SET, REMOVE, CREATE, MERGE, DELETE, FOREACH.

Returns:

A DeclarativeBase instance for constructing queries.

Example:

For each number in a list, create a node:

  • Python - update_clause = QueryBuilder().create().node(variable="n", id=PropertyVariable("i"))query_builder = QueryBuilder().foreach("i", "[1, 2, 3]", update_clause.construct_query())
  • Cypher - FOREACH ( i IN [1, 2, 3] | CREATE (n {id: i}) )

set_

def set_(item: str, operator: Operator, **kwargs)

Creates a SET statement Cypher partial query.

Arguments:

  • item - A string representing variable or property.

  • operator - An assignment, increment or label filter operator.

    Kwargs:

  • literal - A value that will be converted to Cypher value, such as int, float, string, etc.

  • expression - A node label or property that won't be converted to Cypher value (no additional quotes will be added).

Raises:

  • GQLAlchemyLiteralAndExpressionMissingInWhere - Raises an error when neither literal nor expression keyword arguments were provided.
  • GQLAlchemyExtraKeywordArgumentsInWhere - Raises an error when both literal and expression keyword arguments were provided.

Returns:

  • self - A partial Cypher query built from the given parameters.

Examples:

Set or update a property.

  • Python - match().node(variable='n').where(item='n.name', operator=Operator.EQUAL, literal='Germany').set_(item='n.population', operator=Operator.ASSIGNMENT, literal=83000001).return_().execute()

  • Cypher - MATCH (n) WHERE n.name = 'Germany' SET n.population = 83000001 RETURN *;

    Set or update multiple properties.

  • Python - match().node(variable='n').where(item='n.name', operator=Operator.EQUAL, literal='Germany').set_(item='n.population', operator=Operator.ASSIGNMENT, literal=83000001).set_(item='n.capital', operator=Operator.ASSIGNMENT, literal='Berlin').return_().execute()

  • Cypher - MATCH (n) WHERE n.name = 'Germany' SET n.population = 83000001 SET n.capital = 'Berlin' RETURN *;

    Set node label.

  • Python - match().node(variable='n').where(item='n.name', operator=Operator.EQUAL, literal='Germany').set_(item='n', operator=Operator.LABEL_FILTER, expression='Land').return_().execute()

  • Cypher - MATCH (n) WHERE n.name = 'Germany' SET n:Land RETURN *;

    Replace all properties using map.

  • Python - match().node(variable='c', labels='Country').where(item='c.name', operator=Operator.EQUAL, literal='Germany').set_(item='c', operator=Operator.ASSIGNMENT, literal={'name': 'Germany', 'population': '85000000'}).return_().execute()

  • Cypher - MATCH (c:Country) WHERE c.name = 'Germany' SET c = {name: 'Germany', population: '85000000'} RETURN *;

    Update all properties using map.

  • Python - match().node(variable='c', labels='Country').where(item='c.name', operator=Operator.EQUAL, literal='Germany').set_(item='c', operator=Operator.INCREMENT, literal={'name': 'Germany', 'population': '85000000'}).return_().execute()

  • Cypher - MATCH (c:Country) WHERE c.name = 'Germany' SET c += {name: 'Germany', population: '85000000'} RETURN *;

execute

def execute() -> Iterator[Dict[str, Any]]

Executes the Cypher query and returns the results.

Returns:

An iterator of dictionaries containing the results of the query.