cymple.builder.SetAfterMergeAvailable
- class cymple.builder.SetAfterMergeAvailable(query)
Bases:
QueryStartAvailable
,OnCreate
,OnMatch
,SetAfterMerge
,Unwind
,Return
,Union
A class decorator declares a SetAfterMerge is available in the current query.
- __init__(query)
Initialize the query object.
Methods
__init__
(query)Initialize the query object.
call
()Concatenate the "CALL" clause.
create
()Concatenate the "CREATE" clause.
cypher
(cypher_query_str)Concatenate a cypher query string
get
()Get the final query string .
match
()Concatenate the "MATCH" clause.
Concatenate the "MATCH" clause.
merge
()Concatenate the "MERGE" clause.
Concatenate the "ON CREATE" clause.
on_match
()Concatenate the "ON MATCH" clause.
return_literal
(literal)Concatenate a literal RETURN statement.
return_mapping
(mappings)Concatenate a RETURN statement for multiple objects.
set
(properties[, escape_values])Concatenate a SET clause, using the given properties map.
union
()Combines the results of two or more queries.
Combines the results of two or more queries including duplicates.
unwind
(variables)Concatenate an UNWIND clause, keeping one or more variables given in 'variables' arg.
with_
(variables)Concatenate a WITH clause, keeping one or more variables given in 'variables' arg.
- call()
Concatenate the “CALL” clause.
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- create()
Concatenate the “CREATE” clause.
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- cypher(cypher_query_str)
Concatenate a cypher query string
- get()
Get the final query string .
- match()
Concatenate the “MATCH” clause.
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- match_optional()
Concatenate the “MATCH” clause.
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- merge()
Concatenate the “MERGE” clause.
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- on_create()
Concatenate the “ON CREATE” clause.
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- on_match()
Concatenate the “ON MATCH” clause.
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- return_literal(literal: str)
Concatenate a literal RETURN statement.
- Parameters:
literal (str) – A Cypher string describing the objects to be returned, referencing name/names which were defined earlier in the query
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- return_mapping(mappings: List[Mapping])
Concatenate a RETURN statement for multiple objects.
- Parameters:
mappings (List[Mapping]) – The mapping (or a list of mappings) of db property names to code names, to be returned
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- 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:
- union()
Combines the results of two or more queries. Duplicates are removed.
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- union_all()
Combines the results of two or more queries including duplicates.
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- unwind(variables: str)
Concatenate an UNWIND clause, keeping one or more variables given in ‘variables’ arg.
- Parameters:
variables (str) – A string refering to previously obtained variables, comma seperated
- Returns:
A Query object with a query that contains the new clause.
- Return type:
- with_(variables: str)
Concatenate a WITH clause, keeping one or more variables given in ‘variables’ arg.
- Parameters:
variables (str) – A string refering to previously obtained variables, comma seperated
- Returns:
A Query object with a query that contains the new clause.
- Return type: