cymple.builder.OnCreateAvailable

class cymple.builder.OnCreateAvailable(query)

Bases: SetAfterMerge, OperatorStart

A class decorator declares a OnCreate is available in the current query.

__init__(query)

Initialize the query object.

Methods

__init__(query)	Initialize the query object.
cypher(cypher_query_str)	Concatenate a cypher query string
get()	Get the final query string .
operator_start(operator[, ref_name, args])	Concatenate an operator (e.g. ShortestPath), where its result may be given a name for future reference.
set(properties[, escape_values])	Concatenate a SET clause, using the given properties map.

cypher(cypher_query_str)

Concatenate a cypher query string

get()

Get the final query string .

operator_start(operator: str, ref_name: str | None = None, args: dict | None = None)

Concatenate an operator (e.g. ShortestPath), where its result may be given a name for future reference.

Parameters:

• operator (str) – The neo4j operator to be used (e.g. ShortestPath)

• ref_name (str) – A reference name of the result, to be used later in the rest of the query, defaults to None

• args (dict) – A dict of arguments, to be passed to the operator function, defaults to None

Returns:

A Query object with a query that contains the new clause.

Return type:

OperatorStartAvailable

set(properties: dict, escape_values: bool = True)

Concatenate a SET clause, using the given properties map.

Parameters:

• properties (dict) – A dict to be used to set the variables with their corresponding values

• escape_values (bool) – Determines whether the properties values should be escaped or not, defaults to True

Returns:

A Query object with a query that contains the new clause.

Return type:

SetAfterMergeAvailable